Package org.dcm4che.typeddicom.dataelements

Class ConcatenationFrameOffsetNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ConcatenationFrameOffsetNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedLongWrapper

public class ConcatenationFrameOffsetNumber
extends AbstractDataElementWrapper
implements UnsignedLongWrapper

Name: Concatenation Frame Offset Number
Keyword: ConcatenationFrameOffsetNumber
Tag: (0020,9228)
Value Representation: UL
Value Multiplicity: 1

• Described in the contexts:
  • Ophthalmic Tomography Image Module > Concatenation Frame Offset Number
  • Ophthalmic Optical Coherence Tomography B-scan Volume Analysis Image Module > Concatenation Frame Offset Number
  as follows:
  Attribute Name: Concatenation Frame Offset Number
  Type: 1
  Attribute Description:

  Offset of the first frame in a multi-frame image of a concatenation.

  Enumerated Values:

  0

  
  
• Described in the contexts:
  • Multi-frame Functional Groups Module > Concatenation Frame Offset Number
  as follows:
  Attribute Name: Concatenation Frame Offset Number
  Type: 1C
  Attribute Description:

  Offset of the first frame in a multi-frame image of a concatenation. Logical frame numbers in a concatenation can be used across all its SOP Instances. This offset can be applied to the implicit frame number to find the logical frame number in a concatenation. The offset is numbered from zero; i.e., the instance of a concatenation that begins with the first frame of the concatenation has a Concatenation Frame Offset Number (0020,9228) of zero.

  Required if Concatenation UID (0020,9161) is present.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ConcatenationFrameOffsetNumber	copy()	Returns a new Concatenation Frame Offset Number which wraps a copy of the Attributes wrapped in this Concatenation Frame Offset Number.
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, getPrivateCreator, getValue

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

getInt, setInt

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ConcatenationFrameOffsetNumber

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

Creates a new Concatenation Frame Offset Number object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ConcatenationFrameOffsetNumber

public ConcatenationFrameOffsetNumber()

Creates a new Concatenation Frame Offset Number object which wraps a new and empty Attributes object.

Method Details

copy

public ConcatenationFrameOffsetNumber copy()

Returns a new Concatenation Frame Offset Number which wraps a copy of the Attributes wrapped in this Concatenation Frame Offset Number. (see Attributes(Attributes)

Returns:

a new Concatenation Frame Offset Number which wraps a copy of the Attributes wrapped in this Concatenation Frame Offset Number.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.