Package org.dcm4che.typeddicom.dataelements

Class TemporalPositionIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TemporalPositionIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedLongWrapper

public class TemporalPositionIndex
extends AbstractDataElementWrapper
implements UnsignedLongWrapper

Name: Temporal Position Index
Keyword: TemporalPositionIndex
Tag: (0020,9128)
Value Representation: UL
Value Multiplicity: 1

• Described in the contexts:
  • Frame Content Macro > Frame Content Sequence > Temporal Position Index
  as follows:
  Attribute Name: Temporal Position Index
  Type: 1C
  Attribute Description:

  Ordinal number (starting from 1) of the frame in the set of frames with different temporal positions.

  Required if the value of SOP Class UID (0008,0016) equals "1.2.840.10008.5.1.4.1.1.130" or Functional MR Sequence (0018,9621) is present. May be present otherwise. See DICOM Standard Part 3 - Section C.7.6.16.2.2.6 and DICOM Standard Part 3 - Section C.7.6.16.2.2.8.

  
  

Nested Class Summary

Nested Classes

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

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

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

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.UnsignedLongWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
TemporalPositionIndex()	Creates a new Temporal Position Index object which wraps a new and empty Attributes object.
TemporalPositionIndex(org.dcm4che3.data.Attributes attributes)	Creates a new Temporal Position Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TemporalPositionIndex	copy()	Returns a new Temporal Position Index which wraps a copy of the Attributes wrapped in this Temporal Position Index.
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.IntDataElementWrapper

getInt, setInt

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

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

TemporalPositionIndex

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

Creates a new Temporal Position Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TemporalPositionIndex

public TemporalPositionIndex()

Creates a new Temporal Position Index object which wraps a new and empty Attributes object.

Method Details

copy

public TemporalPositionIndex copy()

Returns a new Temporal Position Index which wraps a copy of the Attributes wrapped in this Temporal Position Index. (see Attributes(Attributes)

Returns:

a new Temporal Position Index which wraps a copy of the Attributes wrapped in this Temporal Position Index.

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.