fr.cnes.sirius.patrius.projections
Interface IProjection

All Superinterfaces:
Serializable
All Known Implementing Classes:
AbstractProjection, GeneralizedFlamsteedSamson, IdentityProjection, Mercator

public interface IProjection
extends Serializable

Interface for projections on an ellipsoid.

Since:
3.2
Version:
$Id: IProjection.java 15925 2016-04-18 11:58:18Z bignon $
Author:
Galpin Thomas

Method Summary
 GeodeticPoint applyInverseTo(double x, double y)
          Inverse projection.
 GeodeticPoint applyInverseTo(double x, double y, double alt)
          This is the Two standard parallel Mercator Projection model.
 Vector2D applyTo(double lat, double lon)
          Returns Easting value and Northing value in meters from latitude and longitude coordinates.
 Vector2D applyTo(GeodeticPoint geodeticPoint)
          Returns Easting value and Northing value in meters from geodetic coordinates.
 boolean canMap(GeodeticPoint geodeticPoint)
          Returns a boolean depending if the geodetic point can be map with the selected projection method.
 EnumLineProperty getLineProperty()
          Getter for line property .
 double getMaximumEastingValue()
          Getter for the maximum value for X projected.
 double getMaximumLatitude()
          Getter for the maximum latitude that the projection can map.
 BodyShape getReference()
          Get the system of reference used.
 boolean isConformal()
          Inform the user if the direct transformation is a conformal 's one (If yes, it preserves angles).
 boolean isEquivalent()
          Inform the user if the direct transformation is an equivalent 's one (If yes, it preserves surfaces).
 

Method Detail

canMap

boolean canMap(GeodeticPoint geodeticPoint)
Returns a boolean depending if the geodetic point can be map with the selected projection method.

Parameters:
geodeticPoint - geodetic point to test if representable.
Returns:
True if the geodetic point can be represented on the map with the chosen projection method.

applyTo

Vector2D applyTo(GeodeticPoint geodeticPoint)
                 throws OrekitException
Returns Easting value and Northing value in meters from geodetic coordinates.

Parameters:
geodeticPoint - the geodetic point to transform.
Returns:
Vector2D containing Easting value and Northing value in meters.
Throws:
OrekitException - thrown if projection could not be computed

applyTo

Vector2D applyTo(double lat,
                 double lon)
                 throws OrekitException
Returns Easting value and Northing value in meters from latitude and longitude coordinates.

Parameters:
lat - latitude of the point to project.
lon - longitude of the point to project.
Returns:
Vector2D containing Easting value and Northing value in meters.
Throws:
OrekitException - thrown if projection could not be computed

applyInverseTo

GeodeticPoint applyInverseTo(double x,
                             double y)
                             throws OrekitException
Inverse projection. Returns geodetic coordinates.

Parameters:
x - abscissa coordinate
y - ordinate coordinate
Returns:
geodetic coordinates.
Throws:
OrekitException - thrown if inverse projection could not be computed

applyInverseTo

GeodeticPoint applyInverseTo(double x,
                             double y,
                             double alt)
                             throws OrekitException
This is the Two standard parallel Mercator Projection model. The latitude and the longitude of the given point to convert can be defined from any natural origin and the user can set the altitude.

Parameters:
x - abscissa coordinate
y - ordinate coordinate
alt - altitude coordinate
Returns:
coordinate
Throws:
OrekitException - thrown if inverse projection could not be computed

isConformal

boolean isConformal()
Inform the user if the direct transformation is a conformal 's one (If yes, it preserves angles).

Returns:
a boolean.

isEquivalent

boolean isEquivalent()
Inform the user if the direct transformation is an equivalent 's one (If yes, it preserves surfaces).

Returns:
a boolean.

getLineProperty

EnumLineProperty getLineProperty()
Getter for line property .

Returns:
line property.

getMaximumLatitude

double getMaximumLatitude()
Getter for the maximum latitude that the projection can map.

Returns:
Maximum latitude that the projection can map.

getMaximumEastingValue

double getMaximumEastingValue()
Getter for the maximum value for X projected.

Returns:
the Maximum value for X projected.

getReference

BodyShape getReference()
Get the system of reference used.

Returns:
System of reference.


Copyright © 2016 CNES. All Rights Reserved.