org.geotools.referencing.cs
Class DefaultCartesianCS

java.lang.Object
  extended byorg.geotools.referencing.wkt.Formattable
      extended byorg.geotools.referencing.AbstractIdentifiedObject
          extended byorg.geotools.referencing.cs.AbstractCS
              extended byorg.geotools.referencing.cs.DefaultAffineCS
                  extended byorg.geotools.referencing.cs.DefaultCartesianCS
All Implemented Interfaces:
org.opengis.referencing.cs.AffineCS, org.opengis.referencing.cs.CartesianCS, org.opengis.referencing.cs.CoordinateSystem, org.opengis.referencing.IdentifiedObject, java.io.Serializable

public class DefaultCartesianCS
extends DefaultAffineCS
implements org.opengis.referencing.cs.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 shall have one, two, or three axis.

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

Since:
2.1
Version:
$Id: DefaultCartesianCS.java 17673 2006-01-19 04:34:34Z desruisseaux $
Author:
Martin Desruisseaux
See Also:
DefaultAffineCS, Serialized Form

Field Summary
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 org.geotools.referencing.AbstractIdentifiedObject
EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR
 
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
 
Constructor Summary
DefaultCartesianCS(org.opengis.referencing.cs.CartesianCS cs)
          Constructs a new coordinate system with the same values than the specified one.
DefaultCartesianCS(java.util.Map properties, org.opengis.referencing.cs.CoordinateSystemAxis axis0, org.opengis.referencing.cs.CoordinateSystemAxis axis1)
          Constructs a two-dimensional coordinate system from a set of properties.
DefaultCartesianCS(java.util.Map properties, org.opengis.referencing.cs.CoordinateSystemAxis axis0, org.opengis.referencing.cs.CoordinateSystemAxis axis1, org.opengis.referencing.cs.CoordinateSystemAxis axis2)
          Constructs a three-dimensional coordinate system from a set of properties.
DefaultCartesianCS(java.lang.String name, org.opengis.referencing.cs.CoordinateSystemAxis axis0, org.opengis.referencing.cs.CoordinateSystemAxis axis1)
          Constructs a two-dimensional coordinate system from a name.
DefaultCartesianCS(java.lang.String name, org.opengis.referencing.cs.CoordinateSystemAxis axis0, org.opengis.referencing.cs.CoordinateSystemAxis axis1, org.opengis.referencing.cs.CoordinateSystemAxis axis2)
          Constructs a three-dimensional coordinate system from a name.
 
Method Summary
 Measure distance(double[] coord1, double[] coord2)
          Computes the distance between two points.
 DefaultCartesianCS usingUnit(javax.units.Unit unit)
          Returns a new coordinate system with the same properties than the current one except for axis units.
 
Methods inherited from class org.geotools.referencing.cs.DefaultAffineCS
isCompatibleDirection, isCompatibleUnit
 
Methods inherited from class org.geotools.referencing.cs.AbstractCS
equals, formatWKT, getAxis, getDimension, hashCode, standard, swapAndScaleAxis
 
Methods inherited from class org.geotools.referencing.AbstractIdentifiedObject
asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches
 
Methods inherited from class org.geotools.referencing.wkt.Formattable
toString, toWKT, toWKT, toWKT
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.opengis.referencing.cs.CoordinateSystem
getAxis, getDimension
 
Methods inherited from interface org.opengis.referencing.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(org.opengis.referencing.cs.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.

Since:
2.2

DefaultCartesianCS

public DefaultCartesianCS(java.lang.String name,
                          org.opengis.referencing.cs.CoordinateSystemAxis axis0,
                          org.opengis.referencing.cs.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(java.lang.String name,
                          org.opengis.referencing.cs.CoordinateSystemAxis axis0,
                          org.opengis.referencing.cs.CoordinateSystemAxis axis1,
                          org.opengis.referencing.cs.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(java.util.Map properties,
                          org.opengis.referencing.cs.CoordinateSystemAxis axis0,
                          org.opengis.referencing.cs.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(java.util.Map properties,
                          org.opengis.referencing.cs.CoordinateSystemAxis axis0,
                          org.opengis.referencing.cs.CoordinateSystemAxis axis1,
                          org.opengis.referencing.cs.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 org.opengis.spatialschema.geometry.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 and .
Throws:
org.opengis.spatialschema.geometry.MismatchedDimensionException - if a coordinate doesn't have the expected dimension.

usingUnit

public DefaultCartesianCS usingUnit(javax.units.Unit unit)
                             throws java.lang.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:
java.lang.IllegalArgumentException - If the specified unit is incompatible with the expected one.
Since:
2.2


Copyright © GeoTools. All Rights Reserved.