Package org.dcm4che.typeddicom.dataelements

Class ReferencedSamplePositions

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedSamplePositions

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, UnsignedLongMultiWrapper

public class ReferencedSamplePositions
extends AbstractDataElementWrapper
implements UnsignedLongMultiWrapper

Name: Referenced Sample Positions
Keyword: ReferencedSamplePositions
Tag: (0040,A132)
Value Representation: UL
Value Multiplicity: 1-n

• Described in the contexts:
  • Temporal Coordinates Macro > Referenced Sample Positions
  as follows:
  Attribute Name: Referenced Sample Positions
  Type: 1C
  Attribute Description:

  List of samples within a multiplex group specifying temporal points of the referenced data. Position of first sample is 1.

  Required if the Referenced SOP Instance is a Waveform and Referenced Time Offsets (0040,A138) and Referenced DateTime (0040,A13A) are not present.

  Shall only be used when Referenced Channels (0040,A0B0) refers to channels within a single multiplex group.

  
  
• Described in the contexts:
  • Waveform Annotation Module > Waveform Annotation Sequence > Referenced Sample Positions
  as follows:
  Attribute Name: Referenced Sample Positions
  Type: 1C
  Attribute Description:

  List of samples within a multiplex group specifying temporal points for annotation. Position of first sample is 1. Required if Temporal Range Type (0040,A130) is present, and if Referenced Time Offsets (0040,A138) and Referenced DateTime (0040,A13A) are not present. See DICOM Standard Part 3 - Section C.10.10.1.3

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReferencedSamplePositions.Builder<SELF extends ReferencedSamplePositions.Builder<SELF,T>,T extends ReferencedSamplePositions.Holder>
static interface	ReferencedSamplePositions.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Sample Positions" (see ReferencedSamplePositions)
static class	ReferencedSamplePositions.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedLongMultiWrapper

UnsignedLongMultiWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends UnsignedLongMultiWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedLongMultiWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedSamplePositions()	Creates a new Referenced Sample Positions object which wraps a new and empty Attributes object.
ReferencedSamplePositions(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Sample Positions object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedSamplePositions	copy()	Returns a new Referenced Sample Positions which wraps a copy of the Attributes wrapped in this Referenced Sample Positions.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntDataElementMultiWrapper

getInt, getInts, setInts

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnsignedLongMultiWrapper

getValueRepresentation

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ReferencedSamplePositions

public ReferencedSamplePositions(org.dcm4che3.data.Attributes attributes)

Creates a new Referenced Sample Positions object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedSamplePositions

public ReferencedSamplePositions()

Creates a new Referenced Sample Positions object which wraps a new and empty Attributes object.

Method Details

copy

public ReferencedSamplePositions copy()

Returns a new Referenced Sample Positions which wraps a copy of the Attributes wrapped in this Referenced Sample Positions. (see Attributes(Attributes)

Returns:

a new Referenced Sample Positions which wraps a copy of the Attributes wrapped in this Referenced Sample Positions.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.