Package org.dcm4che.typeddicom.dataelements

Class DoseUnits

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseUnits

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DoseUnits
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Dose Units
Keyword: DoseUnits
Tag: (3004,0002)
Value Representation: CS
Value Multiplicity: 1

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

  Dose axis units.

  Enumerated Values:

  GY

  Gray

  RELATIVE

  dose relative to reference value specified in DVH Normalization Dose Value (3004,0042)

  
  
• Described in the contexts:
  • Measured Dose Reference Record Module > Measured Dose Reference Sequence > Dose Units
  as follows:
  Attribute Name: Dose Units
  Type: 1
  Attribute Description:

  Units used to describe measured dose.

  Enumerated Values:

  GY

  Gray

  RELATIVE

  Dose relative to implicit reference value

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

  Units used for ROI Dose.

  Enumerated Values:

  GY

  Gray

  RELATIVE

  dose relative to implicit reference value

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

  Units used to describe dose.

  Enumerated Values:

  GY

  Gray

  RELATIVE

  dose relative to implicit reference value

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DoseUnits.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Dose Units" (see DoseUnits)

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
DoseUnits()	Creates a new Dose Units object which wraps a new and empty Attributes object.
DoseUnits(org.dcm4che3.data.Attributes attributes)	Creates a new Dose Units object which wraps the provided attributes.

Method Summary

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

getString, setString

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

DoseUnits

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

Creates a new Dose Units object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseUnits

public DoseUnits()

Creates a new Dose Units object which wraps a new and empty Attributes object.

Method Details

copy

public DoseUnits copy()

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

Returns:

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

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.