blob: 41fe49c66c5be0889b187baad3876bea3239d3cf [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.referencing.operation.PlanarProjection;
import org.apache.sis.parameter.Parameters;
import org.apache.sis.parameter.ParameterBuilder;
import org.apache.sis.metadata.iso.citation.Citations;
import org.apache.sis.referencing.operation.projection.NormalizedProjection;
import static org.apache.sis.internal.referencing.provider.AbstractProvider.builder;
/**
* The provider for <cite>"Orthographic"</cite> projection (EPSG:9840).
*
* @author Rueben Schulz (UBC)
* @author Martin Desruisseaux (Geomatys)
*
* @see <a href="http://geotiff.maptools.org/proj_list/orthographic.html">GeoTIFF parameters for Orthographic</a>
*
* @version 1.1
* @since 1.1
* @module
*/
@XmlTransient
public class Orthographic extends MapProjection {
/**
* For compatibility with different versions during deserialization.
*/
private static final long serialVersionUID = -8669271590570783071L;
/**
* The operation parameter descriptor for the <cite>Latitude of natural origin</cite> (φ₀) parameter value.
* Valid values can be -90° or 90° only. There is no default value.
*
* <!-- Generated by ParameterNameTableGenerator -->
* <table class="sis">
* <caption>Parameter names</caption>
* <tr><td> EPSG: </td><td> Latitude of natural origin </td></tr>
* <tr><td> OGC: </td><td> latitude_of_origin </td></tr>
* <tr><td> ESRI: </td><td> Latitude_Of_Center </td></tr>
* <tr><td> NetCDF: </td><td> latitude_of_projection_origin </td></tr>
* <tr><td> GeoTIFF: </td><td> CenterLat </td></tr>
* <tr><td> Proj4: </td><td> lat_0 </td></tr>
* </table>
*/
public static final ParameterDescriptor<Double> LATITUDE_OF_ORIGIN;
/**
* The operation parameter descriptor for the <cite>Longitude of natural origin</cite> (λ₀) parameter value.
* Valid values range is [-180 … 180]° and default value is 0°.
*
* <!-- Generated by ParameterNameTableGenerator -->
* <table class="sis">
* <caption>Parameter names</caption>
* <tr><td> EPSG: </td><td> Longitude of natural origin </td></tr>
* <tr><td> OGC: </td><td> central_meridian </td></tr>
* <tr><td> ESRI: </td><td> Longitude_Of_Center </td></tr>
* <tr><td> NetCDF: </td><td> longitude_of_projection_origin </td></tr>
* <tr><td> GeoTIFF: </td><td> CenterLong </td></tr>
* <tr><td> Proj4: </td><td> lon_0 </td></tr>
* </table>
*/
public static final ParameterDescriptor<Double> LONGITUDE_OF_ORIGIN;
/**
* The operation parameter descriptor for the <cite>Scale factor at natural origin</cite> (k₀) parameter value.
* Valid values range is (0 … ∞) and default value is 1. This is not formally a parameter of this projection.
*
* <!-- 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>Optional</li>
* </ul>
*/
public static final ParameterDescriptor<Double> SCALE_FACTOR = Mercator2SP.SCALE_FACTOR;
/**
* The operation parameter descriptor for the <cite>False easting</cite> (FE) parameter value.
* Valid values range is unrestricted and default value is 0 metre.
*
* <!-- Generated by ParameterNameTableGenerator -->
* <table class="sis">
* <caption>Parameter names</caption>
* <tr><td> EPSG: </td><td> False easting </td></tr>
* <tr><td> OGC: </td><td> false_easting </td></tr>
* <tr><td> ESRI: </td><td> False_Easting </td></tr>
* <tr><td> NetCDF: </td><td> false_easting </td></tr>
* <tr><td> GeoTIFF: </td><td> FalseEasting </td></tr>
* <tr><td> Proj4: </td><td> x_0 </td></tr>
* </table>
*/
public static final ParameterDescriptor<Double> FALSE_EASTING = LambertConformal1SP.FALSE_EASTING;
/**
* The operation parameter descriptor for the <cite>False northing</cite> (FN) parameter value.
* Valid values range is unrestricted and default value is 0 metre.
*
* <!-- Generated by ParameterNameTableGenerator -->
* <table class="sis">
* <caption>Parameter names</caption>
* <tr><td> EPSG: </td><td> False northing </td></tr>
* <tr><td> OGC: </td><td> false_northing </td></tr>
* <tr><td> ESRI: </td><td> False_Northing </td></tr>
* <tr><td> NetCDF: </td><td> false_northing </td></tr>
* <tr><td> GeoTIFF: </td><td> FalseNorthing </td></tr>
* <tr><td> Proj4: </td><td> y_0 </td></tr>
* </table>
*/
public static final ParameterDescriptor<Double> FALSE_NORTHING = LambertConformal1SP.FALSE_NORTHING;
/**
* The group of all parameters expected by this coordinate operation.
*/
static final ParameterDescriptorGroup PARAMETERS;
static {
final ParameterBuilder builder = builder();
LATITUDE_OF_ORIGIN = createLatitude(
renameAlias(builder, LambertConformal1SP.LATITUDE_OF_ORIGIN, // Copy from this parameter…
Citations.ESRI, ObliqueMercator.LATITUDE_OF_CENTRE, // … except for this name.
Citations.GEOTIFF, ObliqueMercator.LATITUDE_OF_CENTRE), true);
LONGITUDE_OF_ORIGIN = createLongitude(
renameAlias(builder, LambertConformal1SP.LONGITUDE_OF_ORIGIN,
Citations.ESRI, ObliqueMercator.LONGITUDE_OF_CENTRE,
Citations.GEOTIFF, ObliqueMercator.LONGITUDE_OF_CENTRE));
PARAMETERS = builder.addIdentifier("9840")
.addName( "Orthographic")
.addName(Citations.OGC, "Orthographic")
.addName(Citations.ESRI, "Orthographic")
.addName(Citations.NETCDF, "Orthographic")
.addName(Citations.GEOTIFF, "CT_Orthographic")
.addName(Citations.S57, "Orthographic")
.addName(Citations.S57, "ORT")
.addName(Citations.PROJ4, "ortho")
.addIdentifier(Citations.GEOTIFF, "21")
.addIdentifier(Citations.S57, "10")
.createGroupForMapProjection(
LATITUDE_OF_ORIGIN,
LONGITUDE_OF_ORIGIN,
SCALE_FACTOR,
FALSE_EASTING,
FALSE_NORTHING);
}
/**
* Constructs a new provider.
*/
public Orthographic() {
super(PARAMETERS);
}
/**
* Returns the operation type for this map projection.
*/
@Override
public Class<PlanarProjection> getOperationType() {
return PlanarProjection.class;
}
/**
* {@inheritDoc}
*
* @return the map projection created from the given parameter values.
*/
@Override
protected final NormalizedProjection createProjection(final Parameters parameters) {
return new org.apache.sis.referencing.operation.projection.Orthographic(this, parameters);
}
}