Package org.dcm4che.typeddicom.dataelements

Class NominalRangeModulationFractions

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NominalRangeModulationFractions

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointSingleMultiWrapper

public class NominalRangeModulationFractions
extends AbstractDataElementWrapper
implements FloatingPointSingleMultiWrapper

Name: Nominal Range Modulation Fractions
Keyword: NominalRangeModulationFractions
Tag: (300A,0503)
Value Representation: FL
Value Multiplicity: 2

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Depth Dose Parameters Sequence > Nominal Range Modulation Fractions
  as follows:
  Attribute Name: Nominal Range Modulation Fractions
  Type: 1C
  Attribute Description:

  Fractions of the Reference Dose Definition (300A,0512) defining the proximal and distal limits at which the range-modulated region is defined.

  Contains two values. The first value defines the modulation fraction value at the proximal limit and the second value defines the modulation fraction value at the distal limit.

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

  Required if Nominal Range Modulated Region Depths (300A,0504) is present.

  See DICOM Standard Part 3 - Section C.8.8.25.9.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
NominalRangeModulationFractions()	Creates a new Nominal Range Modulation Fractions object which wraps a new and empty Attributes object.
NominalRangeModulationFractions(org.dcm4che3.data.Attributes attributes)	Creates a new Nominal Range Modulation Fractions object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
NominalRangeModulationFractions	copy()	Returns a new Nominal Range Modulation Fractions which wraps a copy of the Attributes wrapped in this Nominal Range Modulation Fractions.
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.DoubleDataElementMultiWrapper

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

NominalRangeModulationFractions

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

Creates a new Nominal Range Modulation Fractions object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

NominalRangeModulationFractions

public NominalRangeModulationFractions()

Creates a new Nominal Range Modulation Fractions object which wraps a new and empty Attributes object.

Method Details

copy

public NominalRangeModulationFractions copy()

Returns a new Nominal Range Modulation Fractions which wraps a copy of the Attributes wrapped in this Nominal Range Modulation Fractions. (see Attributes(Attributes)

Returns:

a new Nominal Range Modulation Fractions which wraps a copy of the Attributes wrapped in this Nominal Range Modulation Fractions.

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.