Package org.dcm4che.typeddicom.dataelements

Class FrameOfReferenceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameOfReferenceUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class FrameOfReferenceUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Frame of Reference UID
Keyword: FrameOfReferenceUID
Tag: (0020,0052)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Spatial Registration Module > Registration Sequence > Frame of Reference UID
  as follows:
  Attribute Name: Frame of Reference UID
  Type: 1C
  Attribute Description:

  Identifies the Frame of Reference of the referenced data, that may or may not be an image set (e.g., atlas or physical space). See DICOM Standard Part 3 - Section C.7.4.1.1.1 for further explanation.

  Required if Referenced Image Sequence (0008,1140) is absent. May be present otherwise.

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

  Uniquely identifies Frame of Reference within Structure Set.

  
  
• Described in the contexts:
  • Frame of Reference Module > Frame of Reference UID
  as follows:
  Attribute Name: Frame of Reference UID
  Type: 1
  Attribute Description:

  Uniquely identifies the Frame of Reference for a Series. See DICOM Standard Part 3 - Section C.7.4.1.1.1 for further explanation.

  
  
• Described in the contexts:
  • Generic Implant Template Description Module > Frame of Reference UID
  as follows:
  Attribute Name: Frame of Reference UID
  Type: 1
  Attribute Description:

  Defines a 3D Frame of Reference for this component.

  
  
• Described in the contexts:
  • Spatial Fiducials Module > Fiducial Set Sequence > Frame of Reference UID
  as follows:
  Attribute Name: Frame of Reference UID
  Type: 1C
  Attribute Description:

  Identifies a Frame of Reference that may or may not be an image set (e.g., an atlas or physical space). See DICOM Standard Part 3 - Section C.7.4.1.1.1 for further explanation. Required if Referenced Image Sequence (0008,1140) is absent. May be present otherwise.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getString, setString

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

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

FrameOfReferenceUID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

FrameOfReferenceUID

public FrameOfReferenceUID()

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

Method Details

copy

public FrameOfReferenceUID copy()

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

Returns:

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

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.