Package org.dcm4che.typeddicom.dataelements

Class DimensionIndexValues

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DimensionIndexValues

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, UnsignedLongMultiWrapper

public class DimensionIndexValues
extends AbstractDataElementWrapper
implements UnsignedLongMultiWrapper

Name: Dimension Index Values
Keyword: DimensionIndexValues
Tag: (0020,9157)
Value Representation: UL
Value Multiplicity: 1-n

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

  Contains the values of the indices defined in the Dimension Index Sequence (0020,9222) for this multi-frame header frame. The number of values is equal to the number of Items of the Dimension Index Sequence and shall be applied in the same order.

  See DICOM Standard Part 3 - Section C.7.6.17.1 for a description.

  Note

  In DICOM Standard Part 3 - Section C.7.6.17.1, the index values are defined to start from 1 and monotonically increase by 1, within the scope of the Dimension Organization UID (0020,9164).

  Required if the value of Dimension Index Sequence (0020,9222) exists.

  Note

  For some IODs, such as the VL Whole Slide Microscopy Image IOD, the entire Frame Content Sequence (0020,9111) may be omitted, but if it is present and Dimensions are explicitly defined, then the index values need to be supplied here.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DimensionIndexValues.Builder<SELF extends DimensionIndexValues.Builder<SELF,T>,T extends DimensionIndexValues.Holder>
static interface	DimensionIndexValues.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Dimension Index Values" (see DimensionIndexValues)
static class	DimensionIndexValues.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
DimensionIndexValues()	Creates a new Dimension Index Values object which wraps a new and empty Attributes object.
DimensionIndexValues(org.dcm4che3.data.Attributes attributes)	Creates a new Dimension Index Values object which wraps the provided attributes.

Method Summary

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

DimensionIndexValues

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

Creates a new Dimension Index Values object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DimensionIndexValues

public DimensionIndexValues()

Creates a new Dimension Index Values object which wraps a new and empty Attributes object.

Method Details

copy

public DimensionIndexValues copy()

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

Returns:

a new Dimension Index Values which wraps a copy of the Attributes wrapped in this Dimension Index Values.

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.