Package org.dcm4che.typeddicom.dataelements

Class ReferencedFrameNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedFrameNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, IntegerStringMultiWrapper, StringDataElementMultiWrapper

public class ReferencedFrameNumber
extends AbstractDataElementWrapper
implements IntegerStringMultiWrapper

Name: Referenced Frame Number
Keyword: ReferencedFrameNumber
Tag: (0008,1160)
Value Representation: IS
Value Multiplicity: 1-n

• Described in the contexts:
  • RT Image Module > Exposure Sequence > Referenced Frame Number
  as follows:
  Attribute Name: Referenced Frame Number
  Type: 1C
  Attribute Description:

  Identifies corresponding image frame in multi-frame image. Required if there is more than one Item in Exposure Sequence (3002,0030), and image is a multi-frame image.

  
  
• Described in the contexts:
  • Ophthalmic Axial Measurements Quality Image SOP Instance Reference Macro > Referenced Frame Number
  as follows:
  Attribute Name: Referenced Frame Number
  Type: 1
  Attribute Description:

  Identifies the frame number within the Referenced SOP Instance to which the reference applies. The first frame shall be denoted as frame number 1.

  Only a single value shall exist.

  Note

  This Attribute is a multi-value field but for this Macro it can only contain one value.

  
  
• Described in the contexts:
  • Wide Field Ophthalmic Photography 3D Coordinates Module > Two Dimensional to Three Dimensional Map Sequence > Referenced Frame Number
  as follows:
  Attribute Name: Referenced Frame Number
  Type: 1
  Attribute Description:

  References one or more frames within this SOP Instance to which this Sequence Item applies. The first frame shall be denoted as frame number one.

  
  
• Described in the contexts:
  • Content Item Macro Description > Referenced SOP Sequence > Referenced Frame Number
  • Referenced Instances and Access Macro > Referenced SOP Sequence > Referenced Frame Number
  • Image SOP Instance Reference Macro > Referenced Frame Number
  as follows:
  Attribute Name: Referenced Frame Number
  Type: 1C
  Attribute Description:

  Identifies the frame numbers within the Referenced SOP Instance to which the reference applies. The first frame shall be denoted as frame number 1.

  Note

  This Attribute may be multi-valued.

  Required if the Referenced SOP Instance is a multi-frame image and the reference does not apply to all frames, and Referenced Segment Number (0062,000B) is not present.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedFrameNumber()	Creates a new Referenced Frame Number object which wraps a new and empty Attributes object.
ReferencedFrameNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Frame Number object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedFrameNumber	copy()	Returns a new Referenced Frame Number which wraps a copy of the Attributes wrapped in this Referenced Frame Number.
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.IntegerStringMultiWrapper

getValueRepresentation

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

ReferencedFrameNumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedFrameNumber

public ReferencedFrameNumber()

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

Method Details

copy

public ReferencedFrameNumber copy()

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

Returns:

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

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.