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


  • Field Details

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

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