org.geotools.referencing.cs

Class DefaultCartesianCS

Object

Formattable

AbstractIdentifiedObject

AbstractCS

DefaultAffineCS

DefaultCartesianCS

All Implemented Interfaces:

Serializable, AffineCS, CartesianCS, CoordinateSystem, IdentifiedObject

public class DefaultCartesianCS
extends DefaultAffineCS
implements CartesianCS

A 1-, 2-, or 3-dimensional coordinate system. Gives the position of points relative to orthogonal straight axes in the 2- and 3-dimensional cases. In the 1-dimensional case, it contains a single straight coordinate axis. In the multi-dimensional case, all axes shall have the same length unit of measure. A CartesianCS shall have one, two, or three axis.

Used with CRS type(s)
Geocentric, Projected, Engineering, Image

Since:

2.1

Author:

Martin Desruisseaux (IRD)

See Also:

DefaultAffineCS, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultCartesianCS	DISPLAY A two-dimensional cartesian CS with display x, display y axis.
static DefaultCartesianCS	GENERIC_2D A two-dimensional cartesian CS with x, y axis in metres.
static DefaultCartesianCS	GENERIC_3D A three-dimensional cartesian CS with x, y, z axis in metres.
static DefaultCartesianCS	GEOCENTRIC A three-dimensional cartesian CS with geocentric x, y, z axis in metres.
static DefaultCartesianCS	GRID A two-dimensional cartesian CS with column, row axis.
static DefaultCartesianCS	PROJECTED A two-dimensional cartesian CS with Easting, Northing axis in metres.

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from class Formattable

SINGLE_LINE

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultCartesianCS(CartesianCS cs) Constructs a new coordinate system with the same values than the specified one.
DefaultCartesianCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1) Constructs a two-dimensional coordinate system from a set of properties.
DefaultCartesianCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2) Constructs a three-dimensional coordinate system from a set of properties.
DefaultCartesianCS(String name, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1) Constructs a two-dimensional coordinate system from a name.
DefaultCartesianCS(String name, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2) Constructs a three-dimensional coordinate system from a name.

Method Summary

Modifier and Type	Method and Description
Measure	distance(double[] coord1, double[] coord2) Computes the distance between two points.
DefaultCartesianCS	usingUnit(Unit<?> unit) Returns a new coordinate system with the same properties than the current one except for axis units.

Methods inherited from class DefaultAffineCS

isCompatibleDirection, isCompatibleUnit

Methods inherited from class AbstractCS

equals, formatWKT, getAxis, getDimension, hashCode, standard, swapAndScaleAxis

Methods inherited from class AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatches

Methods inherited from class Formattable

cleanupThreadLocals, toString, toWKT, toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface CoordinateSystem

getAxis, getDimension

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

PROJECTED

public static DefaultCartesianCS PROJECTED

A two-dimensional cartesian CS with Easting, Northing axis in metres.

GEOCENTRIC

public static DefaultCartesianCS GEOCENTRIC

A three-dimensional cartesian CS with geocentric x, y, z axis in metres.

See Also:

DefaultSphericalCS.GEOCENTRIC

GENERIC_2D

public static DefaultCartesianCS GENERIC_2D

A two-dimensional cartesian CS with x, y axis in metres.

GENERIC_3D

public static DefaultCartesianCS GENERIC_3D

A three-dimensional cartesian CS with x, y, z axis in metres.

GRID

public static DefaultCartesianCS GRID

A two-dimensional cartesian CS with column, row axis.

DISPLAY

public static DefaultCartesianCS DISPLAY

A two-dimensional cartesian CS with display x, display y axis.

Since:

2.2

Constructor Detail

DefaultCartesianCS

public DefaultCartesianCS(CartesianCS cs)

Constructs a new coordinate system 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:

cs - The coordinate system to copy.

Since:

2.2

DefaultCartesianCS

public DefaultCartesianCS(String name,
                          CoordinateSystemAxis axis0,
                          CoordinateSystemAxis axis1)

Constructs a two-dimensional coordinate system from a name.

Parameters:

name - The coordinate system name.

axis0 - The first axis.

axis1 - The second axis.

DefaultCartesianCS

public DefaultCartesianCS(String name,
                          CoordinateSystemAxis axis0,
                          CoordinateSystemAxis axis1,
                          CoordinateSystemAxis axis2)

Constructs a three-dimensional coordinate system from a name.

Parameters:

name - The coordinate system name.

axis0 - The first axis.

axis1 - The second axis.

axis2 - The third axis.

DefaultCartesianCS

public DefaultCartesianCS(Map<String,?> properties,
                          CoordinateSystemAxis axis0,
                          CoordinateSystemAxis axis1)

Constructs a two-dimensional coordinate system 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".

axis0 - The first axis.

axis1 - The second axis.

DefaultCartesianCS

public DefaultCartesianCS(Map<String,?> properties,
                          CoordinateSystemAxis axis0,
                          CoordinateSystemAxis axis1,
                          CoordinateSystemAxis axis2)

Constructs a three-dimensional coordinate system 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".

axis0 - The first axis.

axis1 - The second axis.

axis2 - The third axis.

Method Detail

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws MismatchedDimensionException

Computes the distance between two points.

Overrides:

distance in class AbstractCS

Parameters:

coord1 - Coordinates of the first point.

coord2 - Coordinates of the second point.

Returns:

The distance between coord1 and coord2.

Throws:

MismatchedDimensionException - if a coordinate doesn't have the expected dimension.

usingUnit

public DefaultCartesianCS usingUnit(Unit<?> unit)
                             throws IllegalArgumentException

Returns a new coordinate system with the same properties than the current one except for axis units.

Parameters:

unit - The unit for the new axis.

Returns:

A coordinate system with axis using the specified units.

Throws:

IllegalArgumentException - If the specified unit is incompatible with the expected one.

Since:

2.2