Package org.dcm4che.typeddicom.dataelements

Class ROIObservationDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ROIObservationDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class ROIObservationDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: ROI Observation Description
Keyword: ROIObservationDescription
Tag: (3006,0088)
Value Representation: ST
Value Multiplicity: 1

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

  User-defined description for ROI Observation.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ROIObservationDescription()	Creates a new ROI Observation Description object which wraps a new and empty Attributes object.
ROIObservationDescription(org.dcm4che3.data.Attributes attributes)	Creates a new ROI Observation Description object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ROIObservationDescription	copy()	Returns a new ROI Observation Description which wraps a copy of the Attributes wrapped in this ROI Observation Description.
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.ShortTextWrapper

getValueRepresentation

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

ROIObservationDescription

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

Creates a new ROI Observation Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ROIObservationDescription

public ROIObservationDescription()

Creates a new ROI Observation Description object which wraps a new and empty Attributes object.

Method Details

copy

public ROIObservationDescription copy()

Returns a new ROI Observation Description which wraps a copy of the Attributes wrapped in this ROI Observation Description. (see Attributes(Attributes)

Returns:

a new ROI Observation Description which wraps a copy of the Attributes wrapped in this ROI Observation Description.

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.