endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/operation/provider/Sinusoidal.java

/*
 * 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.referencing.operation.provider;

import jakarta.xml.bind.annotation.XmlTransient;
import org.opengis.parameter.ParameterDescriptor;
import org.opengis.parameter.ParameterDescriptorGroup;
import org.apache.sis.metadata.iso.citation.Citations;
import org.apache.sis.parameter.ParameterBuilder;
import org.apache.sis.parameter.Parameters;
import org.apache.sis.referencing.operation.projection.NormalizedProjection;


/**
 * The provider for <q>sinusoidal equal-area</q> projection.
 * This is a pseudo-cylindrical (or "false cylindrical") projection.
 * This projection method has no associated EPSG code.
 *
 * <h2>Departure in parameter name compared to GDAL</h2>
 * As of May 2024, the {@link #CENTRAL_MERIDIAN} parameter name declared on the GDAL web site
 * is <q>Longitude of projection center</q> for EPSG and <q>longitude_of_center</q> for OGC.
 * However, EPSG does not define this projection, and OGC names generally follow ESRI names.
 * The parameter name declared by ESRI for projection ESRI:54030 is <q>Central_Meridian</q>.
 * This class follows ESRI name for OGC and uses <q>Longitude of natural origin</q> for EPSG.
 * The latter is the name that we found in usage for WKT 2 strings, is used by PROJ implementation
 * and seems to be match better the usages in the EPSG geodetic dataset.
 *
 * @author  Martin Desruisseaux (Geomatys)
 *
 * @see <a href="https://en.wikipedia.org/wiki/Sinusoidal_projection">Sinusoidal projection on Wikipedia</a>
 * @see <a href="https://gdal.org/proj_list/sinusoidal.html">GeoTIFF parameters for Sinusoidal</a>
 */
@XmlTransient
public class Sinusoidal extends MapProjection {
    /**
     * For cross-version compatibility.
     */
    private static final long serialVersionUID = -3236247448683326299L;

    /**
     * The operation parameter descriptor for the <cite>Longitude of projection center</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> ESRI:    </td><td> Central_Meridian </td></tr>
     *   <tr><td> OGC:     </td><td> central_meridian </td></tr>
     *   <tr><td> GeoTIFF: </td><td> CenterLong </td></tr>
     *   <tr><td> Proj4:   </td><td> lon_0 </td></tr>
     *   <tr><td> EPSG:    </td><td> Longitude of natural origin </td></tr>
     * </table>
     */
    public static final ParameterDescriptor<Double> CENTRAL_MERIDIAN;

    /**
     * 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> ESRI:    </td><td> False_Easting </td></tr>
     *   <tr><td> OGC:     </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 = ESRI.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> ESRI:    </td><td> False_Northing </td></tr>
     *   <tr><td> OGC:     </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 = ESRI.FALSE_NORTHING;

    /**
     * The group of all parameters expected by this coordinate operation.
     */
    static final ParameterDescriptorGroup PARAMETERS;
    static {
        final var builder = new ParameterBuilder().setRequired(true);
        CENTRAL_MERIDIAN = createLongitude(builder.addNamesAndIdentifiers(ESRI.CENTRAL_MERIDIAN)
                .addName(Equirectangular.LONGITUDE_OF_ORIGIN.getName()));

        PARAMETERS = builder
                .addName      ("Sinusoidal")
                .addName      ("Sanson-Flamsteed")
                .addName      (Citations.GEOTIFF,  "CT_Sinusoidal")
                .addIdentifier(Citations.GEOTIFF,  "24")
                .addName      (Citations.PROJ4,    "sinu")
                .createGroupForMapProjection(CENTRAL_MERIDIAN, FALSE_EASTING, FALSE_NORTHING);
    }

    /**
     * Constructs a new provider.
     */
    public Sinusoidal() {
        this(PARAMETERS);
    }

    /**
     * Constructs a math transform provider from a set of parameters.
     *
     * @param  parameters  the set of parameters (never {@code null}).
     */
    Sinusoidal(final ParameterDescriptorGroup parameters) {
        super(parameters);
    }

    /**
     * {@inheritDoc}
     *
     * @return the map projection created from the given parameter values.
     */
    @Override
    protected NormalizedProjection createProjection(final Parameters parameters) {
        return new org.apache.sis.referencing.operation.projection.Sinusoidal(this, parameters);
    }
}