Package org.dcm4che.typeddicom.dataelements

Class ReferencedFrameOfReferenceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedFrameOfReferenceUID

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class ReferencedFrameOfReferenceUID
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Referenced Frame of Reference UID
Keyword: ReferencedFrameOfReferenceUID
Tag: (3006,0024)
Value Representation: UniqueIdentifierUID
Value Multiplicity: 1

• Described in the contexts:
  • Structure Set Module > Structure Set ROI Sequence > Referenced Frame of Reference UID
  as follows:
  Attribute Name: Referenced Frame of Reference UID
  Type: 1
  Attribute Description:

  Uniquely identifies Frame of Reference in which ROI is defined, specified by Frame of Reference UID (0020,0052) in Referenced Frame of Reference Sequence (3006,0010).

  
  
• Described in the contexts:
  • 3D Spatial Coordinates Macro > Referenced Frame of Reference UID
  as follows:
  Attribute Name: Referenced Frame of Reference UID
  Type: 1
  Attribute Description:

  Uniquely identifies the Frame of Reference within which the coordinates are defined.

  Note

  1. There is no requirement that the Frame of Reference be the same for all SCOORD3D Content Items in the same SR SOP Instance, nor is there any requirement that the DICOM Standard Part 3 - Section C.7.4.1 be present.

  2. The Frame of Reference may be any type of DICOM Reference Coordinate System, whether it be patient-relative (Patient Based Coordinate System), volume-relative (including acquired and presentation state volumes), or whole slide relative (Slide Coordinate System).

  
  

Nested Class Summary

Nested Classes

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

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

UniqueIdentifierUIDWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends UniqueIdentifierUIDWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.UniqueIdentifierUIDWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferencedFrameOfReferenceUID()	Creates a new Referenced Frame of Reference UID object which wraps a new and empty Attributes object.
ReferencedFrameOfReferenceUID(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Frame of Reference UID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferencedFrameOfReferenceUID	copy()	Returns a new Referenced Frame of Reference UID which wraps a copy of the Attributes wrapped in this Referenced Frame of Reference UID.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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.StringDataElementWrapper

getString, setString

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

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

ReferencedFrameOfReferenceUID

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

Creates a new Referenced Frame of Reference UID object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

ReferencedFrameOfReferenceUID

public ReferencedFrameOfReferenceUID()

Creates a new Referenced Frame of Reference UID object which wraps a new and empty Attributes object.

Method Detail

copy

public ReferencedFrameOfReferenceUID copy()

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

Returns:

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

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper