Package org.dcm4che.typeddicom.dataelements

Class BeamDosePointEquivalentDepth

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamDosePointEquivalentDepth

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 BeamDosePointEquivalentDepth
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Beam Dose Point Equivalent Depth
Keyword: BeamDosePointEquivalentDepth
Tag: (300A,0089)
Value Representation: FloatingPointSingle
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 Equivalent Depth
  as follows:
  Attribute Name: Beam Dose Point Equivalent Depth
  Type: 1C
  Attribute Description:

  The radiological depth in mm (water-equivalent depth, taking tissue heterogeneity into account) 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	BeamDosePointEquivalentDepth.Builder<SELF extends BeamDosePointEquivalentDepth.Builder<SELF,T>,T extends BeamDosePointEquivalentDepth.Holder>
static interface	BeamDosePointEquivalentDepth.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Beam Dose Point Equivalent Depth" (see BeamDosePointEquivalentDepth)
static class	BeamDosePointEquivalentDepth.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
BeamDosePointEquivalentDepth()	Creates a new Beam Dose Point Equivalent Depth object which wraps a new and empty Attributes object.
BeamDosePointEquivalentDepth(org.dcm4che3.data.Attributes attributes)	Creates a new Beam Dose Point Equivalent Depth object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
BeamDosePointEquivalentDepth	copy()	Returns a new Beam Dose Point Equivalent Depth which wraps a copy of the Attributes wrapped in this Beam Dose Point Equivalent Depth.
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

BeamDosePointEquivalentDepth

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

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

Parameters:

attributes - the Attributes object to be wrapped.

BeamDosePointEquivalentDepth

public BeamDosePointEquivalentDepth()

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

Method Detail

copy

public BeamDosePointEquivalentDepth copy()

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

Returns:

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

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