Package org.dcm4che.typeddicom.dataelements

Class DVHDoseScaling

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DVHDoseScaling

All Implemented Interfaces:

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

public class DVHDoseScaling
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: DVH Dose Scaling
Keyword: DVHDoseScaling
Tag: (3004,0052)
Value Representation: DS
Value Multiplicity: 1

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

  Scaling factor that when multiplied by the dose bin widths found in DVH Data (3004,0058), yields dose bin widths in the dose units as specified by Dose Units (3004,0002).

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DVHDoseScaling.Builder<SELF extends DVHDoseScaling.Builder<SELF,T>,T extends DVHDoseScaling.Holder>
static interface	DVHDoseScaling.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "DVH Dose Scaling" (see DVHDoseScaling)
static class	DVHDoseScaling.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
DVHDoseScaling()	Creates a new DVH Dose Scaling object which wraps a new and empty Attributes object.
DVHDoseScaling(org.dcm4che3.data.Attributes attributes)	Creates a new DVH Dose Scaling object which wraps the provided attributes.

Method Summary

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

DVHDoseScaling

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DVHDoseScaling

public DVHDoseScaling()

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

Method Details

copy

public DVHDoseScaling copy()

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

Returns:

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