Package org.dcm4che.typeddicom.dataelements

Class DVHVolumeUnits

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DVHVolumeUnits

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DVHVolumeUnits
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: DVH Volume Units
Keyword: DVHVolumeUnits
Tag: (3004,0054)
Value Representation: CS
Value Multiplicity: 1

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

  Volume axis units.

  Defined Terms:

  CM3

  cubic centimeters

  PERCENT

  percent

  PER_U

  volume per u with u(dose)=dose^-3/2. See DICOM Standard Part 3 - Section C.8.8.4.3.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DVHVolumeUnits.Builder<SELF extends DVHVolumeUnits.Builder<SELF,T>,T extends DVHVolumeUnits.Holder>
static interface	DVHVolumeUnits.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "DVH Volume Units" (see DVHVolumeUnits)

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

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

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

Method Summary

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

DVHVolumeUnits

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

Creates a new DVH Volume Units object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DVHVolumeUnits

public DVHVolumeUnits()

Creates a new DVH Volume Units object which wraps a new and empty Attributes object.

Method Details

copy

public DVHVolumeUnits copy()

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

Returns:

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