Package org.dcm4che.typeddicom.dataelements

Class DisplacementMatrix

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DisplacementMatrix

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointDoubleMultiWrapper

public class DisplacementMatrix
extends AbstractDataElementWrapper
implements FloatingPointDoubleMultiWrapper

Name: Displacement Matrix
Keyword: DisplacementMatrix
Tag: (300A,079B)
Value Representation: FD
Value Multiplicity: 16

• Described in the contexts:
  • RT Patient Position Macro > RT Patient Position Displacement Sequence > Displacement Matrix
  as follows:
  Attribute Name: Displacement Matrix
  Type: 1
  Attribute Description:

  A rigid, homogeneous 4x4 transformation matrix that expresses the patient’s treatment position displacement in the patient coordinate space. Matrix elements shall be listed in row-major order.

  See DICOM Standard Part 3 - Section C.36.2.3.2.1.2.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DisplacementMatrix()	Creates a new Displacement Matrix object which wraps a new and empty Attributes object.
DisplacementMatrix(org.dcm4che3.data.Attributes attributes)	Creates a new Displacement Matrix object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DisplacementMatrix	copy()	Returns a new Displacement Matrix which wraps a copy of the Attributes wrapped in this Displacement Matrix.
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.DoubleDataElementMultiWrapper

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

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

DisplacementMatrix

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

Creates a new Displacement Matrix object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DisplacementMatrix

public DisplacementMatrix()

Creates a new Displacement Matrix object which wraps a new and empty Attributes object.

Method Details

copy

public DisplacementMatrix copy()

Returns a new Displacement Matrix which wraps a copy of the Attributes wrapped in this Displacement Matrix. (see Attributes(Attributes)

Returns:

a new Displacement Matrix which wraps a copy of the Attributes wrapped in this Displacement Matrix.

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.