Package org.dcm4che.typeddicom.dataelements

Class TargetFrameOfReferenceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TargetFrameOfReferenceUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class TargetFrameOfReferenceUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Target Frame of Reference UID
Keyword: TargetFrameOfReferenceUID
Tag: (0018,991E)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • Patient Positioning Module > Target Frame of Reference UID
  as follows:
  Attribute Name: Target Frame of Reference UID
  Type: 3
  Attribute Description:

  UID of the Frame of Reference of another data set to which the current procedure is intended to be roughly aligned.

  Note

  1. For example, in a performed protocol it may be useful to record the Frame of Reference UID used in a prior Study that was used as a reference.

  2. The Frame of Reference UID (0020,0052) in the Image Instances resulting from the performance of this protocol will likely be different than this Target Frame of Reference UID since perfect alignment is likely unachievable.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

TargetFrameOfReferenceUID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

TargetFrameOfReferenceUID

public TargetFrameOfReferenceUID()

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

Method Details

copy

public TargetFrameOfReferenceUID copy()

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

Returns:

a new Target Frame of Reference UID which wraps a copy of the Attributes wrapped in this Target 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.