Package org.dcm4che.typeddicom.dataelements

Class DoseGridScaling

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseGridScaling

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, StringDataElementWrapper

public class DoseGridScaling
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Dose Grid Scaling
Keyword: DoseGridScaling
Tag: (3004,000E)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Dose Module > Dose Grid Scaling
  as follows:
  Attribute Name: Dose Grid Scaling
  Type: 1C
  Attribute Description:

  Scaling factor that when multiplied by the dose grid data found in Pixel Data (7FE0,0010) Attribute of the DICOM Standard Part 3 - Section C.7.6.3, yields grid doses in the dose units as specified by Dose Units (3004,0002).

  Required if Pixel Data (7FE0,0010) is present.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DoseGridScaling()	Creates a new Dose Grid Scaling object which wraps a new and empty Attributes object.
DoseGridScaling(org.dcm4che3.data.Attributes attributes)	Creates a new Dose Grid Scaling object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DoseGridScaling	copy()	Returns a new Dose Grid Scaling which wraps a copy of the Attributes wrapped in this Dose Grid Scaling.
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.DecimalStringWrapper

getValueRepresentation

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

getString, setString

Field Details

PRIVATE_CREATOR

public static final 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 Details

DoseGridScaling

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

Creates a new Dose Grid Scaling object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseGridScaling

public DoseGridScaling()

Creates a new Dose Grid Scaling object which wraps a new and empty Attributes object.

Method Details

copy

public DoseGridScaling copy()

Returns a new Dose Grid Scaling which wraps a copy of the Attributes wrapped in this Dose Grid Scaling. (see Attributes(Attributes)

Returns:

a new Dose Grid Scaling which wraps a copy of the Attributes wrapped in this Dose Grid Scaling.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.