Package org.dcm4che.typeddicom.dataelements

Class FrameIncrementPointer

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameIncrementPointer

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, AttributeTagMultiWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, StringDataElementMultiWrapper

public class FrameIncrementPointer
extends AbstractDataElementWrapper
implements AttributeTagMultiWrapper

Name: Frame Increment Pointer
Keyword: FrameIncrementPointer
Tag: (0028,0009)
Value Representation: AT
Value Multiplicity: 1-n

• Described in the contexts:
  • X-Ray Image Module > Frame Increment Pointer
  as follows:
  Attribute Name: Frame Increment Pointer
  Type: 1C
  Attribute Description:

  Required if Multi-frame Image.

  Contains the Data Element Tag of the Attribute that is used as the Frame increment in Multi-frame image pixel data (see DICOM Standard Part 3 - Section C.7.6.6).

  Enumerated Values:

  00181063H

  Frame Time (0018,1063)

  00181065H

  Frame Time Vector (0018,1065)

  
  
• Described in the contexts:
  • NM Multi-frame Module > Frame Increment Pointer
  as follows:
  Attribute Name: Frame Increment Pointer
  Type: 1
  Attribute Description:

  Contains the Data Element Tags of one or more frame index vectors. See DICOM Standard Part 3 - Section C.8.4.8.1.1 for further specialization.

  
  
• Described in the contexts:
  • Multi-frame Module > Frame Increment Pointer
  as follows:
  Attribute Name: Frame Increment Pointer
  Type: 1
  Attribute Description:

  Contains the Data Element Tag of the Attribute that is used as the frame increment in Multi-frame pixel data. See DICOM Standard Part 3 - Section C.7.6.6.1.2 for further explanation.

  
  
• Described in the contexts:
  • SC Multi-frame Image Module > Frame Increment Pointer
  as follows:
  Attribute Name: Frame Increment Pointer
  Type: 1C
  Attribute Description:

  Contains the Data Element Tag of the Attribute that is used as the frame increment in Multi-frame pixel data. See DICOM Standard Part 3 - Section C.7.6.6.1.2 for further explanation.

  Shall be present if Number of Frames is greater than 1, overriding (specializing) the Type 1 requirement on this Attribute in the DICOM Standard Part 3 - Section C.7.6.6.

  
  
• Described in the contexts:
  • US Image Module > Frame Increment Pointer
  as follows:
  Attribute Name: Frame Increment Pointer
  Type: 1C
  Attribute Description:

  Contains the Data Element Tag of the Attribute that is used as the frame increment in Multi-frame pixel data (see DICOM Standard Part 3 - Section C.7.6.6). Required if Number of Frames is present.

  See DICOM Standard Part 3 - Section C.8.5.6.1.4 for specialization.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
FrameIncrementPointer()	Creates a new Frame Increment Pointer object which wraps a new and empty Attributes object.
FrameIncrementPointer(org.dcm4che3.data.Attributes attributes)	Creates a new Frame Increment Pointer object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
FrameIncrementPointer	copy()	Returns a new Frame Increment Pointer which wraps a copy of the Attributes wrapped in this Frame Increment Pointer.
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.AttributeTagMultiWrapper

getValueRepresentation

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

getString, getString, getStrings, setStrings

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

FrameIncrementPointer

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

Creates a new Frame Increment Pointer object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FrameIncrementPointer

public FrameIncrementPointer()

Creates a new Frame Increment Pointer object which wraps a new and empty Attributes object.

Method Details

copy

public FrameIncrementPointer copy()

Returns a new Frame Increment Pointer which wraps a copy of the Attributes wrapped in this Frame Increment Pointer. (see Attributes(Attributes)

Returns:

a new Frame Increment Pointer which wraps a copy of the Attributes wrapped in this Frame Increment Pointer.

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.