Class SpatialCoordinateAndImageReference

java.lang.Object
com.pixelmed.dicom.SpatialCoordinateAndImageReference

public class SpatialCoordinateAndImageReference extends Object

A class to encapsulate information describing references in a structured report to images, with or without spatial coordinates.

See Also:
  • Field Details

    • RenderingRequired

      public static final int RenderingRequired
      See Also:
    • RenderingOptional

      public static final int RenderingOptional
      See Also:
    • RenderingForbidden

      public static final int RenderingForbidden
      See Also:
    • CoordinateCategoryUnspecified

      public static final int CoordinateCategoryUnspecified
      See Also:
    • CoordinateCategoryMammoIndividualCalcification

      public static final int CoordinateCategoryMammoIndividualCalcification
      See Also:
    • CoordinateCategoryMammoCalcificationCluster

      public static final int CoordinateCategoryMammoCalcificationCluster
      See Also:
    • CoordinateCategoryMammoBreastDensity

      public static final int CoordinateCategoryMammoBreastDensity
      See Also:
  • Constructor Details

    • SpatialCoordinateAndImageReference

      public SpatialCoordinateAndImageReference(String sopInstanceUID, String sopClassUID, String graphicType, float[] graphicData, String annotation, int renderingIntent, int coordinateCategory, boolean imageLibraryEntry)

      Construct an instance of a reference to an image, with or without spatial coordinate references.

      Parameters:
      sopInstanceUID - the SOP Instance UID (should always present)
      sopClassUID - the SOP Class UID (may be null)
      graphicType - the Graphic Type if a spatial coordinate, otherwise null
      graphicData - the Graphic Data if a spatial coordinate, otherwise null
      annotation - a String value describing the reference (typically a parent Concept Name)
      renderingIntent - whether or not to render the annotation (e.g., as specified by rendering intent in CAD IODs)
      coordinateCategory - the category of coordinate or annotation
      imageLibraryEntry - whether or not the reference is in an Image Library
    • SpatialCoordinateAndImageReference

      public SpatialCoordinateAndImageReference(String sopInstanceUID, String sopClassUID, String graphicType, float[] graphicData, String annotation, int renderingIntent, int coordinateCategory)

      Construct an instance of a reference to an image, with or without spatial coordinate references.

      Parameters:
      sopInstanceUID - the SOP Instance UID (should always present)
      sopClassUID - the SOP Class UID (may be null)
      graphicType - the Graphic Type if a spatial coordinate, otherwise null
      graphicData - the Graphic Data if a spatial coordinate, otherwise null
      annotation - a String value describing the reference (typically a parent Concept Name)
      renderingIntent - whether or not to render the annotation (e.g., as specified by rendering intent in CAD IODs)
      coordinateCategory - the category of coordinate or annotation
  • Method Details

    • getSOPInstanceUID

      public String getSOPInstanceUID()

      Get the SOP Instance UID.

      Returns:
      the SOP Instance UID, or null
    • getSOPClassUID

      public String getSOPClassUID()

      Get the SOP Class UID.

      Returns:
      the SOP Class UID, or null
    • getGraphicType

      public String getGraphicType()

      Get the Graphic Type.

      Returns:
      the Graphic Type, or null
    • getGraphicData

      public float[] getGraphicData()

      Get the Graphic Data.

      Returns:
      the Graphic Data, or null
    • getAnnotation

      public String getAnnotation()

      Get the annotation.

      Returns:
      the annotation
    • getRenderingIntent

      public int getRenderingIntent()

      Get rendering intent.

      Returns:
      values of SpatialCoordinateAndImageReference.RenderingRequired, SpatialCoordinateAndImageReference.RenderingOptional or SpatialCoordinateAndImageReference.RenderingForbidden
    • getImageLibraryEntry

      public boolean getImageLibraryEntry()

      Is the reference an Image Library entry.

      Returns:
      true if an Image Library entry
    • getCoordinateCategory

      public int getCoordinateCategory()

      Get category.

      Returns:
      category
    • toString

      public String toString()

      Dump a human-readable representation as a String.

      Overrides:
      toString in class Object
      Returns:
      the annotation