Package org.dcm4che.typeddicom.dataelements

Class ImageIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ImageIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class ImageIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Image Index
Keyword: ImageIndex
Tag: (0054,1330)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • PET Image Module > Image Index
  as follows:
  Attribute Name: Image Index
  Type: 1
  Attribute Description:

  An index identifying the position of this image within a PET Series. See DICOM Standard Part 3 - Section C.8.9.4.1.9 for explanation.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

ImageIndex

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

Creates a new Image Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ImageIndex

public ImageIndex()

Creates a new Image Index object which wraps a new and empty Attributes object.

Method Details

copy

public ImageIndex copy()

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

Returns:

a new Image Index which wraps a copy of the Attributes wrapped in this Image 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.