Package org.dcm4che.typeddicom.dataelements

Class RTROIInterpretedType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTROIInterpretedType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RTROIInterpretedType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: RT ROI Interpreted Type
Keyword: RTROIInterpretedType
Tag: (3006,00A4)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT ROI Observations Module > RT ROI Observations Sequence > RT ROI Interpreted Type
  as follows:
  Attribute Name: RT ROI Interpreted Type
  Type: 2
  Attribute Description:

  Type of ROI. See DICOM Standard Part 3 - Section C.8.8.8.1.

  Defined Terms:

  EXTERNAL

  external patient contour

  PTV

  Planning Target Volume (as defined in DICOM Standard Part 3 - biblio_ICRU50)

  CTV

  Clinical Target Volume (as defined in DICOM Standard Part 3 - biblio_ICRU50)

  GTV

  Gross Tumor Volume (as defined in DICOM Standard Part 3 - biblio_ICRU50)

  TREATED_VOLUME

  Treated Volume (as defined in DICOM Standard Part 3 - biblio_ICRU50)

  IRRAD_VOLUME

  Irradiated Volume (as defined in DICOM Standard Part 3 - biblio_ICRU50)

  BOLUS

  patient bolus to be used for external beam therapy

  AVOIDANCE

  region in which dose is to be minimized

  ORGAN

  patient organ

  MARKER

  patient marker or marker on a localizer

  REGISTRATION

  registration ROI

  ISOCENTER

  treatment isocenter to be used for external beam therapy

  CONTRAST_AGENT

  volume into which a contrast agent has been injected

  CAVITY

  patient anatomical cavity

  BRACHY_CHANNEL

  brachytherapy channel

  BRACHY_ACCESSORY

  brachytherapy accessory device

  BRACHY_SRC_APP

  brachytherapy source applicator

  BRACHY_CHNL_SHLD

  brachytherapy channel shield

  SUPPORT

  external patient support device

  FIXATION

  external patient fixation or immobilization device

  DOSE_REGION

  ROI to be used as a dose reference

  CONTROL

  ROI to be used in control of dose optimization and calculation

  DOSE_MEASUREMENT

  ROI representing a dose measurement device, such as a chamber or TLD

  
  

Nested Class Summary

Nested Classes

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RTROIInterpretedType()	Creates a new RT ROI Interpreted Type object which wraps a new and empty Attributes object.
RTROIInterpretedType(org.dcm4che3.data.Attributes attributes)	Creates a new RT ROI Interpreted Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RTROIInterpretedType	copy()	Returns a new RT ROI Interpreted Type which wraps a copy of the Attributes wrapped in this RT ROI Interpreted Type.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

RTROIInterpretedType

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

Creates a new RT ROI Interpreted Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTROIInterpretedType

public RTROIInterpretedType()

Creates a new RT ROI Interpreted Type object which wraps a new and empty Attributes object.

Method Details

copy

public RTROIInterpretedType copy()

Returns a new RT ROI Interpreted Type which wraps a copy of the Attributes wrapped in this RT ROI Interpreted Type. (see Attributes(Attributes)

Returns:

a new RT ROI Interpreted Type which wraps a copy of the Attributes wrapped in this RT ROI Interpreted Type.

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.