| gvSIG desktop 1

/*

 *    GeoTools - OpenSource mapping toolkit

 *    http://geotools.org

 *

 *   (C) 2003-2006, Geotools Project Managment Committee (PMC)

 *   (C) 2002, Centre for Computational Geography

 *   (C) 2001, Institut de Recherche pour le Dveloppement

 *   (C) 2000, Frank Warmerdam

 *   (C) 1999, Fisheries and Oceans Canada

 *

 *    This library is free software; you can redistribute it and/or

 *    modify it under the terms of the GNU Lesser General Public

 *    License as published by the Free Software Foundation; either

 *    version 2.1 of the License, or (at your option) any later version.

 *

 *    This library is distributed in the hope that it will be useful,

 *    but WITHOUT ANY WARRANTY; without even the implied warranty of

 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 *    Lesser General Public License for more details.

 *

 *    This package contains formulas from the PROJ package of USGS.

 *    USGS's work is fully acknowledged here. This derived work has

 *    been relicensed under LGPL with Frank Warmerdam's permission.

 */

package org.geotools.referencing.operation.projection;

// J2SE dependencies and extensions

import java.awt.geom.AffineTransform;

import java.awt.geom.Point2D;

import java.util.Collection;

import javax.units.Unit;

import javax.units.NonSI;

// OpenGIS dependencies

import org.opengis.metadata.Identifier;

import org.opengis.parameter.ParameterDescriptor;

import org.opengis.parameter.ParameterDescriptorGroup;

import org.opengis.parameter.ParameterNotFoundException;

import org.opengis.parameter.ParameterValueGroup;

import org.opengis.referencing.operation.CylindricalProjection;

import org.opengis.referencing.operation.MathTransform;

// Geotools dependencies

import org.geotools.metadata.iso.citation.CitationImpl;

import org.geotools.referencing.NamedIdentifier;

import org.geotools.referencing.operation.projection.CassiniSoldner.Provider;

import org.geotools.referencing.operation.transform.ConcatenatedTransform;

import org.geotools.referencing.operation.transform.ProjectiveTransform;

//import org.geotools.resources.i18n.VocabularyKeys;

//import org.geotools.resources.i18n.Vocabulary;

import org.geotools.resources.cts.ResourceKeys;

import org.geotools.resources.cts.Resources;

/**

 * Transverse Mercator Projection (EPSG code 9807). This

 * is a cylindrical projection, in which the cylinder has been rotated 90.

 * Instead of being tangent to the equator (or to an other standard latitude),

 * it is tangent to a central meridian. Deformation are more important as we

 * are going futher from the central meridian. The Transverse Mercator

 * projection is appropriate for region wich have a greater extent north-south

 * than east-west.

 * <p>

 *

 * The elliptical equations used here are series approximations, and their accuracy

 * decreases as points move farther from the central meridian of the projection.

 * The forward equations here are accurate to a less than a mm ±10 degrees from 

 * the central meridian, a few mm ±15 degrees from the 

 * central meridian and a few cm ±20 degrees from the central meridian.

 * The spherical equations are not approximations and should always give the 

 * correct values.

 * <p>

 *

 * There are a number of versions of the transverse mercator projection 

 * including the Universal (UTM) and Modified (MTM) Transverses Mercator 

 * projections. In these cases the earth is divided into zones. For the UTM

 * the zones are 6 degrees wide, numbered from 1 to 60 proceeding east from 

 * 180 degrees longitude, and between lats 84 degrees North and 80 

 * degrees South. The central meridian is taken as the center of the zone

 * and the latitude of origin is the equator. A scale factor of 0.9996 and 

 * false easting of 500000m is used for all zones and a false northing of 10000000m

 * is used for zones in the southern hemisphere.

 * <p>

 *

 * NOTE: formulas used below are not those of Snyder, but rather those

 *       from the {@code proj4} package of the USGS survey, which

 *       have been reproduced verbatim. USGS work is acknowledged here.

 * <p>

 *

 * <strong>References:</strong><ul>

 *   <li> Proj-4.4.6 available at <A HREF="http://www.remotesensing.org/proj">www.remotesensing.org/proj</A><br>

 *        Relevent files are: PJ_tmerc.c, pj_mlfn.c, pj_fwd.c and pj_inv.c </li>

 *   <li> John P. Snyder (Map Projections - A Working Manual,

 *        U.S. Geological Survey Professional Paper 1395, 1987)</li>

 *   <li> "Coordinate Conversions and Transformations including Formulas",

 *        EPSG Guidence Note Number 7, Version 19.</li>

 * </ul>

 *

 * @see <A HREF="http://mathworld.wolfram.com/MercatorProjection.html">Transverse Mercator projection on MathWorld</A>

 * @see <A HREF="http://www.remotesensing.org/geotiff/proj_list/transverse_mercator.html">"Transverse_Mercator" on Remote Sensing</A>

 *

 * @since 2.1

 * @source $URL: http://svn.geotools.org/geotools/tags/2.3.0/module/referencing/src/org/geotools/referencing/operation/projection/TransverseMercator.java $

 * @version $Id: TransverseMercator.java 12205 2007-06-19 07:15:42Z jlgomez $

 * @author Andr Gosselin

 * @author Martin Desruisseaux

 * @author Rueben Schulz

 */

public class TransverseMercator extends MapProjection {

        private final double scaleFactorLocal;

        private final double initialLongitude;

        private final double zoneWidth;

        /**

     * A derived quantity of excentricity, computed by <code>e' = (a鲲-b)/b = es/(1-es)</code>

     * where <var>a</var> is the semi-major axis length and <var>b</bar> is the semi-minor axis

     * length.

     */

    private final double esp;

    /**

     * Meridian distance at the {@code latitudeOfOrigin}.

     * Used for calculations for the ellipsoid.

     */

    private final double ml0;

     /**

     * Constant needed for the <code>mlfn<code> method.

     * Setup at construction time.

     */

    private final double en0,en1,en2,en3,en4;

    /**

     * 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;

    /**

     * Contants used for the forward and inverse transform for the eliptical

     * case of the Transverse Mercator.

     */

    private static final double FC1= 1.00000000000000000000000,  // 1/1

                                FC2= 0.50000000000000000000000,  // 1/2

                                FC3= 0.16666666666666666666666,  // 1/6

                                FC4= 0.08333333333333333333333,  // 1/12

                                FC5= 0.05000000000000000000000,  // 1/20

                                FC6= 0.03333333333333333333333,  // 1/30

                                FC7= 0.02380952380952380952380,  // 1/42

                                FC8= 0.01785714285714285714285;  // 1/56

    /**

     * Relative iteration precision used in the <code>mlfn<code> method. This 

     * overrides the value in the MapProjection class.

     */

    private static final double TOL = 1E-11;

    /**

     * Constructs a new map projection from the supplied parameters.

     *

     * @param  parameters The parameter values in standard units.

     * @throws ParameterNotFoundException if a mandatory parameter is missing.

     */

    protected TransverseMercator(final ParameterValueGroup parameters)

            throws ParameterNotFoundException

    {

        //Fetch parameters 

        super(parameters);

        //  Compute constants

        esp = excentricitySquared / (1.0 - excentricitySquared);

        double t;

        en0 = C00 - excentricitySquared  *  (C02 + excentricitySquared  * 

             (C04 + excentricitySquared  *  (C06 + excentricitySquared  * C08)));

        en1 =       excentricitySquared  *  (C22 - excentricitySquared  *

             (C04 + excentricitySquared  *  (C06 + excentricitySquared  * C08)));

        en2 =  (t = excentricitySquared  *         excentricitySquared) * 

             (C44 - excentricitySquared  *  (C46 + excentricitySquared  * C48));

        en3 = (t *= excentricitySquared) *  (C66 - excentricitySquared  * C68);

        en4 =   t * excentricitySquared  *  C88;

        ml0 = mlfn(latitudeOfOrigin, Math.sin(latitudeOfOrigin), Math.cos(latitudeOfOrigin));

        final Collection expected = getParameterDescriptors().descriptors();

        if (expected.contains(Provider_TransverseMercatorZonedGridSystem.INITIAL_LONGITUDE)) {

                initialLongitude = Math.abs(doubleValue(expected,

                                Provider_TransverseMercatorZonedGridSystem.INITIAL_LONGITUDE, parameters));

            ensureLatitudeInRange(Provider_TransverseMercatorZonedGridSystem.INITIAL_LONGITUDE, initialLongitude, false);

        } else {

            // standard parallel is the equator (Plate Carree or Equirectangular)

                initialLongitude = Double.NaN;

        }

        if (expected.contains(Provider_TransverseMercatorZonedGridSystem.ZONE_WIDTH)) {

                zoneWidth = Math.abs(doubleValue(expected,

                                Provider_TransverseMercatorZonedGridSystem.ZONE_WIDTH, parameters));

            ensureLatitudeInRange(Provider_TransverseMercatorZonedGridSystem.ZONE_WIDTH, zoneWidth, false);

        } else {

            // standard parallel is the equator (Plate Carree or Equirectangular)

                zoneWidth = Double.NaN;

        }

        if (expected.contains(Provider_TransverseMercatorZonedGridSystem.SCALE_FACTOR_LOCAL)) {

                scaleFactorLocal = Math.abs(doubleValue(expected,

                                Provider_TransverseMercatorZonedGridSystem.SCALE_FACTOR_LOCAL, parameters));

            ensureLatitudeInRange(Provider_TransverseMercatorZonedGridSystem.SCALE_FACTOR_LOCAL, scaleFactorLocal, false);

        } else {

            // standard parallel is the equator (Plate Carree or Equirectangular)

                scaleFactorLocal = Double.NaN;

        }

    }

    /**

     * {@inheritDoc}

     */

    public ParameterDescriptorGroup getParameterDescriptors() {

        return Provider.PARAMETERS;

    }

    /**

     * Transforms the specified (<var>x</var>,<var>y</var>) coordinate (units in radians)

     * and stores the result in {@code ptDst} (linear distance on a unit sphere).

     */

    protected Point2D transformNormalized(double x, double y, Point2D ptDst) 

            throws ProjectionException 

    {

        double sinphi = Math.sin(y);

        double cosphi = Math.cos(y);

        double t = (Math.abs(cosphi)>EPS) ? sinphi/cosphi : 0;

        t *= t;

        double al = cosphi*x;

        double als = al*al;

        al /= Math.sqrt(1.0 - excentricitySquared * sinphi*sinphi);

        double n = esp * cosphi*cosphi;

        /* NOTE: meridinal distance at latitudeOfOrigin is always 0 */

        y = (mlfn(y, sinphi, cosphi) - ml0 + 

            sinphi*al*x*

            FC2 * ( 1.0 +

            FC4 * als * (5.0 - t + n*(9.0 + 4.0*n) +

            FC6 * als * (61.0 + t * (t - 58.0) + n*(270.0 - 330.0*t) +

            FC8 * als * (1385.0 + t * ( t*(543.0 - t) - 3111.0))))));

        x = al*(FC1 + FC3 * als*(1.0 - t + n +

            FC5 * als * (5.0 + t*(t - 18.0) + n*(14.0 - 58.0*t) +

            FC7 * als * (61.0+ t*(t*(179.0 - t) - 479.0 )))));

        if (ptDst != null) {

            ptDst.setLocation(x,y);

            return ptDst;

        }

        return new Point2D.Double(x,y);          

    }

    /**

     * Transforms the specified (<var>x</var>,<var>y</var>) coordinate

     * and stores the result in {@code ptDst}.

     */

    protected Point2D inverseTransformNormalized(double x, double y, Point2D ptDst) 

            throws ProjectionException 

    {

        double phi = inv_mlfn(ml0 + y);

        if (Math.abs(phi) >= (Math.PI/2)) {

            y = y<0.0 ? -(Math.PI/2) : (Math.PI/2);

            x = 0.0;

        } else {

            double sinphi = Math.sin(phi);

            double cosphi = Math.cos(phi);

            double t = (Math.abs(cosphi) > EPS) ? sinphi/cosphi : 0.0;

            double n = esp * cosphi*cosphi;

            double con = 1.0 - excentricitySquared * sinphi*sinphi;

            double d = x*Math.sqrt(con);

            con *= t;

            t *= t;

            double ds = d*d;

            y = phi - (con*ds / (1.0 - excentricitySquared)) *

                FC2 * (1.0 - ds *

                FC4 * (5.0 + t*(3.0 - 9.0*n) + n*(1.0 - 4*n) - ds *

                FC6 * (61.0 + t*(90.0 - 252.0*n + 45.0*t) + 46.0*n - ds *

                FC8 * (1385.0 + t*(3633.0 + t*(4095.0 + 1574.0*t))))));

            x = d*(FC1 - ds * FC3 * (1.0 + 2.0*t + n -

                ds*FC5*(5.0 + t*(28.0 + 24* t + 8.0*n) + 6.0*n -

                ds*FC7*(61.0 + t*(662.0 + t*(1320.0 + 720.0*t))))))/cosphi;

        }

        if (ptDst != null) {

            ptDst.setLocation(x,y);

            return ptDst;

        }

        return new Point2D.Double(x,y);        

    }

    /**

     * {@inheritDoc}

     */

    protected double getToleranceForAssertions(final double longitude, final double latitude) {

        if (Math.abs(longitude - centralMeridian) > 0.26) {   //15 degrees

            // When far from the valid area, use a larger tolerance.

            return 2.5;

        } else if (Math.abs(longitude - centralMeridian) > 0.22) {  //12.5 degrees

            return 1.0;

        } else if (Math.abs(longitude - centralMeridian) > 0.17) {  //10 degrees

            return 0.5;

        }

        // a normal tolerance

        return 1E-6;

    }

    /**

     * Provides the transform equations for the spherical case of the

     * TransverseMercator projection.

     * 

     * @version $Id: TransverseMercator.java 12205 2007-06-19 07:15:42Z jlgomez $

     * @author Andr Gosselin

     * @author Martin Desruisseaux

     * @author Rueben Schulz

     */

    private static final class Spherical extends TransverseMercator {

        /**

         * Constructs a new map projection from the suplied parameters.

         *

         * @param  parameters The parameter values in standard units.

         * @throws ParameterNotFoundException if a mandatory parameter is missing.

         */

        protected Spherical(final ParameterValueGroup parameters)

                throws ParameterNotFoundException

        {

            super(parameters);

            //assert isSpherical;

        }

        /**

         * {@inheritDoc}

         */

        protected Point2D transformNormalized(double x, double y, Point2D ptDst)

                throws ProjectionException 

        {

            // Compute using ellipsoidal formulas, for comparaison later.

            double normalizedLongitude = x;

            //assert (ptDst = super.transformNormalized(x, y, ptDst)) != null;

            double cosphi = Math.cos(y);

            double b = cosphi * Math.sin(x);

            if (Math.abs(Math.abs(b) - 1.0) <= EPS) {

                throw new ProjectionException(Resources.format(ResourceKeys.ERROR_VALUE_TEND_TOWARD_INFINITY));

            }

            //Using Snyder's equation for calculating y, instead of the one used in Proj4

            //poential problems when y and x = 90 degrees, but behaves ok in tests   

            y = Math.atan2(Math.tan(y),Math.cos(x)) - latitudeOfOrigin;   /* Snyder 8-3 */

            x = 0.5 * Math.log((1.0+b)/(1.0-b));    /* Snyder 8-1 */

            //assert Math.abs(ptDst.getX()-x) <= getToleranceForSphereAssertions(normalizedLongitude,0) : ptDst.getX()-x;

            //assert Math.abs(ptDst.getY()-y) <= getToleranceForSphereAssertions(normalizedLongitude,0) : ptDst.getY()-y;

            if (ptDst != null) {

                ptDst.setLocation(x,y);

                return ptDst;

            }

            return new Point2D.Double(x,y);

        }        

        /**

         * {@inheritDoc}

         */

        protected Point2D inverseTransformNormalized(double x, double y, Point2D ptDst) 

                throws ProjectionException 

        {

            // Compute using ellipsoidal formulas, for comparaison later.

            //assert (ptDst = super.inverseTransformNormalized(x, y, ptDst)) != null;

            double t = Math.exp(x);

            double sinhX = 0.5 * (t-1.0/t);                //sinh(x)

            double cosD = Math.cos(latitudeOfOrigin + y);

            double phi = Math.asin(Math.sqrt((1.0-cosD*cosD)/(1.0+sinhX*sinhX)));

            // correct for the fact that we made everything positive using sqrt(x*x)

            y = ((y + latitudeOfOrigin)<0.0) ? -phi : phi;   

            x = (Math.abs(sinhX)<=EPS && Math.abs(cosD)<=EPS) ? 

                    0.0 : Math.atan2(sinhX,cosD);

            //assert Math.abs(ptDst.getX()-x) <= getToleranceForSphereAssertions(x,0) : ptDst.getX()-x;

            //assert Math.abs(ptDst.getY()-y) <= getToleranceForSphereAssertions(x,0) : ptDst.getY()-y;

            if (ptDst != null) {

                ptDst.setLocation(x,y);

                return ptDst;

            }

            return new Point2D.Double(x,y);

        }

        /*

         *  Allow a larger tolerance when comparing spherical to elliptical calculations

         *  when we are far from the central meridian (elliptical calculations are

         *  not valid here).

         *

         *  longitude here is standardized (in radians) and centralMeridian has 

         *  already been removed from it.

         */

        protected double getToleranceForSphereAssertions(final double longitude, final double latitude) {

            if (Math.abs(Math.abs(longitude)- Math.PI/2.0) < TOL) {  //90 degrees

                // elliptical equations are at their worst here

                return 1E18;

            }

            if (Math.abs(longitude) > 0.26) {   //15 degrees

                // When far from the valid area, use a very larger tolerance.          

                return 1000000;

            }

            // a normal tolerance

            return 1E-6;

        }

    }

    /**

     * 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.

     */

    private 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.

     */

    private final double inv_mlfn(double arg) throws ProjectionException {

        double s, t, phi, k = 1.0/(1.0 - excentricitySquared);

        int i;

        phi = arg;

        for (i=MAX_ITER; true;) { // rarely goes over 5 iterations

            if (--i < 0) {

                throw new ProjectionException(Resources.format(ResourceKeys.ERROR_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) < TOL) {

                return phi;

            }

        }

    }

    /**

     * Convenience method computing the zone code from the central meridian.

     * Information about zones convention must be specified in argument. Two

     * widely set of arguments are of Universal Transverse Mercator (UTM) and

     * Modified Transverse Mercator (MTM) projections:<br>

     * <p>

     *

     * UTM projection (zones numbered from 1 to 60):<br>

     * <p>

     *        {@code getZone(-177, 6);}<br>

     * <p>

     * MTM projection (zones numbered from 1 to 120):<br>

     * <p>

     *        {@code getZone(-52.5, -3);}<br>

     *

     * @param  centralLongitudeZone1 Longitude in the middle of zone 1, in decimal degrees

     *         relative to Greenwich. Positive longitudes are toward east, and negative

     *         longitudes toward west.

     * @param  zoneWidth Number of degrees of longitudes in one zone. A positive value

     *         means that zones are numbered from west to east (i.e. in the direction of

     *         positive longitudes). A negative value means that zones are numbered from

     *         east to west.

     * @return The zone number. First zone is numbered 1.

     */

    private int getZone(final double centralLongitudeZone1, final double zoneWidth) {

        final double zoneCount = Math.abs(360/zoneWidth);

        double t;

        t  = centralLongitudeZone1 - 0.5*zoneWidth; // Longitude at the beginning of the first zone.

        t  = Math.toDegrees(centralMeridian) - t;   // Degrees of longitude between the central longitude and longitude 1.

        t  = Math.floor(t/zoneWidth + EPS);         // Number of zones between the central longitude and longitude 1.

        t -= zoneCount*Math.floor(t/zoneCount);     // If negative, bring back to the interval 0 to (zoneCount-1).

        return ((int) t)+1;

    }

    /**

     * Convenience method returning the meridian in the middle of current zone. This meridian is

     * typically the central meridian. This method may be invoked to make sure that the central

     * meridian is correctly set.

     *

     * @param  centralLongitudeZone1 Longitude in the middle of zone 1, in decimal degrees

     *         relative to Greenwich. Positive longitudes are toward east, and negative

     *         longitudes toward west.

     * @param  zoneWidth Number of degrees of longitudes in one zone. A positive value

     *         means that zones are numbered from west to east (i.e. in the direction of

     *         positive longitudes). A negative value means that zones are numbered from

     *         east to west.

     * @return The central meridian.

     */

    private double getCentralMedirian(final double centralLongitudeZone1, final double zoneWidth) {

        double t;

        t  = centralLongitudeZone1 + (getZone(centralLongitudeZone1, zoneWidth)-1)*zoneWidth;

        t -= 360*Math.floor((t+180)/360); // Bring back into [-180..+180] range.

        return t;

    }

    /**

     * Convenience method computing the zone code from the central meridian.

     *

     * @return The zone number, using the scalefactor and false easting 

     *         to decide if this is a UTM or MTM case. Returns 0 if the 

     *         case of the projection cannot be determined.

     */

    public int getZone() {

        // UTM

        if (scaleFactor == 0.9996 && falseEasting == 500000.0) {

            return getZone(-177, 6);

        }

        // MTM

        if (scaleFactor == 0.9999 && falseEasting == 304800.0){

            return getZone(-52.5, -3);

        }

        // unknown

        throw new IllegalStateException(Resources.format(ResourceKeys.ERROR_UNKNOW_TYPE_$1));//.UNKNOW_PROJECTION_TYPE));

    }

    /**

     * Convenience method returning the meridian in the middle of current zone. This meridian is

     * typically the central meridian. This method may be invoked to make sure that the central

     * meridian is correctly set.

     *

     * @return The central meridian, using the scalefactor and false easting 

     *         to decide if this is a UTM or MTM case. Returns {@link Double#NaN}

     *         if the case of the projection cannot be determined.

     */

    public double getCentralMeridian() {

        // UTM

        if (scaleFactor == 0.9996 && falseEasting == 500000.0) {

            return getCentralMedirian(-177, 6);

        }

        // MTM

        if (scaleFactor == 0.9999 && falseEasting == 304800.0){

            return getCentralMedirian(-52.5, -3);

        }

        // unknown

        throw new IllegalStateException(Resources.format(ResourceKeys.ERROR_UNKNOW_TYPE_$1));//.UNKNOW_PROJECTION_TYPE));

    }

    /**

     * Returns a hash value for this projection.

     */

    public int hashCode() { 

        final long code = Double.doubleToLongBits(ml0);

        return ((int)code ^ (int)(code >>> 32)) + 37*super.hashCode();

    }

    /**

     * Compares the specified object with this map projection for equality.

     */

    public boolean equals(final Object object) {

        if (object == this) {

            // Slight optimization

            return true;

        }

        // Relevant parameters are already compared in MapProjection

        return super.equals(object);

    }

    //////////////////////////////////////////////////////////////////////////////////////////

    //////////////////////////////////////////////////////////////////////////////////////////

    ////////                                                                          ////////

    ////////                                 PROVIDER                                 ////////

    ////////                                                                          ////////

    //////////////////////////////////////////////////////////////////////////////////////////

    //////////////////////////////////////////////////////////////////////////////////////////

    /**

     * The {@link org.geotools.referencing.operation.MathTransformProvider}

     * for a {@link TransverseMercator} projection.

     *

     * @see org.geotools.referencing.operation.DefaultMathTransformFactory

     *

     * @since 2.1

     * @version $Id: TransverseMercator.java 12205 2007-06-19 07:15:42Z jlgomez $

     * @author Martin Desruisseaux

     * @author Rueben Schulz

     */

    public static class Provider extends AbstractProvider {

        /**

         * Returns a descriptor group for the specified parameters.

         */

        static ParameterDescriptorGroup createDescriptorGroup(final Identifier[] identifiers) {

            return createDescriptorGroup(identifiers, new ParameterDescriptor[] {

                SEMI_MAJOR,       SEMI_MINOR,

                CENTRAL_MERIDIAN, LATITUDE_OF_ORIGIN,

                SCALE_FACTOR,     FALSE_EASTING,

                FALSE_NORTHING

            });

        }

        /**

         * The parameters group.

         */

        static final ParameterDescriptorGroup PARAMETERS = createDescriptorGroup(new NamedIdentifier[] {

                new NamedIdentifier(CitationImpl.OGC,      "Transverse_Mercator"),

                new NamedIdentifier(CitationImpl.EPSG,     "Transverse Mercator"),

                new NamedIdentifier(CitationImpl.EPSG,     "Gauss-Kruger"),

                new NamedIdentifier(CitationImpl.EPSG,     "9807"),

                new NamedIdentifier(CitationImpl.GEOTIFF,  "CT_TransverseMercator"),

                new NamedIdentifier(CitationImpl.ESRI,     "Transverse_Mercator"),

                new NamedIdentifier(CitationImpl.ESRI,     "Gauss_Kruger")//,

                //new NamedIdentifier(CitationImpl.GEOTOOLS, Vocabulary.formatInternational(

                //                    VocabularyKeys.TRANSVERSE_MERCATOR_PROJECTION))

            });

        /**

         * Constructs a new provider.

         */

        public Provider() {

            super(PARAMETERS);

        }

        /**

         * Constructs a new provider with the specified parameters.

         */

        Provider(final ParameterDescriptorGroup descriptor) {

            super(descriptor);

        }

        /**

         * Returns the operation type for this map projection.

         */

        protected Class getOperationType() {

            return CylindricalProjection.class;

        }

        /**

         * Creates a transform from the specified group of parameter values.

         *

         * @param  parameters The group of parameter values.

         * @return The created math transform.

         * @throws ParameterNotFoundException if a required parameter was not found.

         */

        public MathTransform createMathTransform(final ParameterValueGroup parameters)

                throws ParameterNotFoundException

        {

            if (isSpherical(parameters)) {

                return new Spherical(parameters);

            } else {

                return new TransverseMercator(parameters);

            }

        }

    }

    /**

     * The {@link org.geotools.referencing.operation.MathTransformProvider} for a South Orientated

     * {@link TransverseMercator} projection (EPSG code 9808). Note that at the contrary of what

     * this class name suggest, the projected coordinates are still increasing toward North. This

     * is because all {@link MapProjection}s must complies with standard axis orientations. The

     * real axis flip is performed by the CRS framework outside this package.

     * See "<cite>Axis units and orientation</cite>" in

     * {@linkplain org.geotools.referencing.operation.projection package description} for details.

     * <p>

     * The usual Transverse Mercator formulas are:

     * <p>

     * <ul>

     *   <li><var>easting</var> = <var>{@linkplain #falseEasting false easting}</var> + <var>px</var></li>

     *   <li><var>northing</var> = <var>{@linkplain #falseNorthing false northing}</var> + <var>py</var></li>

     * </ul>

     * <p>

     * The Transverse Mercator South Orientated Projection formulas are:

     * <p>

     * <ul>

     *   <li><var>westing</var> = <var>{@linkplain #falseEasting false easting}</var> - <var>px</var></li>

     *   <li><var>southing</var> = <var>{@linkplain #falseNorthing false northing}</var> - <var>py</var></li>

     * </ul>

     * <p>

     * Where the <var>px</var> and <var>py</var> terms are the same in both cases.

     * Transforms created by this provider actually computes

     * (<var>easting</var>,<var>northing</var>) = (-<var>westing</var>,-<var>southing</var>).

     * This is equivalent to a {@link TransverseMercator} projection with

     * {@link #falseEasting falseEasting} and {@link #falseNorthing falseNorthing} sign reverted.

     * This operation is implemented as a concatenation of a North-orientated transverse mercator

     * projection with an affine transform for (<var>false easting</var>,<var>false northing</var>)

     * correction.

     *

     * @since 2.2

     * @version $Id: TransverseMercator.java 12205 2007-06-19 07:15:42Z jlgomez $

     * @author Martin Desruisseaux

     */

    public static class Provider_SouthOrientated extends Provider {

        /**

         * Constructs a new provider.

         */

        public Provider_SouthOrientated() {

            super(createDescriptorGroup(new NamedIdentifier[] {

                new NamedIdentifier(CitationImpl.EPSG, "Transverse Mercator (South Orientated)"),

                new NamedIdentifier(CitationImpl.EPSG, "9808")

            }));

        }

        /**

         * Creates a transform from the specified group of parameter values.

         *

         * @param  parameters The group of parameter values.

         * @return The created math transform.

         * @throws ParameterNotFoundException if a required parameter was not found.

         */

        public MathTransform createMathTransform(final ParameterValueGroup parameters)

                throws ParameterNotFoundException

        {

            final MapProjection projection = (MapProjection) super.createMathTransform(parameters);

            if (projection.falseEasting==0 && projection.falseNorthing==0) {

                return projection;

            }

            final AffineTransform step = AffineTransform.getTranslateInstance(

                    -2*projection.falseEasting, -2*projection.falseNorthing);

            return ConcatenatedTransform.create(ProjectiveTransform.create(step), projection);

        }

    }

    public static class Provider_TransverseMercatorZonedGridSystem extends Provider {

        /**

         * Constructs a new provider.

         */

               public static final ParameterDescriptor INITIAL_LONGITUDE = createDescriptor(

                        new NamedIdentifier[] {

                            new NamedIdentifier(CitationImpl.OGC,     "Initial longitude"),

                            new NamedIdentifier(CitationImpl.EPSG,    "Initial_longitude")

                        }, 0.0, -180.0, 180.0, NonSI.DEGREE_ANGLE);

               public static final ParameterDescriptor ZONE_WIDTH = createDescriptor(

                        new NamedIdentifier[] {

                            new NamedIdentifier(CitationImpl.OGC,     "Zone width"),

                            new NamedIdentifier(CitationImpl.EPSG,    "Zone_width")

                        }, 0.0, 0.0, 12.0, NonSI.DEGREE_ANGLE);

               public static final ParameterDescriptor SCALE_FACTOR_LOCAL = createDescriptor(

                        new NamedIdentifier[] {

                            new NamedIdentifier(CitationImpl.OGC,      "scale_factor"),

                            new NamedIdentifier(CitationImpl.EPSG,     "Scale factor on initial line"),

                            new NamedIdentifier(CitationImpl.EPSG,    "Scale factor at natural origin"),

                            new NamedIdentifier(CitationImpl.GEOTIFF, "ScaleAtNatOrigin"),

                            new NamedIdentifier(CitationImpl.GEOTIFF, "ScaleAtCenter")

                        },

                        1, 0, Double.POSITIVE_INFINITY, Unit.ONE);

               static final ParameterDescriptorGroup PARAMETERS = createDescriptorGroup(new NamedIdentifier[] {

                new NamedIdentifier(CitationImpl.OGC,      "Transverse_Mercator_Zoned_Grid_System"),

                            new NamedIdentifier(CitationImpl.EPSG,     "Transverse Mercator Zoned Grid System")

//                new NamedIdentifier(CitationImpl.GEOTOOLS, Vocabulary.formatInternational(

//                                    VocabularyKeys.EQUIDISTANT_CYLINDRICAL_PROJECTION))

            }, new ParameterDescriptor[] {

                SEMI_MAJOR,       SEMI_MINOR,

                CENTRAL_MERIDIAN,

                INITIAL_LONGITUDE, ZONE_WIDTH,

                LATITUDE_OF_ORIGIN, SCALE_FACTOR_LOCAL,

                FALSE_EASTING,    FALSE_NORTHING

            });

        public Provider_TransverseMercatorZonedGridSystem() {

            super(PARAMETERS);

        }

        protected Class getOperationType() {

                return CylindricalProjection.class;

        }

        /**

         * Creates a transform from the specified group of parameter values.

         *

         * @param  parameters The group of parameter values.

         * @return The created math transform.

         * @throws ParameterNotFoundException if a required parameter was not found.

         */

        public MathTransform createMathTransform(final ParameterValueGroup parameters)

        throws ParameterNotFoundException

        {

                    //return null;

                        return new CassiniSoldner(parameters);

                }

    }

}