Package org.dcm4che.typeddicom.dataelements

Class CommonZCoordinateValue

java.lang.Object
org.dcm4che.typeddicom.AbstractAttributesWrapper
org.dcm4che.typeddicom.AbstractDataElementWrapper
org.dcm4che.typeddicom.dataelements.CommonZCoordinateValue
All Implemented Interfaces:
AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointDoubleMultiWrapper
public class CommonZCoordinateValue extends AbstractDataElementWrapper implements FloatingPointDoubleMultiWrapper
Name: Common Z Coordinate Value
Keyword: CommonZCoordinateValue
Tag: (006A,0010)
Value Representation: FD
Value Multiplicity: 1-n
  • Described in the contexts: as follows:
    Attribute Name: Common Z Coordinate Value
    Type: 1C
    Attribute Description:

    The Z coordinate(s) common to all points in Point Coordinates Data (0066,0016) or Double Point Coordinates Data (0066,0022), in mm in the Slide Coordinate System (DICOM Standard Part 3 - Section C.8.12.2.1.1) associated with the Frame of Reference.

    More than one value may be present if the Annotations apply to more than one (but not all) Z planes.

    Required if Annotation Coordinate Type (006A,0001) is 3D, and all points in Point Coordinates Data (0066,0016) or Double Point Coordinates Data (0066,0022) are in the same Z plane(s).

    Note

    This requirement means that it is mandatory to factor out the commonality, i.e., it is not permitted to send Point Coordinates Data (0066,0016) or Double Point Coordinates Data (0066,0022) with (X, Y, Z) triplets where all the Z values are the same. For Annotations of images that only have a single Z plane, or where all the points in an Annotation Group are coplanar and in the same Z plane, this condition will always be satisfied. Annotations in different Z planes can be separated into separate Annotation Groups in order to allow this condition to be satisfied, but using separate Annotation Groups is not required.

    See DICOM Standard Part 3 - Section C.37.1.2.1.1.


  • Field Details

  • Constructor Details

    • CommonZCoordinateValue

      public CommonZCoordinateValue(org.dcm4che3.data.Attributes attributes)
      Creates a new Common Z Coordinate Value object which wraps the provided attributes.
      Parameters:
      attributes - The Attributes object to be wrapped.

    • CommonZCoordinateValue

      public CommonZCoordinateValue()
      Creates a new Common Z Coordinate Value object which wraps a new and empty Attributes object.

  • Method Details

    • copy

      public CommonZCoordinateValue copy()
      Returns a new Common Z Coordinate Value which wraps a copy of the Attributes wrapped in this Common Z Coordinate Value. (see Attributes(Attributes)
      Returns:
      a new Common Z Coordinate Value which wraps a copy of the Attributes wrapped in this Common Z Coordinate Value.

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