Class DefaultImageDatum

All Implemented Interfaces:
Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Datum, Image­Datum, Identified­Object

@Deprecated(since="1.5", forRemoval=true) public final class DefaultImageDatum extends AbstractDatum implements ImageDatum
Deprecated, for removal: This API element is subject to removal in a future version.
The Image­Datum class has been removed in ISO 19111:2019. It is replaced by Engineering­Datum.
Defines the origin of an image coordinate reference system. An image datum is used in a local context only. For an image datum, the anchor point is usually either the centre of the image or the corner of the image.

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself) given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.
Since:
0.4
See Also:
  • Constructor Details

  • Method Details

    • castOrCopy

      public static DefaultImageDatum castOrCopy(ImageDatum object)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns a SIS datum implementation with the same values as the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.
    • getInterface

      public Class<? extends ImageDatum> getInterface()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the GeoAPI interface implemented by this class. The SIS implementation returns Image­Datum​.class.

      Note for implementers

      Subclasses usually do not need to override this method since GeoAPI does not define Image­Datum sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.
      Overrides:
      get­Interface in class Abstract­Datum
      Returns:
      Image­Datum​.class or a user-defined sub-interface.
    • getPixelInCell

      public PixelInCell getPixelInCell()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specification of the way the image grid is associated with the image data attributes.
      Specified by:
      get­Pixel­In­Cell in interface Image­Datum
      Returns:
      the way image grid is associated with image data attributes.
    • formatTo

      protected String formatTo(Formatter formatter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Formats this datum as a Well Known Text Image­Datum[…] element.

      Compatibility note

      Image­Datum is defined only in the first edition of the WKT 2 specification (ISO 19162:2015).
      Overrides:
      format­To in class Abstract­Datum
      Parameters:
      formatter - the formatter where to format the inner content of this WKT element.
      Returns:
      "IDatum" or "Image­Datum".
      See Also: