org.geotoolkit.referencing.crs
Class DefaultImageCRS

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractReferenceSystem
              AbstractCRS
                  AbstractSingleCRS
                      DefaultImageCRS

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, CoordinateReferenceSystem, ImageCRS, SingleCRS, IdentifiedObject, ReferenceSystem

@Immutable
public class DefaultImageCRS
extends AbstractSingleCRS
implements ImageCRS

An engineering coordinate reference system applied to locations in images. Image coordinate reference systems are treated as a separate sub-type because a separate user community exists for images with its own terms of reference.

Used with CS type(s)

Cartesian, Affine

Since:

2.0

Version:

3.18

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

static DefaultImageCRS

GRID_2D A two-dimensional Cartesian coordinate reference system with column, row axes.

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultImageCRS(ImageCRS crs)
Constructs a new image CRS with the same values than the specified one.

DefaultImageCRS(Map<String,?> properties, ImageDatum datum, AffineCS cs)
Constructs an image CRS from a set of properties.

DefaultImageCRS(String name, ImageDatum datum, AffineCS cs)
Constructs an image CRS from a name.

Method Summary

AffineCS	getCoordinateSystem() Returns the coordinate system.
ImageDatum	getDatum() Returns the datum.
static DefaultImageCRS	wrap(ImageCRS object) Returns a Geotk CRS implementation with the same values than the given arbitrary implementation.

Methods inherited from class AbstractSingleCRS

computeHashCode, equals, getAxis, getDimension

Methods inherited from class AbstractCRS

distance, formatWKT

Methods inherited from class AbstractReferenceSystem

getDomainOfValidity, getScope

Methods inherited from class AbstractIdentifiedObject

equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, hashCode, nameMatches, nameMatches, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ReferenceSystem

getDomainOfValidity, getScope

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

GRID_2D

public static final DefaultImageCRS GRID_2D

A two-dimensional Cartesian coordinate reference system with column, row axes. By default, this CRS has no transformation path to any other CRS (i.e. a map using this CS can't be reprojected to a geographic coordinate reference system for example).

The PixelInCell attribute of the associated ImageDatum is set to CELL_CENTER.

Since:

3.09

Constructor Detail

DefaultImageCRS

public DefaultImageCRS(ImageCRS crs)

Constructs a new image CRS with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotk 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:

crs - The coordinate reference system to copy.

Since:

2.2

DefaultImageCRS

public DefaultImageCRS(String name,
                       ImageDatum datum,
                       AffineCS cs)

Constructs an image CRS from a name.

Parameters:

name - The name.

datum - The datum.

cs - The coordinate system.

DefaultImageCRS

public DefaultImageCRS(Map<String,?> properties,
                       ImageDatum datum,
                       AffineCS cs)

Constructs an image CRS from a set of properties. The properties are given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

datum - The datum.

cs - The coordinate system.

Method Detail

wrap

public static DefaultImageCRS wrap(ImageCRS object)

Returns a Geotk CRS implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object.

Parameters:

object - The object to wrap in a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getCoordinateSystem

public AffineCS getCoordinateSystem()

Returns the coordinate system.

Specified by:

getCoordinateSystem in interface CoordinateReferenceSystem

Specified by:

getCoordinateSystem in interface ImageCRS

Specified by:

getCoordinateSystem in interface SingleCRS

Overrides:

getCoordinateSystem in class AbstractCRS

getDatum

public ImageDatum getDatum()

Returns the datum.

Specified by:

getDatum in interface ImageCRS

Specified by:

getDatum in interface SingleCRS

Overrides:

getDatum in class AbstractSingleCRS

Returns:

The datum.