/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2003-2012, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2012, Geomatys
*
* 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;
* version 2.1 of the License.
*
* 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.
*/
package org.geotoolkit.referencing.operation.provider;
import org.apache.sis.internal.referencing.provider.Equirectangular;
import org.opengis.metadata.citation.Citation;
import org.opengis.parameter.ParameterValueGroup;
import org.opengis.parameter.ParameterDescriptor;
import org.opengis.parameter.ParameterDescriptorGroup;
import org.opengis.referencing.operation.MathTransform2D;
import org.opengis.metadata.Identifier;
import org.opengis.referencing.operation.MathTransformFactory;
import org.geotoolkit.resources.Vocabulary;
import org.apache.sis.referencing.NamedIdentifier;
import org.geotoolkit.metadata.Citations;
/**
* The provider for "<cite>Cassini-Soldner</cite>" projection (EPSG:9806).
* The math transform implementations instantiated by this provider may be any of the following classes:
* <p>
* <ul>
* <li>{@link org.geotoolkit.referencing.operation.projection.CassiniSoldner}</li>
* </ul>
*
* <!-- PARAMETERS CassiniSoldner -->
* <p>The following table summarizes the parameters recognized by this provider.
* For a more detailed parameter list, see the {@link #PARAMETERS} constant.</p>
* <blockquote><p><b>Operation name:</b> {@code Cassini_Soldner}
* <br><b>Area of use:</b> <font size="-1">(union of CRS domains of validity in EPSG database)</font></p>
* <blockquote><table class="compact">
* <tr><td><b>in latitudes:</b></td><td class="onright">18°36.0′S</td><td>to</td><td class="onright">52°40.8′N</td></tr>
* <tr><td><b>in longitudes:</b></td><td class="onright">62°04.8′W</td><td>to</td><td class="onright">178°52.2′E</td></tr>
* </table></blockquote>
* <table class="geotk">
* <tr><th>Parameter name</th><th>Default value</th></tr>
* <tr><td>{@code semi_major}</td><td></td></tr>
* <tr><td>{@code semi_minor}</td><td></td></tr>
* <tr><td>{@code central_meridian}</td><td>0°</td></tr>
* <tr><td>{@code latitude_of_origin}</td><td>0°</td></tr>
* <tr><td>{@code scale_factor}</td><td>1</td></tr>
* <tr><td>{@code false_easting}</td><td>0 metres</td></tr>
* <tr><td>{@code false_northing}</td><td>0 metres</td></tr>
* </table></blockquote>
* <!-- END OF PARAMETERS -->
*
* @author Mauro Bartolomeoli
* @author Martin Desruisseaux (Geomatys)
* @version 3.20
*
* @see <A HREF="http://www.remotesensing.org/geotiff/proj_list/cassini_soldner.html">Cassini-Soldner on RemoteSensing.org</A>
* @see <a href="{@docRoot}/../modules/referencing/operation-parameters.html">Geotk coordinate operations matrix</a>
*
* @since 3.00
* @module
*/
public class CassiniSoldner extends MapProjection {
/**
* For compatibility with different versions during deserialization.
*/
private static final long serialVersionUID = -2473637102471705721L;
/**
* The operation parameter descriptor for the {@linkplain
* org.geotoolkit.referencing.operation.projection.UnitaryProjection.Parameters#centralMeridian
* central meridian} parameter value.
*
* This parameter is <a href="package-summary.html#Obligation">mandatory</a>.
* Valid values range is [-180 … 180]° and default value is 0°.
*/
static final ParameterDescriptor<Double> CENTRAL_MERIDIAN;
/**
* The operation parameter descriptor for the {@linkplain
* org.geotoolkit.referencing.operation.projection.UnitaryProjection.Parameters#latitudeOfOrigin
* latitude of origin} parameter value.
*
* This parameter is <a href="package-summary.html#Obligation">mandatory</a>.
* Valid values range is [-90 … 90]° and default value is 0°.
*/
static final ParameterDescriptor<Double> LATITUDE_OF_ORIGIN;
/**
* The operation parameter descriptor for the {@linkplain
* org.geotoolkit.referencing.operation.projection.UnitaryProjection.Parameters#scaleFactor
* scale factor} parameter value.
*
* This parameter is <a href="package-summary.html#Obligation">mandatory</a>.
* Valid values range is (0 … ∞) and default value is 1.
*/
static final ParameterDescriptor<Double> SCALE_FACTOR;
/**
* The operation parameter descriptor for the {@linkplain
* org.geotoolkit.referencing.operation.projection.UnitaryProjection.Parameters#falseEasting
* false easting} parameter value.
*
* This parameter is <a href="package-summary.html#Obligation">mandatory</a>.
* Valid values range is unrestricted and default value is 0 metre.
*/
static final ParameterDescriptor<Double> FALSE_EASTING;
/**
* The operation parameter descriptor for the {@linkplain
* org.geotoolkit.referencing.operation.projection.UnitaryProjection.Parameters#falseNorthing
* false northing} parameter value.
*
* This parameter is <a href="package-summary.html#Obligation">mandatory</a>.
* Valid values range is unrestricted and default value is 0 metre.
*/
static final ParameterDescriptor<Double> FALSE_NORTHING;
/**
* Parameters creation, which must be done before to initialize the {@link #PARAMETERS} field.
* Note that the central Meridian and Latitude of Origin are shared with ObliqueStereographic.
*/
static {
final Citation[] excludes = new Citation[] {Citations.NETCDF};
CENTRAL_MERIDIAN = UniversalParameters.CENTRAL_MERIDIAN.select(excludes,
"Longitude of natural origin", // EPSG
"central_meridian", // OGC
"Central_Meridian", // ESRI
"NatOriginLong"); // GeoTIFF
LATITUDE_OF_ORIGIN = UniversalParameters.LATITUDE_OF_ORIGIN.select(excludes,
"Latitude of natural origin", // EPSG
"latitude_of_origin", // OGC
"Latitude_Of_Origin", // ESRI
"NatOriginLat"); // GeoTIFF
SCALE_FACTOR = UniversalParameters.SCALE_FACTOR.select(excludes,
"Scale factor at natural origin", // EPSG
"ScaleAtNatOrigin"); // GeoTIFf
FALSE_EASTING = Equirectangular.FALSE_EASTING;
FALSE_NORTHING = Equirectangular.FALSE_NORTHING;
}
/**
* The group of all parameters expected by this coordinate operation.
* The following table lists the operation names and the parameters recognized by Geotk:
* <p>
* <!-- GENERATED PARAMETERS - inserted by ProjectionParametersJavadoc -->
* <table class="geotk" border="1">
* <tr><th colspan="2">
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>Cassini_Soldner</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>Cassini-Soldner</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>Cassini</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>CT_CassiniSoldner</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>cass</code></td></tr>
* <tr><td></td><td class="onright"><code>Geotk</code>:</td><td class="onleft"><code>Cassini-Soldner projection</code></td></tr>
* <tr><td><b>Identifier:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>9806</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>18</code></td></tr>
* </table>
* </th></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>semi_major</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>Semi-major axis</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>Semi_Major</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>SemiMajor</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>a</code></td></tr>
* </table>
* </td><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Double}</td></tr>
* <tr><td><b>Obligation:</b></td><td>mandatory</td></tr>
* <tr><td><b>Value range:</b></td><td>[0…∞) metres</td></tr>
* </table>
* </td></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>semi_minor</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>Semi-minor axis</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>Semi_Minor</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>SemiMinor</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>b</code></td></tr>
* </table>
* </td><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Double}</td></tr>
* <tr><td><b>Obligation:</b></td><td>mandatory</td></tr>
* <tr><td><b>Value range:</b></td><td>[0…∞) metres</td></tr>
* </table>
* </td></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Boolean}</td></tr>
* <tr><td><b>Obligation:</b></td><td>optional</td></tr>
* <tr><td><b>Default value:</b></td><td>false</td></tr>
* </table>
* </td></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>central_meridian</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>Longitude of natural origin</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>Central_Meridian</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>NatOriginLong</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>lon_0</code></td></tr>
* </table>
* </td><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Double}</td></tr>
* <tr><td><b>Obligation:</b></td><td>mandatory</td></tr>
* <tr><td><b>Value range:</b></td><td>[-180 … 180]°</td></tr>
* <tr><td><b>Default value:</b></td><td>0°</td></tr>
* </table>
* </td></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>latitude_of_origin</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>Latitude of natural origin</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>Latitude_Of_Origin</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>NatOriginLat</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>lat_0</code></td></tr>
* </table>
* </td><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Double}</td></tr>
* <tr><td><b>Obligation:</b></td><td>mandatory</td></tr>
* <tr><td><b>Value range:</b></td><td>[-90 … 90]°</td></tr>
* <tr><td><b>Default value:</b></td><td>0°</td></tr>
* </table>
* </td></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>scale_factor</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>Scale factor at natural origin</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>Scale_Factor</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>ScaleAtNatOrigin</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>k</code></td></tr>
* </table>
* </td><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Double}</td></tr>
* <tr><td><b>Obligation:</b></td><td>mandatory</td></tr>
* <tr><td><b>Value range:</b></td><td>[0…∞)</td></tr>
* <tr><td><b>Default value:</b></td><td>1</td></tr>
* </table>
* </td></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>false_easting</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>False easting</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>False_Easting</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>FalseEasting</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>x_0</code></td></tr>
* </table>
* </td><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Double}</td></tr>
* <tr><td><b>Obligation:</b></td><td>mandatory</td></tr>
* <tr><td><b>Value range:</b></td><td>(-∞ … ∞) metres</td></tr>
* <tr><td><b>Default value:</b></td><td>0 metres</td></tr>
* </table>
* </td></tr>
* <tr><td>
* <table class="compact">
* <tr><td><b>Name:</b></td><td class="onright"><code>OGC</code>:</td><td class="onleft"><code>false_northing</code></td></tr>
* <tr><td><b>Alias:</b></td><td class="onright"><code>EPSG</code>:</td><td class="onleft"><code>False northing</code></td></tr>
* <tr><td></td><td class="onright"><code>ESRI</code>:</td><td class="onleft"><code>False_Northing</code></td></tr>
* <tr><td></td><td class="onright"><code>GeoTIFF</code>:</td><td class="onleft"><code>FalseNorthing</code></td></tr>
* <tr><td></td><td class="onright"><code>PROJ4</code>:</td><td class="onleft"><code>y_0</code></td></tr>
* </table>
* </td><td>
* <table class="compact">
* <tr><td><b>Type:</b></td><td>{@code Double}</td></tr>
* <tr><td><b>Obligation:</b></td><td>mandatory</td></tr>
* <tr><td><b>Value range:</b></td><td>(-∞ … ∞) metres</td></tr>
* <tr><td><b>Default value:</b></td><td>0 metres</td></tr>
* </table>
* </td></tr>
* </table>
*/
public static final ParameterDescriptorGroup PARAMETERS = UniversalParameters.createDescriptorGroup(new Identifier[] {
new NamedIdentifier(Citations.OGC, "Cassini_Soldner"),
new NamedIdentifier(Citations.EPSG, "Cassini-Soldner"),
new IdentifierCode (Citations.EPSG, 9806),
new NamedIdentifier(Citations.ESRI, "Cassini"),
new NamedIdentifier(Citations.GEOTIFF, "CT_CassiniSoldner"),
new IdentifierCode (Citations.GEOTIFF, 18),
new NamedIdentifier(Citations.PROJ4, "cass"),
new NamedIdentifier(Citations.GEOTOOLKIT, Vocabulary.formatInternational(
Vocabulary.Keys.CassiniSoldnerProjection))
}, null, new ParameterDescriptor<?>[] {
sameParameterAs(new Equirectangular().getParameters(), "semi_major"), // TODO
sameParameterAs(new Equirectangular().getParameters(), "semi_minor"),
CENTRAL_MERIDIAN, LATITUDE_OF_ORIGIN, SCALE_FACTOR,
FALSE_EASTING, FALSE_NORTHING
}, MapProjectionDescriptor.ADD_EARTH_RADIUS);
/**
* Constructs a new provider.
*/
public CassiniSoldner() {
super(PARAMETERS);
}
/**
* {@inheritDoc}
*/
@Override
public MathTransform2D createMathTransform(MathTransformFactory factory, ParameterValueGroup values) {
return org.geotoolkit.referencing.operation.projection.CassiniSoldner.create(this, values);
}
}