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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementMultiWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementMultiWrapper, FloatingPointSingleMultiWrapper

public class NominalRangeModulationFractions
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements FloatingPointSingleMultiWrapper

Name: Nominal Range Modulation Fractions
Keyword: NominalRangeModulationFractions
Tag: (300A,0503)
Value Representation: FloatingPointSingle
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)
static class	NominalRangeModulationFractions.SimpleHolder

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

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

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.FloatingPointSingleMultiWrapper

VALUE_REPRESENTATION

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.
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.DoubleDataElementMultiWrapper

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

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

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 Detail

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.

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