blob: 9569b3996cbcdee6278c12929c62c0babe54ecd6 [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.sis.internal.referencing.provider;
import javax.xml.bind.annotation.XmlTransient;
import org.opengis.parameter.ParameterDescriptor;
import org.opengis.parameter.ParameterDescriptorGroup;
import org.opengis.util.InternationalString;
import org.apache.sis.parameter.ParameterBuilder;
import org.apache.sis.metadata.iso.citation.Citations;
/**
* The provider for <cite>"Mercator (variant B)"</cite> projection (EPSG:9805).
*
* <p>This provider reuses some of the parameters defined in {@link Mercator2SP}.</p>
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Rueben Schulz (UBC)
* @version 0.6
*
* @see <a href="http://geotiff.maptools.org/proj_list/mercator_2sp.html">GeoTIFF parameters for Mercator 2SP</a>
*
* @since 0.6
* @module
*/
@XmlTransient
public final class Mercator2SP extends AbstractMercator {
/**
* For cross-version compatibility.
*/
private static final long serialVersionUID = 6356028352681135786L;
/*
* ACCESS POLICY: Only formal EPSG parameters shall be public.
* Parameters that we add ourselves should be package-privated.
*/
/**
* The operation parameter descriptor for the <cite>Latitude of 1st standard parallel</cite> (φ₁) parameter value.
* Valid values range is (-90 … 90)° and default value is 0°.
*
* <!-- Generated by ParameterNameTableGenerator -->
* <table class="sis">
* <caption>Parameter names</caption>
* <tr><td> EPSG: </td><td> Latitude of 1st standard parallel </td></tr>
* <tr><td> OGC: </td><td> standard_parallel_1 </td></tr>
* <tr><td> ESRI: </td><td> Standard_Parallel_1 </td></tr>
* <tr><td> NetCDF: </td><td> standard_parallel </td></tr>
* <tr><td> GeoTIFF: </td><td> StdParallel1 </td></tr>
* <tr><td> Proj4: </td><td> lat_ts </td></tr>
* </table>
* <b>Notes:</b>
* <ul>
* <li>Value domain: (-90.0 … 90.0)°</li>
* <li>No default value</li>
* </ul>
*/
public static final ParameterDescriptor<Double> STANDARD_PARALLEL = Equirectangular.STANDARD_PARALLEL;
/**
* The operation parameter descriptor for the <cite>Scale factor</cite> (not necessarily at natural origin)
* parameter value. Valid values range is (0 … ∞) and default value is 1.
*
* <p>This parameter is used by {@link Mercator1SP} and is not formally a parameter of {@code Mercator2SP}
* projection. Nevertheless we declare it is as an optional parameter because it is sometime used in Well
* Known Text (WKT). However it shall be interpreted as a <cite>Scale factor at the standard parallel</cite>
* rather than at the natural origin.</p>
*
* <!-- Generated by ParameterNameTableGenerator -->
* <table class="sis">
* <caption>Parameter names</caption>
* <tr><td> OGC: </td><td> scale_factor </td></tr>
* <tr><td> ESRI: </td><td> Scale_Factor </td></tr>
* <tr><td> Proj4: </td><td> k </td></tr>
* </table>
* <b>Notes:</b>
* <ul>
* <li>Value domain: (0.0 … ∞)</li>
* <li>Default value: 1</li>
* <li>Optional</li>
* </ul>
*/
static final ParameterDescriptor<Double> SCALE_FACTOR;
/**
* The group of all parameters expected by this coordinate operation.
*/
static final ParameterDescriptorGroup PARAMETERS;
static {
final ParameterBuilder builder = builder();
/*
* "Latitude of natural origin" and "Scale factor" are not formally parameters of the "Mercator (variant B)"
* projection according EPSG. But we declare them as optional parameters because they are sometime used in
* Well Known Text (WKT).
*/
builder.setRequired(false); // Will apply to all remaining parameters.
final InternationalString remarks = notFormalParameter("Mercator (variant A)");
final ParameterDescriptor<Double> latitudeOfOrigin = createZeroConstant(builder
.addNamesAndIdentifiers(Mercator1SP.LATITUDE_OF_ORIGIN)
.setRemarks(remarks));
/*
* Remove the EPSG name and identifier at least for the scale factor, because its meaning does not fit well
* in this context. The EPSG name is "Scale factor at natural origin" while actually the scale factor applied
* here would rather be at the standard parallel. We keep the OGC, ESRI and Proj.4 names because they are just
* "scale_factor" or "k", which is vague enough for the purpose of this non-standard parameter.
*/
SCALE_FACTOR = createScale(builder
.addNamesAndIdentifiers(Mercator1SP.SCALE_FACTOR)
.reidentify(Citations.EPSG, (String[]) null)
.reidentify(Citations.GEOTIFF, (String[]) null)
.rename(Citations.EPSG, (String[]) null)
.rename(Citations.NETCDF, (String[]) null) // "scale_factor_at_projection_origin" is too specific.
.rename(Citations.GEOTIFF, (String[]) null) // "ScaleAtNatOrigin" is too specific.
.setRemarks(remarks).setDeprecated(true));
PARAMETERS = builder
.addIdentifier( "9805")
.addName( "Mercator (variant B)") // Starting from EPSG version 7.6
.addName( "Mercator (2SP)") // Prior to EPSG version 7.6
.addName(Citations.OGC, "Mercator_2SP")
.addName(Citations.ESRI, "Mercator")
.addName(Citations.NETCDF, "Mercator")
.addName(sameNameAs(Citations.PROJ4, Mercator1SP.PARAMETERS))
.addIdentifier(Citations.MAP_INFO, "26") // MapInfo names this projection "Regional Mercator".
.addIdentifier(Citations.S57, "8")
.createGroupForMapProjection(
STANDARD_PARALLEL,
latitudeOfOrigin, // Not formally a Mercator2SP parameter.
Mercator1SP.LONGITUDE_OF_ORIGIN,
SCALE_FACTOR, // Not formally a Mercator2SP parameter.
FALSE_EASTING,
FALSE_NORTHING);
}
/**
* Constructs a new provider.
*/
public Mercator2SP() {
super(PARAMETERS);
}
}