Package org.dcm4che.typeddicom.dataelements

Class BoundingBoxAnnotationUnits

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BoundingBoxAnnotationUnits

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class BoundingBoxAnnotationUnits
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Bounding Box Annotation Units
Keyword: BoundingBoxAnnotationUnits
Tag: (0070,0003)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Graphic Annotation Module > Graphic Annotation Sequence > Text Object Sequence > Bounding Box Annotation Units
  as follows:
  Attribute Name: Bounding Box Annotation Units
  Type: 1C
  Attribute Description:

  Units of measure for the axes of the text bounding box.

  Defines whether or not the annotation is Image or Displayed Area relative. Both dimensions shall have the same units.

  Enumerated Values:

  PIXEL

  Image relative position specified with sub-pixel resolution such that the origin, which is at the Top Left Hand Corner (TLHC) of the TLHC pixel is 0.0\0.0, the Bottom Right Hand Corner (BRHC) of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel is Columns\Rows (see DICOM Standard Part 3 - figure_C.10.5-1). The values must be within the range 0\0 to Columns\Rows.

  DISPLAY

  Fraction of Specified Displayed Area where 0.0\0.0 is the TLHC and 1.0\1.0 is the BRHC. The values must be within the range 0.0 to 1.0.

  MATRIX

  Image relative position specified with sub-pixel resolution such that the origin, which is at the Top Left Hand Corner (TLHC) of the TLHC pixel of the Total Pixel Matrix, is 0.0\0.0, the Bottom Right Hand Corner (BRHC) of the TLHC pixel is 1.0\1.0, and the BRHC of the BRHC pixel of the Total Pixel Matrix is Total Pixel Matrix Columns\ Total Pixel Matrix Rows (see DICOM Standard Part 3 - Section C.8.12.4.1.3). The values must be within the range 0.0\0.0 to Total Pixel Matrix Columns\Total Pixel Matrix Rows. MATRIX may be used only if the value of Referenced SOP Class UID (0008,1150) within Referenced Image Sequence (0008,1140) is 1.2.840.10008.5.1.4.1.1.77.1.6 (VL Whole Slide Microscopy Image).

  Required if Bounding Box Top Left Hand Corner (0070,0010) or Bounding Box Bottom Right Hand Corner (0070,0011) is present.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BoundingBoxAnnotationUnits.Builder<SELF extends BoundingBoxAnnotationUnits.Builder<SELF,T>,T extends BoundingBoxAnnotationUnits.Holder>
static interface	BoundingBoxAnnotationUnits.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Bounding Box Annotation Units" (see BoundingBoxAnnotationUnits)

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
BoundingBoxAnnotationUnits()	Creates a new Bounding Box Annotation Units object which wraps a new and empty Attributes object.
BoundingBoxAnnotationUnits(org.dcm4che3.data.Attributes attributes)	Creates a new Bounding Box Annotation Units object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
BoundingBoxAnnotationUnits	copy()	Returns a new Bounding Box Annotation Units which wraps a copy of the Attributes wrapped in this Bounding Box Annotation Units.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

BoundingBoxAnnotationUnits

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

Creates a new Bounding Box Annotation Units object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BoundingBoxAnnotationUnits

public BoundingBoxAnnotationUnits()

Creates a new Bounding Box Annotation Units object which wraps a new and empty Attributes object.

Method Details

copy

public BoundingBoxAnnotationUnits copy()

Returns a new Bounding Box Annotation Units which wraps a copy of the Attributes wrapped in this Bounding Box Annotation Units. (see Attributes(Attributes)

Returns:

a new Bounding Box Annotation Units which wraps a copy of the Attributes wrapped in this Bounding Box Annotation Units.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.