Package org.dcm4che.typeddicom.dataelements

Class DistalDepthFraction

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DistalDepthFraction

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class DistalDepthFraction
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Distal Depth Fraction
Keyword: DistalDepthFraction
Tag: (300A,0501)
Value Representation: FL
Value Multiplicity: 1

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

  Fraction of the value of dose relative to the 100% level defined by Reference Dose Definition (300A,0512). This determines the Distal Depth (300A,0502).

  A value of 1.0 refers to 100% of the reference dose level defined by the Reference Dose Definition (300A,0512).

  See DICOM Standard Part 3 - Section C.8.8.25.9.

  
  

Nested Class Summary

Nested Classes

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

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.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DistalDepthFraction()	Creates a new Distal Depth Fraction object which wraps a new and empty Attributes object.
DistalDepthFraction(org.dcm4che3.data.Attributes attributes)	Creates a new Distal Depth Fraction object which wraps the provided attributes.

Method Summary

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

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

DistalDepthFraction

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DistalDepthFraction

public DistalDepthFraction()

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

Method Details

copy

public DistalDepthFraction copy()

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

Returns:

a new Distal Depth Fraction which wraps a copy of the Attributes wrapped in this Distal Depth Fraction.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.