Package org.dcm4che.typeddicom.dataelements

Class CompensatorColumnOffset

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorColumnOffset

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper, FloatingPointSingleWrapper

public class CompensatorColumnOffset
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Compensator Column Offset
Keyword: CompensatorColumnOffset
Tag: (300A,02E5)
Value Representation: FloatingPointSingle
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Range Compensator Sequence > Compensator Column Offset
  as follows:
  Attribute Name: Compensator Column Offset
  Type: 1C
  Attribute Description:

  The offset distance (in mm) applied to the x coordinate of Compensator Position (300A,00EA) for even numbered rows. Required if the compensator pattern is hexagonal.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
CompensatorColumnOffset()	Creates a new Compensator Column Offset object which wraps a new and empty Attributes object.
CompensatorColumnOffset(org.dcm4che3.data.Attributes attributes)	Creates a new Compensator Column Offset object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
CompensatorColumnOffset	copy()	Returns a new Compensator Column Offset which wraps a copy of the Attributes wrapped in this Compensator Column Offset.
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, 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.DoubleDataElementWrapper

getDouble, setDouble

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

getFloat, setFloat

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

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

CompensatorColumnOffset

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

Creates a new Compensator Column Offset object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

CompensatorColumnOffset

public CompensatorColumnOffset()

Creates a new Compensator Column Offset object which wraps a new and empty Attributes object.

Method Detail

copy

public CompensatorColumnOffset copy()

Returns a new Compensator Column Offset which wraps a copy of the Attributes wrapped in this Compensator Column Offset. (see Attributes(Attributes)

Returns:

a new Compensator Column Offset which wraps a copy of the Attributes wrapped in this Compensator Column Offset.

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