Package org.geotools.referencing.datum

Class DefaultImageDatum

  • All Implemented Interfaces:
    Serializable, Datum, ImageDatum, IdentifiedObject
    public class DefaultImageDatum
extends AbstractDatum
implements ImageDatum
    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.
    Since:
    2.1
    Author:
    Martin Desruisseaux (IRD)
    See Also:
    Serialized Form

    • Constructor Detail

      • DefaultImageDatum

        public DefaultImageDatum​(ImageDatum datum)
        Constructs a new datum with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotools one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. This constructor performs a shallow copy, i.e. the properties are not cloned.
        Parameters:
        datum - The datum to copy.
        Since:
        2.2

      • DefaultImageDatum

        public DefaultImageDatum​(String name,
                         PixelInCell pixelInCell)
        Constructs an image datum from a name.
        Parameters:
        name - The datum name.
        pixelInCell - the way the image grid is associated with the image data attributes.

      • DefaultImageDatum

        public DefaultImageDatum​(Map<String,​?> properties,
                         PixelInCell pixelInCell)
        Constructs an image datum from a set of properties. The properties map is given unchanged to the super-class constructor.
        Parameters:
        properties - Set of properties. Should contains at least "name".
        pixelInCell - the way the image grid is associated with the image data attributes.

    • Method Detail

      • getPixelInCell

        public PixelInCell getPixelInCell()
        Specification of the way the image grid is associated with the image data attributes.
        Specified by:
        getPixelInCell in interface ImageDatum
        Returns:
        The way image grid is associated with image data attributes.

      • equals

        public boolean equals​(AbstractIdentifiedObject object,
                      boolean compareMetadata)
        Compare this datum with the specified object for equality.
        Overrides:
        equals in class AbstractDatum
        Parameters:
        object - The object to compare to this.
        compareMetadata - true for performing a strict comparaison, or false for comparing only properties relevant to transformations.
        Returns:
        true if both objects are equal.

      • hashCode

        public int hashCode()
        Returns a hash value for this image datum. Name, remarks and the like are not taken in account. In other words, two image datums will return the same hash value if they are equal in the sense of equals(AbstractIdentifiedObject, false).
        Overrides:
        hashCode in class AbstractIdentifiedObject
        Returns:
        The hash code value. This value doesn't need to be the same in past or future versions of this class.