Package org.dcm4che.typeddicom.dataelements

Class ROIDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ROIDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class ROIDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: ROI Description
Keyword: ROIDescription
Tag: (3006,0028)
Value Representation: ST
Value Multiplicity: 1

• Described in the contexts:
  • Structure Set Module > Structure Set ROI Sequence > ROI Description
  as follows:
  Attribute Name: ROI Description
  Type: 3
  Attribute Description:

  User-defined description for ROI.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.ShortTextWrapper

getValueRepresentation

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

Constructor Details

ROIDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ROIDescription

public ROIDescription()

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

Method Details

copy

public ROIDescription copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.