Package org.dcm4che.typeddicom.dataelements

Class BeamDosePointDepth

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamDosePointDepth

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class BeamDosePointDepth
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Beam Dose Point Depth
Keyword: BeamDosePointDepth
Tag: (300A,0088)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Referenced Dose Reference Sequence > Beam Dose Verification Control Point Sequence > Beam Dose Point Depth
  as follows:
  Attribute Name: Beam Dose Point Depth
  Type: 1C
  Attribute Description:

  The depth (in mm) in the patient along a ray from the source to the dose point specified by the Dose Reference Point Coordinates (300A,0018) or the referenced ROI.

  Required for all but the last Item in this Sequence and for the last Item if Depth Value Averaging Flag (300A,0093) has a value of NO.

  See Note 6.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BeamDosePointDepth.Builder<SELF extends BeamDosePointDepth.Builder<SELF,T>,T extends BeamDosePointDepth.Holder>
static interface	BeamDosePointDepth.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Beam Dose Point Depth" (see BeamDosePointDepth)

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
BeamDosePointDepth()	Creates a new Beam Dose Point Depth object which wraps a new and empty Attributes object.
BeamDosePointDepth(org.dcm4che3.data.Attributes attributes)	Creates a new Beam Dose Point Depth object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
BeamDosePointDepth	copy()	Returns a new Beam Dose Point Depth which wraps a copy of the Attributes wrapped in this Beam Dose Point Depth.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

BeamDosePointDepth

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

Creates a new Beam Dose Point Depth object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamDosePointDepth

public BeamDosePointDepth()

Creates a new Beam Dose Point Depth object which wraps a new and empty Attributes object.

Method Details

copy

public BeamDosePointDepth copy()

Returns a new Beam Dose Point Depth which wraps a copy of the Attributes wrapped in this Beam Dose Point Depth. (see Attributes(Attributes)

Returns:

a new Beam Dose Point Depth which wraps a copy of the Attributes wrapped in this Beam Dose Point Depth.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.