* NOTE:Serialization of this class is appropriate for short-term storage
* or RMI use, but will probably not be compatible with future version. For long term storage,
* WKT (Well Know Text) or XML (not yet implemented) are more appropriate.
*
* @since 2.0
* @version $Id$
*
*
* @source $URL$
* @author André Gosselin
* @author Martin Desruisseaux (PMO, IRD)
* @author Rueben Schulz
*
* @see Map projections on MathWorld
* @see Map projections on the atlas of Canada
* @tutorial http://www.geotools.org/display/GEOTOOLS/How+to+add+new+projections
*/
public abstract class MapProjection extends AbstractMathTransform
implements MathTransform2D, Serializable
{
/**
* For cross-version compatibility.
*/
private static final long serialVersionUID = -406751619777246914L;
/**
* The projection package logger
*/
protected static final Logger LOGGER = Logging.getLogger(MapProjection.class);
/**
* Maximum difference allowed when comparing real numbers.
* This field is private because subclasses may use different threshold value.
*/
private static final double EPSILON = 1E-6;
/**
* Maximum difference allowed when comparing longitudes or latitudes in degrees.
* This tolerance do not apply to angle in radians. A tolerance of 1E-4 is about
* 10 kilometers.
*/
private static final double ANGLE_TOLERANCE = 1E-4;
/**
* Difference allowed in iterative computations.
*/
private static final double ITERATION_TOLERANCE = 1E-10;
/**
* Relative iteration precision used in the
* Consider this field as final. It is not final only
* because some classes need to modify it at construction time.
*/
protected double centralMeridian;
/**
* Latitude of origin in radians. Default value is 0, the equator.
* This is called 'phi0' in Snyder.
*
* Consider this field as final. It is not final only
* because some classes need to modify it at construction time.
*/
protected double latitudeOfOrigin;
/**
* The scale factor. Default value is 1. Named 'k' in Snyder.
*
* Consider this field as final. It is not final only
* because some classes need to modify it at construction time.
*/
protected double scaleFactor;
/**
* False easting, in metres. Default value is 0.
*/
protected final double falseEasting;
/**
* False northing, in metres. Default value is 0.
*/
protected final double falseNorthing;
/**
* Global scale factor. Default value {@code globalScale} is equal
* to {@link #semiMajor}×{@link #scaleFactor}.
*
* Consider this field as final. It is not final only
* because some classes need to modify it at construction time.
*/
protected double globalScale;
/**
* The inverse of this map projection. Will be created only when needed.
*/
private transient MathTransform2D inverse;
/**
* Constant needed for the
* This method is not public because it is not a very elegant hack, and a work around exists.
* For example {@code ObliqueMercator} two-points case could be implemented by as a separated
* classes, in which case {@link #getParameterDescriptors} returns a constant and can be safely
* invoked in a constructor.
*/
MapProjection(final ParameterValueGroup values, Collection
* Note: this method ignores the longitude if the latitude is
* at a pole, because in such case the longitude is meanless.
*
* @param longitude The longitude computed by spherical formulas, in radians.
* @param latitude The latitude computed by spherical formulas, in radians.
* @param expected The (longitude,latitude) computed by ellipsoidal formulas.
* @param tolerance The tolerance (optional).
*/
static boolean checkInverseTransform(final double longitude, final double latitude,
final Point2D expected, final double tolerance)
{
compare("latitude", expected.getY(), latitude, tolerance);
if (abs(PI/2 - abs(latitude)) > EPSILON) {
compare("longitude", expected.getX(), longitude, tolerance);
}
return tolerance < Double.POSITIVE_INFINITY;
}
/**
* Default version of {@link #checkInverseTransform(double,double,Point2D,double)}.
*/
static boolean checkInverseTransform(double longitude, double latitude, Point2D expected) {
return checkInverseTransform(longitude, latitude, expected, EPSILON);
}
/**
* Compares two value for equality up to some tolerance threshold. This is used during
* assertions only. The comparaison do not fails if at least one value to compare is
* {@link Double#NaN}.
*
* Hack: if the {@code variable} name starts by lower-case {@code L}
* (as in "longitude" and "latitude"), then the value is assumed to be an angle in
* radians. This is used for formatting an error message, if needed.
*/
private static void compare(String variable, double expected, double actual, double tolerance) {
if (abs(expected - actual) > tolerance) {
if (variable.charAt(0) == 'l') {
actual = toDegrees(actual);
expected = toDegrees(expected);
}
throw new AssertionError(Errors.format(ErrorKeys.TEST_FAILURE_$3, variable, expected, actual));
}
}
/**
* Transforms the specified coordinate and stores the result in {@code ptDst}. This method
* returns longitude as x values in the range {@code [-PI..PI]} and latitude as
* y values in the range {@code [-PI/2..PI/2]}. It will be checked by the caller,
* so this method doesn't need to performs this check.
*
* Input coordinates have the {@link #falseEasting} and {@link #falseNorthing} removed and are
* divided by {@link #globalScale} before this method is invoked. After this method is invoked,
* the {@link #centralMeridian} is added to the {@code x} results in {@code ptDst}. This means
* that projections that implement this method are performed on an ellipse (or sphere) with a
* semi-major axis of 1.
*
* In PROJ.4, the same standardization,
* described above, is handled by {@code pj_inv.c}. Therefore when porting projections
* from PROJ.4, the inverse transform equations can be used directly here with minimal
* change. In the equations of Snyder, {@link #falseEasting}, {@link #falseNorthing} and
* {@link #scaleFactor} are usually not given. When implementing these equations here, you
* will not need to add the {@link #centralMeridian} to the output longitude or remove the
* {@link #semiMajor} (a or R).
*
* @param x The easting of the coordinate, linear distance on a unit sphere or ellipse.
* @param y The northing of the coordinate, linear distance on a unit sphere or ellipse.
* @param ptDst the specified coordinate point that stores the result of transforming
* {@code ptSrc}, or {@code null}. Ordinates will be in radians.
* @return the coordinate point after transforming {@code x}, {@code y}
* and storing the result in {@code ptDst}.
* @throws ProjectionException if the point can't be transformed.
*/
protected abstract Point2D inverseTransformNormalized(double x, double y, final Point2D ptDst)
throws ProjectionException;
/**
* Transforms the specified coordinate and stores the result in {@code ptDst}. This method is
* usually (but not guaranteed) to be invoked with values of x in
* the range {@code [-PI..PI]} and values of y in the range {@code [-PI/2..PI/2]}.
* Values outside those ranges are accepted (sometime with a warning logged) on the assumption
* that most implementations use those values only in trigonometric functions like
* {@linkplain Math#sin sin} and {@linkplain Math#cos cos}.
*
* Coordinates have the {@link #centralMeridian} removed from lambda before this
* method is invoked. After this method is invoked, the results in {@code ptDst} are multiplied
* by {@link #globalScale}, and the {@link #falseEasting} and {@link #falseNorthing} are added.
* This means that projections that implement this method are performed on an ellipse (or sphere)
* with a semi-major axis of 1.
*
* In PROJ.4, the same standardization,
* described above, is handled by {@code pj_fwd.c}. Therefore when porting projections
* from PROJ.4, the forward transform equations can be used directly here with minimal
* change. In the equations of Snyder, {@link #falseEasting}, {@link #falseNorthing} and
* {@link #scaleFactor} are usually not given. When implementing these equations here,
* you will not need to remove the {@link #centralMeridian} from lambda or apply
* the {@link #semiMajor} (a or R).
*
* @param lambda The longitude of the coordinate, in radians.
* @param phi The latitude of the coordinate, in radians.
* @param ptDst the specified coordinate point that stores the result of transforming
* {@code ptSrc}, or {@code null}. Ordinates will be in a
* dimensionless unit, as a linear distance on a unit sphere or ellipse.
* @return the coordinate point after transforming ({@code lambda}, {@code phi})
* and storing the result in {@code ptDst}.
* @throws ProjectionException if the point can't be transformed.
*/
protected abstract Point2D transformNormalized(double lambda, double phi, final Point2D ptDst)
throws ProjectionException;
/**
* Transforms the specified {@code ptSrc} and stores the result in {@code ptDst}.
*
* This method standardizes the source {@code x} coordinate
* by removing the {@link #centralMeridian}, before invoking
*
* This method standardizes the {@code ptSrc} by removing the {@link #falseEasting}
* and {@link #falseNorthing} and dividing by {@link #globalScale} before invoking
*
* To avoid excessive logging, this flag will be set to {@code false} after the first
* coordinate failing the checks is found.
*/
final boolean verifyCoordinateRanges() {
/*
* Do not synchronize - doing so would be a major bottleneck since this method will be
* invoked thousands of time. The consequence is that a call to {@link #resetWarnings}
* may not be reflected immediately in other threads, but the later is defined only on
* a "best effort" basis.
*/
return rangeCheckSemaphore != globalRangeCheckSemaphore;
}
/**
* To be invoked after a warning in order to disable subsequent warnings.
*/
final void warningLogged() {
synchronized (MapProjection.class) {
rangeCheckSemaphore = globalRangeCheckSemaphore;
}
}
/**
* Resets the warning status of all projections in the current JVM. Every {@link MapProjection}
* instance may log a warning the first time they are given coordinates outside their area of
* validity. Subsequent coordinates outside the area of validity are silently projected in order
* to avoid flowing the log with warnings. In case of suspicion, this method may be invoked in
* order to force all projections to log again their first out-of-bounds coordinates.
*
* Multi-threadingmlfn method
*/
private static final double MLFN_TOL = 1E-11;
/**
* Maximum number of iterations for iterative computations.
*/
private static final int MAXIMUM_ITERATIONS = 15;
/**
* Constants used to calculate {@link #en0}, {@link #en1},
* {@link #en2}, {@link #en3}, {@link #en4}.
*/
private static final double C00= 1.0,
C02= 0.25,
C04= 0.046875,
C06= 0.01953125,
C08= 0.01068115234375,
C22= 0.75,
C44= 0.46875,
C46= 0.01302083333333333333,
C48= 0.00712076822916666666,
C66= 0.36458333333333333333,
C68= 0.00569661458333333333,
C88= 0.3076171875;
/**
* Ellipsoid excentricity, equals to sqrt({@link #excentricitySquared}).
* Value 0 means that the ellipsoid is spherical.
*
* @see #excentricitySquared
* @see #isSpherical
*/
protected final double excentricity;
/**
* The square of excentricity: e² = (a²-b²)/a² where
* e is the {@linkplain #excentricity excentricity},
* a is the {@linkplain #semiMajor semi major} axis length and
* b is the {@linkplain #semiMinor semi minor} axis length.
*
* @see #excentricity
* @see #semiMajor
* @see #semiMinor
* @see #isSpherical
*/
protected final double excentricitySquared;
/**
* {@code true} if this projection is spherical. Spherical model has identical
* {@linkplain #semiMajor semi major} and {@linkplain #semiMinor semi minor} axis
* length, and an {@linkplain #excentricity excentricity} zero.
*
* @see #excentricity
* @see #semiMajor
* @see #semiMinor
*/
protected final boolean isSpherical;
/**
* Length of semi-major axis, in metres. This is named 'a' or 'R'
* (Radius in spherical cases) in Snyder.
*
* @see #excentricity
* @see #semiMinor
*/
protected final double semiMajor;
/**
* Length of semi-minor axis, in metres. This is named 'b' in Snyder.
*
* @see #excentricity
* @see #semiMajor
*/
protected final double semiMinor;
/**
* Central longitude in radians. Default value is 0, the Greenwich meridian.
* This is called 'lambda0' in Snyder.
* mlfn method.
* Setup at construction time.
*/
protected double en0,en1,en2,en3,en4;
/**
* When different than {@link #globalRangeCheckSemaphore}, coordinate ranges will be
* checked and a {@code WARNING} log will be issued if they are out of their natural
* ranges (-180/180° for longitude, -90/90° for latitude).
*
* @see #verifyCoordinateRanges()
* @see #warningLogged()
*/
private transient int rangeCheckSemaphore;
/**
* The value to be checked against {@link #rangeCheckSemaphore} in order to determine
* if coordinates ranges should be checked.
*/
private static int globalRangeCheckSemaphore = 1;
/**
* Marks if the projection is invertible. The vast majority is, subclasses can override.
*/
protected boolean invertible = true;
/**
* Constructs a new map projection from the suplied parameters.
*
* @param values The parameter values in standard units.
* The following parameter are recognized:
* needed for the true scale
* latitude (Snyder 14-15), where s and c are the sine and cosine of
* the true scale latitude, and e² is the {@linkplain #excentricitySquared
* eccentricity squared}.
*/
final double msfn(final double s, final double c) {
return c / sqrt(1.0 - (s*s) * excentricitySquared);
}
/**
* Computes function (15-9) and (9-13) from Snyder.
* Equivalent to negative of function (7-7).
*/
final double tsfn(final double phi, double sinphi) {
sinphi *= excentricity;
/*
* NOTE: change sign to get the equivalent of Snyder (7-7).
*/
return tan(0.5 * (PI/2 - phi)) / pow((1 - sinphi) / (1 + sinphi), 0.5*excentricity);
}
/**
* Calculates the meridian distance. This is the distance along the central
* meridian from the equator to {@code phi}. Accurate to < 1e-5 meters
* when used in conjuction with typical major axis values.
*
* @param phi latitude to calculate meridian distance for.
* @param sphi sin(phi).
* @param cphi cos(phi).
* @return meridian distance for the given latitude.
*/
protected final double mlfn(final double phi, double sphi, double cphi) {
cphi *= sphi;
sphi *= sphi;
return en0 * phi - cphi *
(en1 + sphi *
(en2 + sphi *
(en3 + sphi *
(en4))));
}
/**
* Calculates the latitude ({@code phi}) from a meridian distance.
* Determines phi to TOL (1e-11) radians, about 1e-6 seconds.
*
* @param arg meridian distance to calulate latitude for.
* @return the latitude of the meridian distance.
* @throws ProjectionException if the itteration does not converge.
*/
protected final double inv_mlfn(double arg) throws ProjectionException {
double s, t, phi, k = 1.0/(1.0 - excentricitySquared);
int i;
phi = arg;
for (i=MAXIMUM_ITERATIONS; true;) { // rarely goes over 5 iterations
if (--i < 0) {
throw new ProjectionException(Errors.format(ErrorKeys.NO_CONVERGENCE));
}
s = Math.sin(phi);
t = 1.0 - excentricitySquared * s * s;
t = (mlfn(phi, s, Math.cos(phi)) - arg) * (t * Math.sqrt(t)) * k;
phi -= t;
if (Math.abs(t) < MLFN_TOL) {
return phi;
}
}
}
/**
* Tolerant asin that will just return the limits of its output range if the input is out of range
* @param v
* @return
*/
double aasin(double v) {
double av = abs(v);
if (av >= 1.) {
return (v < 0. ? -PI / 2: PI / 2);
}
return asin(v);
}
//////////////////////////////////////////////////////////////////////////////////////////
//////// ////////
//////// PROVIDER ////////
//////// ////////
//////////////////////////////////////////////////////////////////////////////////////////
/**
* The base provider for {@link MapProjection}s.
*
* @version $Id$
* @author Martin Desruisseaux (PMO, IRD)
*/
public static abstract class AbstractProvider extends MathTransformProvider {
/**
* Serial number for interoperability with different versions.
*/
private static final long serialVersionUID = 6280666068007678702L;
/**
* The operation parameter descriptor for the {@linkplain #semiMajor semi major} parameter
* value. Valid values range is from 0 to infinity. This parameter is mandatory.
*
* @todo Would like to start range from 0 exclusive.
*/
public static final ParameterDescriptor SEMI_MAJOR = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "semi_major"),
new NamedIdentifier(Citations.EPSG, "semi-major axis")
// EPSG does not specifically define the above parameter
},
Double.NaN, 0, Double.POSITIVE_INFINITY, SI.METER);
/**
* The operation parameter descriptor for the {@linkplain #semiMinor semi minor} parameter
* value. Valid values range is from 0 to infinity. This parameter is mandatory.
*
* @todo Would like to start range from 0 exclusive.
*/
public static final ParameterDescriptor SEMI_MINOR = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "semi_minor"),
new NamedIdentifier(Citations.EPSG, "semi-minor axis")
// EPSG does not specifically define the above parameter
},
Double.NaN, 0, Double.POSITIVE_INFINITY, SI.METER);
/**
* The operation parameter descriptor for the {@linkplain #centralMeridian central meridian}
* parameter value. Valid values range is from -180 to 180°. Default value is 0.
*/
public static final ParameterDescriptor CENTRAL_MERIDIAN = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "central_meridian"),
new NamedIdentifier(Citations.EPSG, "Longitude of natural origin"),
new NamedIdentifier(Citations.EPSG, "Longitude of false origin"),
new NamedIdentifier(Citations.EPSG, "Longitude of origin"),
new NamedIdentifier(Citations.ESRI, "Longitude_Of_Center"),
new NamedIdentifier(Citations.ESRI, "longitude_of_center"),
new NamedIdentifier(Citations.ESRI, "Longitude_Of_Origin"),
new NamedIdentifier(Citations.ESRI, "longitude_of_origin"),
new NamedIdentifier(Citations.GEOTIFF, "NatOriginLong")
// ESRI uses "Longitude_Of_Origin" in orthographic (not to
// be confused with "Longitude_Of_Center" in oblique mercator).
},
0, -180, 180, NonSI.DEGREE_ANGLE);
/**
* The operation parameter descriptor for the {@linkplain #latitudeOfOrigin latitude of origin}
* parameter value. Valid values range is from -90 to 90°. Default value is 0.
*/
public static final ParameterDescriptor LATITUDE_OF_ORIGIN = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "latitude_of_origin"),
new NamedIdentifier(Citations.EPSG, "Latitude of false origin"),
new NamedIdentifier(Citations.EPSG, "Latitude of natural origin"),
new NamedIdentifier(Citations.ESRI, "Latitude_Of_Origin"),
new NamedIdentifier(Citations.ESRI, "latitude_of_origin"),
new NamedIdentifier(Citations.ESRI, "Latitude_Of_Center"),
new NamedIdentifier(Citations.ESRI, "latitude_of_center"),
new NamedIdentifier(Citations.GEOTIFF, "NatOriginLat")
// ESRI uses "Latitude_Of_Center" in orthographic.
},
0, -90, 90, NonSI.DEGREE_ANGLE);
/**
* The operation parameter descriptor for the standard parallel 1 parameter value.
* Valid values range is from -90 to 90°. Default value is 0.
*/
public static final ParameterDescriptor STANDARD_PARALLEL_1 = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "standard_parallel_1"),
new NamedIdentifier(Citations.EPSG, "Latitude of 1st standard parallel"),
new NamedIdentifier(Citations.ESRI, "Standard_Parallel_1"),
new NamedIdentifier(Citations.ESRI, "standard_parallel_1"),
new NamedIdentifier(Citations.GEOTIFF, "StdParallel1")
},
0, -90, 90, NonSI.DEGREE_ANGLE);
/**
* The operation parameter descriptor for the standard parallel 2 parameter value.
* Valid values range is from -90 to 90°. Default value is 0.
*/
public static final ParameterDescriptor STANDARD_PARALLEL_2 = createOptionalDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "standard_parallel_2"),
new NamedIdentifier(Citations.EPSG, "Latitude of 2nd standard parallel"),
new NamedIdentifier(Citations.ESRI, "Standard_Parallel_2"),
new NamedIdentifier(Citations.ESRI, "standard_parallel_2"),
new NamedIdentifier(Citations.GEOTIFF, "StdParallel2")
},
-90, 90, NonSI.DEGREE_ANGLE);
/**
* The operation parameter descriptor for the {@link #scaleFactor scaleFactor}
* parameter value. Valid values range is from 0 to infinity. Default value is 1.
*
* @todo Would like to start range from 0 exclusive.
*/
public static final ParameterDescriptor SCALE_FACTOR = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "scale_factor"),
new NamedIdentifier(Citations.EPSG, "Scale factor at natural origin"),
new NamedIdentifier(Citations.EPSG, "Scale factor on initial line"),
new NamedIdentifier(Citations.GEOTIFF, "ScaleAtNatOrigin"),
new NamedIdentifier(Citations.GEOTIFF, "ScaleAtCenter"),
new NamedIdentifier(Citations.ESRI, "Scale_Factor"),
new NamedIdentifier(Citations.ESRI, "scale_factor"),
},
1, 0, Double.POSITIVE_INFINITY, Unit.ONE);
/**
* The operation parameter descriptor for the {@link #falseEasting falseEasting}
* parameter value. Valid values range is unrestricted. Default value is 0.
*/
public static final ParameterDescriptor FALSE_EASTING = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "false_easting"),
new NamedIdentifier(Citations.EPSG, "False easting"),
new NamedIdentifier(Citations.EPSG, "Easting at false origin"),
new NamedIdentifier(Citations.EPSG, "Easting at projection centre"),
new NamedIdentifier(Citations.GEOTIFF, "FalseEasting"),
new NamedIdentifier(Citations.ESRI, "False_Easting")
},
0, Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY, SI.METER);
/**
* The operation parameter descriptor for the {@link #falseNorthing falseNorthing}
* parameter value. Valid values range is unrestricted. Default value is 0.
*/
public static final ParameterDescriptor FALSE_NORTHING = createDescriptor(
new NamedIdentifier[] {
new NamedIdentifier(Citations.OGC, "false_northing"),
new NamedIdentifier(Citations.EPSG, "False northing"),
new NamedIdentifier(Citations.EPSG, "Northing at false origin"),
new NamedIdentifier(Citations.EPSG, "Northing at projection centre"),
new NamedIdentifier(Citations.GEOTIFF, "FalseNorthing"),
new NamedIdentifier(Citations.ESRI, "False_Northing"),
new NamedIdentifier(Citations.ESRI, "false_northing")
},
0, Double.NEGATIVE_INFINITY, Double.POSITIVE_INFINITY, SI.METER);
/**
* Constructs a math transform provider from a set of parameters. The provider
* {@linkplain #getIdentifiers identifiers} will be the same than the parameter
* ones.
*
* @param parameters The set of parameters (never {@code null}).
*/
public AbstractProvider(final ParameterDescriptorGroup parameters) {
super(2, 2, parameters);
}
/**
* Returns the operation type for this map projection.
*/
@Override
public Class getOperationType() {
return Projection.class;
}
/**
* Returns {@code true} is the parameters use a spherical datum.
*/
static boolean isSpherical(final ParameterValueGroup values) {
try {
return doubleValue(SEMI_MAJOR, values) == doubleValue(SEMI_MINOR, values);
} catch (IllegalStateException exception) {
// Probably could not find the requested values -- gobble error and be forgiving.
// The error will probably be thrown at MapProjection construction time, which is
// less surprising to some users.
return false;
}
}
/**
* Returns the parameter value for the specified operation parameter in standard units.
* Values are automatically converted into the standard units specified by the supplied
* {@code param} argument, except {@link NonSI#DEGREE_ANGLE degrees} which are converted
* to {@link SI#RADIAN radians}. This conversion is performed because the radians units
* are standard for all internal computations in the map projection package. For example
* they are the standard units for {@link MapProjection#latitudeOfOrigin latitudeOfOrigin}
* and {@link MapProjection#centralMeridian centralMeridian} fields in the
* {@link MapProjection} class.
*
* @param param The parameter to look for.
* @param group The parameter value group to search into.
* @return The requested parameter value.
* @throws ParameterNotFoundException if the parameter is not found.
*/
protected static double doubleValue(final ParameterDescriptor param,
final ParameterValueGroup group)
throws ParameterNotFoundException
{
double v = MathTransformProvider.doubleValue(param, group);
if (NonSI.DEGREE_ANGLE.equals(param.getUnit())) {
v = toRadians(v);
}
return v;
}
}
}
*
* @throws ParameterNotFoundException if a mandatory parameter is missing.
*/
protected MapProjection(final ParameterValueGroup values) throws ParameterNotFoundException {
this(values, null);
}
/**
* Constructor invoked by sub-classes when we can't rely on {@link #getParameterDescriptors}
* before the construction is completed. This is the case when the later method depends on
* the value of some class's attribute, which has not yet been set. An example is
* {@link ObliqueMercator#getParameterDescriptors}.
* {@link #transformNormalized transformNormalized}(x, y, ptDst).
* It also multiplies by {@link #globalScale} and adds the {@link #falseEasting} and
* {@link #falseNorthing} to the point returned by the {@code transformNormalized(...)} call.
*
* @param ptSrc the specified coordinate point to be transformed.
* Ordinates must be in decimal degrees.
* @param ptDst the specified coordinate point that stores the result of transforming
* {@code ptSrc}, or {@code null}. Ordinates will be in metres.
* @return the coordinate point after transforming {@code ptSrc} and storing
* the result in {@code ptDst}.
* @throws ProjectionException if the point can't be transformed.
*/
@Override
public final Point2D transform(final Point2D ptSrc, Point2D ptDst) throws ProjectionException {
final double x = ptSrc.getX();
final double y = ptSrc.getY();
if (verifyCoordinateRanges()) {
if (verifyGeographicRanges(this, x, y)) {
warningLogged();
}
}
/*
* Makes sure that the longitude before conversion stay within +/- PI radians. As a
* special case, we do not check the range if no rotation were applied on the longitude.
* This is because the user may have a big area ranging from -180° to +180°. With the
* slight rounding errors related to map projections, the 180° longitude may be slightly
* over the limit. Rolling the longitude would changes its sign. For example a bounding
* box from 30° to +180° would become 30° to -180°, which is probably not what the user
* wanted.
*/
ptDst = transformNormalized(centralMeridian != 0 ?
rollLongitude(toRadians(x) - centralMeridian) : toRadians(x), toRadians(y), ptDst);
ptDst.setLocation(globalScale*ptDst.getX() + falseEasting,
globalScale*ptDst.getY() + falseNorthing);
if(invertible) {
assert checkReciprocal(ptDst, (ptSrc!=ptDst) ? ptSrc : new Point2D.Double(x,y), true);
}
return ptDst;
}
/**
* Transforms a list of coordinate point ordinal values. Ordinates must be
* (longitude,latitude) pairs in decimal degrees.
*
* @throws ProjectionException if a point can't be transformed. This method tries to transform
* every points even if some of them can't be transformed. Non-transformable points will
* have value {@link Double#NaN}. If more than one point can't be transformed, then this
* exception may be about an arbitrary point.
*/
public final void transform(final double[] srcPts, int srcOff,
final double[] dstPts, int dstOff, int numPts)
throws ProjectionException
{
/*
* Vérifie s'il faudra parcourir le tableau en sens inverse.
* Ce sera le cas si les tableaux source et destination se
* chevauchent et que la destination est après la source.
*/
final boolean reverse = (srcPts == dstPts && srcOff < dstOff &&
srcOff + (2*numPts) > dstOff);
if (reverse) {
srcOff += 2*numPts;
dstOff += 2*numPts;
}
final Point2D.Double point = new Point2D.Double();
ProjectionException firstException = null;
while (--numPts >= 0) {
try {
point.x = srcPts[srcOff++];
point.y = srcPts[srcOff++];
transform(point, point);
dstPts[dstOff++] = point.x;
dstPts[dstOff++] = point.y;
} catch (ProjectionException exception) {
dstPts[dstOff++] = Double.NaN;
dstPts[dstOff++] = Double.NaN;
if (firstException == null) {
firstException = exception;
}
}
if (reverse) {
srcOff -= 4;
dstOff -= 4;
}
}
if (firstException != null) {
throw firstException;
}
}
/**
* Transforms a list of coordinate point ordinal values. Ordinates must be
* (longitude,latitude) pairs in decimal degrees.
*
* @throws ProjectionException if a point can't be transformed. This method tries to transform
* every points even if some of them can't be transformed. Non-transformable points will
* have value {@link Float#NaN}. If more than one point can't be transformed, then this
* exception may be about an arbitrary point.
*/
@Override
public final void transform(final float[] srcPts, int srcOff,
final float[] dstPts, int dstOff, int numPts)
throws ProjectionException
{
final boolean reverse = (srcPts == dstPts && srcOff < dstOff &&
srcOff + (2*numPts) > dstOff);
if (reverse) {
srcOff += 2*numPts;
dstOff += 2*numPts;
}
final Point2D.Double point = new Point2D.Double();
ProjectionException firstException = null;
while (--numPts >= 0) {
try {
point.x = srcPts[srcOff++];
point.y = srcPts[srcOff++];
transform(point, point);
dstPts[dstOff++] = (float) point.x;
dstPts[dstOff++] = (float) point.y;
} catch (ProjectionException exception) {
dstPts[dstOff++] = Float.NaN;
dstPts[dstOff++] = Float.NaN;
if (firstException == null) {
firstException = exception;
}
}
if (reverse) {
srcOff -= 4;
dstOff -= 4;
}
}
if (firstException != null) {
throw firstException;
}
}
/**
* Inverse of a map projection. Will be created by {@link MapProjection#inverse()} only when
* first required. Implementation of {@code transform(...)} methods are mostly identical
* to {@code MapProjection.transform(...)}, except that they will invokes
* {@link MapProjection#inverseTransformNormalized} instead of
* {@link MapProjection#transformNormalized}.
*
* @version $Id$
* @author Martin Desruisseaux (PMO, IRD)
*/
private final class Inverse extends AbstractMathTransform.Inverse implements MathTransform2D {
/**
* For cross-version compatibility.
*/
private static final long serialVersionUID = -9138242780765956870L;
/**
* Default constructor.
*/
public Inverse() {
MapProjection.this.super();
}
/**
* Inverse transforms the specified {@code ptSrc} and stores the result in {@code ptDst}.
* {@link #inverseTransformNormalized inverseTransformNormalized}(x, y, ptDst).
* It then adds the {@link #centralMeridian} to the {@code x} of the point returned by the
* {@code inverseTransformNormalized} call.
*
* @param ptSrc the specified coordinate point to be transformed.
* Ordinates must be in metres.
* @param ptDst the specified coordinate point that stores the result of transforming
* {@code ptSrc}, or {@code null}. Ordinates will be in decimal degrees.
* @return the coordinate point after transforming {@code ptSrc}
* and stroring the result in {@code ptDst}.
* @throws ProjectionException if the point can't be transformed.
*/
@Override
public final Point2D transform(final Point2D ptSrc, Point2D ptDst)
throws ProjectionException
{
final double x0 = ptSrc.getX();
final double y0 = ptSrc.getY();
ptDst = inverseTransformNormalized((x0 - falseEasting ) / globalScale,
(y0 - falseNorthing) / globalScale, ptDst);
/*
* Makes sure that the longitude after conversion stay within +/- PI radians. As a
* special case, we do not check the range if no rotation were applied on the longitude.
* This is because the user may have a big area ranging from -180° to +180°. With the
* slight rounding errors related to map projections, the 180° longitude may be slightly
* over the limit. Rolling the longitude would changes its sign. For example a bounding
* box from 30° to +180° would become 30° to -180°, which is probably not what the user
* wanted.
*/
final double x = toDegrees(centralMeridian != 0 ?
rollLongitude(ptDst.getX() + centralMeridian) : ptDst.getX());
final double y = toDegrees(ptDst.getY());
ptDst.setLocation(x,y);
if (verifyCoordinateRanges()) {
if (verifyGeographicRanges(this, x, y)) {
warningLogged();
}
}
assert checkReciprocal(ptDst, (ptSrc!=ptDst) ? ptSrc : new Point2D.Double(x0, y0), false);
return ptDst;
}
/**
* Inverse transforms a list of coordinate point ordinal values.
* Ordinates must be (x,y) pairs in metres.
*
* @throws ProjectionException if a point can't be transformed. This method tries
* to transform every points even if some of them can't be transformed.
* Non-transformable points will have value {@link Double#NaN}. If more
* than one point can't be transformed, then this exception may be about
* an arbitrary point.
*/
public final void transform(final double[] src, int srcOffset,
final double[] dest, int dstOffset, int numPts)
throws TransformException
{
/*
* Vérifie s'il faudra parcourir le tableau en sens inverse.
* Ce sera le cas si les tableaux source et destination se
* chevauchent et que la destination est après la source.
*/
final boolean reverse = (src==dest && srcOffset
* Calls to this method have immediate effect in the invoker's thread. The effect in other
* threads may be delayed by some arbitrary amount of time. This method works only on a
* "best effort" basis.
*
* @see org.geotools.referencing.CRS#reset
*
* @since 2.5
*/
public static synchronized void resetWarnings() {
globalRangeCheckSemaphore++;
}
//////////////////////////////////////////////////////////////////////////////////////////
//////// ////////
//////// IMPLEMENTATION OF Object AND MathTransform2D STANDARD METHODS ////////
//////// ////////
//////////////////////////////////////////////////////////////////////////////////////////
/**
* Returns a hash value for this map projection.
*/
@Override
public int hashCode() {
long code = Double.doubleToLongBits(semiMajor);
code = code*37 + Double.doubleToLongBits(semiMinor);
code = code*37 + Double.doubleToLongBits(centralMeridian);
code = code*37 + Double.doubleToLongBits(latitudeOfOrigin);
return (int) code ^ (int) (code >>> 32);
}
/**
* Compares the specified object with this map projection for equality.
*/
@Override
public boolean equals(final Object object) {
// Do not check 'object==this' here, since this
// optimization is usually done in subclasses.
if (super.equals(object)) {
final MapProjection that = (MapProjection) object;
return equals(this.semiMajor, that.semiMajor) &&
equals(this.semiMinor, that.semiMinor) &&
equals(this.centralMeridian, that.centralMeridian) &&
equals(this.latitudeOfOrigin, that.latitudeOfOrigin) &&
equals(this.scaleFactor, that.scaleFactor) &&
equals(this.falseEasting, that.falseEasting) &&
equals(this.falseNorthing, that.falseNorthing);
}
return false;
}
/**
* Returns {@code true} if the two specified value are equals.
* Two {@link Double#NaN NaN} values are considered equals.
*/
static boolean equals(final double value1, final double value2) {
return Utilities.equals(value1, value2);
}
//////////////////////////////////////////////////////////////////////////////////////////
//////// ////////
//////// FORMULAS FROM SNYDER ////////
//////// ////////
//////////////////////////////////////////////////////////////////////////////////////////
/**
* Iteratively solve equation (7-9) from Snyder.
*/
final double cphi2(final double ts) throws ProjectionException {
final double eccnth = 0.5 * excentricity;
double phi = (PI/2) - 2.0 * atan(ts);
for (int i=0; i