Package org.dcm4che.typeddicom.dataelements

Class FrameOfReferenceTransformationComment

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FrameOfReferenceTransformationComment

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class FrameOfReferenceTransformationComment
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Frame of Reference Transformation Comment
Keyword: FrameOfReferenceTransformationComment
Tag: (3006,00C8)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Patient to Equipment Relationship Macro > Frame of Reference Transformation Comment
  as follows:
  Attribute Name: Frame of Reference Transformation Comment
  Type: 3
  Attribute Description:

  Comments entered by a human operator about the relationship between the patient frame of reference and the equipment. For display purposes only, shall not be used for other purposes.

  
  
• Described in the contexts:
  • Spatial Registration Module > Registration Sequence > Matrix Registration Sequence > Frame of Reference Transformation Comment
  • Deformable Spatial Registration Module > Deformable Registration Sequence > Frame of Reference Transformation Comment
  as follows:
  Attribute Name: Frame of Reference Transformation Comment
  Type: 3
  Attribute Description:

  User description or comments about the registration.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

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

getString, setString

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

FrameOfReferenceTransformationComment

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

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

Parameters:

attributes - The Attributes object to be wrapped.

FrameOfReferenceTransformationComment

public FrameOfReferenceTransformationComment()

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

Method Details

copy

public FrameOfReferenceTransformationComment copy()

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

Returns:

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

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.