Package org.dcm4che.typeddicom.dataelements

Class DistalDepth

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DistalDepth

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class DistalDepth
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Distal Depth
Keyword: DistalDepth
Tag: (300A,0502)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Depth Dose Parameters Sequence > Distal Depth
  as follows:
  Attribute Name: Distal Depth
  Type: 1
  Attribute Description:

  Penetration depth in water (mm) of the particle excluding any user-installed range modifying devices, measured at the Distal Depth Fraction (300A,0501).

  See DICOM Standard Part 3 - Section C.8.8.25.9.

  
  

Nested Class Summary

Nested Classes

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

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
DistalDepth()	Creates a new Distal Depth object which wraps a new and empty Attributes object.
DistalDepth(org.dcm4che3.data.Attributes attributes)	Creates a new Distal Depth object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DistalDepth	copy()	Returns a new Distal Depth which wraps a copy of the Attributes wrapped in this Distal 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

DistalDepth

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

Creates a new Distal Depth object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DistalDepth

public DistalDepth()

Creates a new Distal Depth object which wraps a new and empty Attributes object.

Method Details

copy

public DistalDepth copy()

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

Returns:

a new Distal Depth which wraps a copy of the Attributes wrapped in this Distal 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.