Package org.dcm4che.typeddicom.dataelements

Class ROIObservationLabel

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ROIObservationLabel

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class ROIObservationLabel
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: ROI Observation Label
Keyword: ROIObservationLabel
Tag: (3006,0085)
Value Representation: SH
Value Multiplicity: 1

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

  User-defined label for ROI Observation.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

ROIObservationLabel

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ROIObservationLabel

public ROIObservationLabel()

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

Method Details

copy

public ROIObservationLabel copy()

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

Returns:

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

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.