Package org.dcm4che.typeddicom.dataelements

Class ROIArea

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ROIArea

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class ROIArea
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: ROI Area
Keyword: ROIArea
Tag: (60xx,1301)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • Overlay Plane Module > ROI Area
  as follows:
  Attribute Name: ROI Area
  Type: 3
  Attribute Description:

  Number of pixels in ROI area.

  See DICOM Standard Part 3 - Section C.9.2.1.2 for further explanation.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getInt, setInt

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

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

ROIArea

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ROIArea

public ROIArea()

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

Method Details

copy

public ROIArea copy()

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

Returns:

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

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.