Package org.dcm4che.typeddicom.dataelements

Class SubjectArea

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SubjectArea

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementMultiWrapper, IntegerStringMultiWrapper, StringDataElementMultiWrapper

public class SubjectArea
extends AbstractDataElementWrapper
implements IntegerStringMultiWrapper

Name: Subject Area
Keyword: SubjectArea
Tag: (0016,002A)
Value Representation: IS
Value Multiplicity: 2-4

• Described in the contexts:
  • VL Photographic Acquisition Module > Subject Area
  as follows:
  Attribute Name: Subject Area
  Type: 3
  Attribute Description:

  The location and area of the main subject in the overall scene.

  If two values are present, they are the X and Y image-relative coordinates of a location.

  If three values are present, they are the X and Y image-relative center coordinates and the diameter in pixels of a circle.

  If four values are present, they are the center X image-relative coordinate, the center Y image-relative coordinate, the width in pixels, and the height in pixels of a rectangle.

  The coordinate values, width, and height are expressed in relation to the upper left as origin.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getInt, getInts, setInts

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

getValueRepresentation

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

getString, getString, getStrings, setStrings

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

SubjectArea

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

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

Parameters:

attributes - The Attributes object to be wrapped.

SubjectArea

public SubjectArea()

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

Method Details

copy

public SubjectArea copy()

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

Returns:

a new Subject Area which wraps a copy of the Attributes wrapped in this Subject 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.