Package com.luciad.projection

Class TLcdPolarStereographic

java.lang.Object
com.luciad.projection.ALcdProjection
com.luciad.projection.TLcdPolarStereographic
All Implemented Interfaces:
ILcdProjection, ILcdPropertyChangeSource, Serializable, Cloneable
public class TLcdPolarStereographic extends ALcdProjection implements Cloneable
Polar stereographic projection.

Introduction

Azimuthal conformal projection with a projection point opposite the origin of the projection, which is either the north pole or the south pole. Default construction is the north polar aspect.

Properties

  • All meridians are projected as straight lines.
  • All parallels are projected as arcs of circles.
  • Directions from the projection origin are true.
  • Scale increases away from the projection origin.
  • It is not possible to plot the point opposite the projection origin.

Example

Sample code


 ILcdProjection projection =
     new TLcdPolarStereographic(TLcdPolarStereographic.NORTH_POLE);

Implementation aspects

The equations of the polar stereographic projection are taken from [Snyder1987].

See Also:

  • Field Details

    • NORTH_POLE

      public static final int NORTH_POLE
      Constant used to specify the polar stereographic projection is set for the north polar aspect.
      See Also:

    • SOUTH_POLE

      public static final int SOUTH_POLE
      Constant used to specify the polar stereographic projection is set for the south polar aspect.
      See Also:

  • Constructor Details

    • TLcdPolarStereographic

      public TLcdPolarStereographic()
      Constructs a polar stereographic projection for a sphere with the origin at the north pole.

    • TLcdPolarStereographic

      public TLcdPolarStereographic(int aPole)
      Constructs a polar stereographic projection for a sphere with the origin at the north pole or the south pole.
      Parameters:
      aPole - pole that is the origin of the projection, NORTH_POLE for north pole, SOUTH_POLE for south pole.
      See Also:

  • Method Details

    • getOrigin

      public ILcdPoint getOrigin()
      Description copied from interface: ILcdProjection
      Origin of the projection is the ILcd2DEditablePoint that corresponds with origin (0, 0) of the cartesian coordinate system of the projection.
      Specified by:
      getOrigin in interface ILcdProjection
      Returns:
      the origin of the projection.

    • setPole

      public void setPole(int aPole)
      Sets the polar aspect of the polar stereographic projection.
      Parameters:
      aPole - the new pole property value which is either NORTH_POLE or SOUTH_POLE.
      See Also:

    • getPole

      public int getPole()
      Returns the polar aspect of the polar stereographic projection.
      Returns:
      the polar aspect of the polar stereographic projection.
      See Also:

    • getCentralMeridian

      public double getCentralMeridian()
      Returns the meridian that is projected as a line along the Y-axis in the projected plane.
      Returns:
      the meridian that is projected as a line along the Y-axis in the projected plane. Default value is 0.
      See Also:

    • setCentralMeridian

      public void setCentralMeridian(double aCentralMeridian)
      Sets the meridian that should be a line along the Y-axis in the projected plane.
      Parameters:
      aCentralMeridian - the meridian that should become a line along the Y-axis in the projected plane. Should be a value between -180 and 180. Default value is 0.
      See Also:

    • getTrueScaleLatitude

      public double getTrueScaleLatitude()
      Returns the latitude which is made standard, with true scale.
      Returns:
      the latitude which is true to scale.

    • setTrueScaleLatitude

      public void setTrueScaleLatitude(double aLatitude)
      Sets the latitude which is made standard, with true scale. Note that the parallel with the opposite latitude automatically becomes standard as well.
      Parameters:
      aLatitude - the latitude which is true to scale

    • isContinuous

      public boolean isContinuous()
      Description copied from interface: ILcdProjection
      An ILcdProjection is continuous if there are no interruptions in the world coordinates. Most projections are continuous.
      Specified by:
      isContinuous in interface ILcdProjection
      Returns:
      true if the projection is continuous, false otherwise.

    • isAllInBounds

      public boolean isAllInBounds()
      Description copied from interface: ILcdProjection
      If all geodetic coordinates (l ,j ) are projected (visible) by an ILcdProjection and all (x,y ) coordinates are bounded this is true. All ILcdProjection objects have bounded (x,y ) coordinates because the projection is cut off if necessary.
      Specified by:
      isAllInBounds in interface ILcdProjection
      Returns:
      true if all LonLatPoints are within the bounds of the projection, false otherwise.

    • lonlatheight2worldOnSphereSFCT

      public void lonlatheight2worldOnSphereSFCT(ILcdPoint aLLHP, double aRadius, ILcd2DEditablePoint aWorldPoint) throws TLcdOutOfBoundsException
      Description copied from interface: ILcdProjection
      Transforms an ILcd2DEditablePoint on a sphere into the cartesian coordinate system of the projection.
      Specified by:
      lonlatheight2worldOnSphereSFCT in interface ILcdProjection
      Parameters:
      aLLHP - point to be projected.
      aRadius - radius of the sphere (meters).
      aWorldPoint - projected point as side effect.
      Throws:
      TLcdOutOfBoundsException - If the ILcdPoint aLLHP is not within the valid area of the projection (visible area), then this exception is thrown.

    • lonlatheight2worldOnEllipsoidSFCT

      public void lonlatheight2worldOnEllipsoidSFCT(ILcdPoint aLLHP, ILcdEllipsoid aEllipsoid, ILcd2DEditablePoint aWorldPoint) throws TLcdOutOfBoundsException
      Description copied from class: ALcdProjection
      Default implementation calls lonlatheight2worldOnEllipsoidSFCT with aEllipsoid.getAuxRadius() as sphere radius.
      Specified by:
      lonlatheight2worldOnEllipsoidSFCT in interface ILcdProjection
      Overrides:
      lonlatheight2worldOnEllipsoidSFCT in class ALcdProjection
      Parameters:
      aLLHP - point to be projected.
      aEllipsoid - ellipsoid on which the point is defined.
      aWorldPoint - projected point as side effect.
      Throws:
      TLcdOutOfBoundsException - If the ILcdPoint aLLHP is not within the valid area of the projection (visible area), then this exception is thrown.

    • world2lonlatOnSphereSFCT

      public void world2lonlatOnSphereSFCT(ILcdPoint aXYPoint, double aRadius, ILcd2DEditablePoint aLLPSFCT) throws TLcdOutOfBoundsException
      Description copied from interface: ILcdProjection
      Transforms an ILcdPoint from the cartesian coordinate system of the projection into an ILcd2DEditablePoint onto a sphere.
      Specified by:
      world2lonlatOnSphereSFCT in interface ILcdProjection
      Parameters:
      aXYPoint - projected point for which the corresponding geodetic point is sought.
      aRadius - radius of the sphere (meters).
      aLLPSFCT - resulting geodetic coordinate as side effect.
      Throws:
      TLcdOutOfBoundsException - If the ILcdPoint aXYPoint is not within the valid area of the projection (visible area), then this exception is thrown.

    • world2lonlatOnEllipsoidSFCT

      public void world2lonlatOnEllipsoidSFCT(ILcdPoint aXYPoint, ILcdEllipsoid aEllipsoid, ILcd2DEditablePoint aLLPSFCT) throws TLcdOutOfBoundsException
      Description copied from class: ALcdProjection
      Default implementation calls world2lonlatOnSphereSFCT with aEllipsoid.getAuxRadius() as sphere radius.
      Specified by:
      world2lonlatOnEllipsoidSFCT in interface ILcdProjection
      Overrides:
      world2lonlatOnEllipsoidSFCT in class ALcdProjection
      Parameters:
      aXYPoint - projected point for which the corresponding geodetic point is sought.
      aEllipsoid - ellipsoid on which the geodetic coordinate is defined.
      aLLPSFCT - resulting geodetic coordinate as side effect.
      Throws:
      TLcdOutOfBoundsException - If the ILcdPoint aXYPoint is not within the valid area of the projection (visible area), then this exception is thrown.

    • inLonLatBounds

      public boolean inLonLatBounds(ILcdPoint aLLP)
      Description copied from interface: ILcdProjection
      Checks if an ILcdPoint is inside the valid area of geodetic coordinates of the projection. The valid area is determined by the LonLatPoints that are visible and for which the corresponding cartesian coordinate is within the boundaries.
      Specified by:
      inLonLatBounds in interface ILcdProjection
      Parameters:
      aLLP - ILcdPoint to be checked upon.
      Returns:
      true if valid, false if invalid.

    • boundaryLons

      public double[][] boundaryLons(double lat)
      Description copied from class: ALcdProjection
      Default implementation. To be redefined for specific projections.
      Specified by:
      boundaryLons in interface ILcdProjection
      Overrides:
      boundaryLons in class ALcdProjection
      Parameters:
      lat - latitude in decimal degrees and -90.0 <= aLat<= 90.0.
      Returns:
      the array of pairs of longitudes[0] and longitudes[1], where the closed interval longitudes[0] -> longitudes[1] is in visible area and -180.0 <= lon[i] <= 180.0.

    • boundaryLats

      public double[][] boundaryLats(double lon)
      Description copied from class: ALcdProjection
      Default implementation. To be redefined for specific projections.
      Specified by:
      boundaryLats in interface ILcdProjection
      Overrides:
      boundaryLats in class ALcdProjection
      Parameters:
      lon - longitude in decimal degrees -180.0 <= lon <= 180.0 .
      Returns:
      the array of pairs of latitudes lats[0] and lats[1], where the closed interval lats[0] -> lats[1] is in visible area and -90.0 <= lats[i] <= 90.0 .

    • inWorldBoundsOnSphere

      public boolean inWorldBoundsOnSphere(ILcdPoint aXYPoint, double aRadius)
      Description copied from interface: ILcdProjection
      Checks if a ILcdPoint is inside the valid cartesian area of the projection. The valid cartesian area is determined naturally by the projection bounds or by an artificial introduced boundary limit because some cartesian points are at infinity. The shape of the valid cartesian area is in many cases rectangular or circular although it might be more complex.
      Specified by:
      inWorldBoundsOnSphere in interface ILcdProjection
      Parameters:
      aXYPoint - point to be checked upon.
      aRadius - radius of the sphere.
      Returns:
      true if valid, false if invalid.

    • world2DEditableBoundsOnSphereSFCT

      public void world2DEditableBoundsOnSphereSFCT(double aRadius, ILcd2DEditableBounds aWorldBoundsSFCT)
      Projections is cut off: only one hemisphere is shown.
      Specified by:
      world2DEditableBoundsOnSphereSFCT in interface ILcdProjection
      Parameters:
      aRadius - radius of the sphere.
      aWorldBoundsSFCT - the bounds of the projection in world coordinates as side effect.

    • inWorldBoundsOnEllipsoid

      public boolean inWorldBoundsOnEllipsoid(ILcdPoint aXYPoint, ILcdEllipsoid aEllipsoid)
      Description copied from class: ALcdProjection
      Default implementation calls inWorldBoundsOnSphere with aEllipsoid.getAuxRadius() as sphere radius.
      Specified by:
      inWorldBoundsOnEllipsoid in interface ILcdProjection
      Overrides:
      inWorldBoundsOnEllipsoid in class ALcdProjection
      Parameters:
      aXYPoint - point to be checked upon.
      aEllipsoid - ellipsoid on which the geodetic coordinate is defined.
      Returns:
      true if valid, false if invalid.
      See Also:

    • world2DEditableBoundsOnEllipsoidSFCT

      public void world2DEditableBoundsOnEllipsoidSFCT(ILcdEllipsoid aEllipsoid, ILcd2DEditableBounds aWorldBoundsSFCT)
      Description copied from class: ALcdProjection
      Default implementation calls world2lonlatOnSphereSFCT with aEllipsoid.getAuxRadius() as sphere radius.
      Specified by:
      world2DEditableBoundsOnEllipsoidSFCT in interface ILcdProjection
      Overrides:
      world2DEditableBoundsOnEllipsoidSFCT in class ALcdProjection
      Parameters:
      aEllipsoid - ellipsoid considered.
      aWorldBoundsSFCT - the bounds of the projection in world coordinates as side effect.

    • toString

      public String toString()
      Returns the String representation of the PolarStereographic projection.
      Specified by:
      toString in interface ILcdProjection
      Overrides:
      toString in class Object
      Returns:
      the String representation of the PolarStereographic projection.

    • equals

      public boolean equals(Object o)
      Description copied from interface: ILcdProjection
      Checks if this ILcdProjection equals some other Object.
      Specified by:
      equals in interface ILcdProjection
      Overrides:
      equals in class Object
      Parameters:
      o - Object to compare with.
      Returns:
      true if the Object is an instance of the same ILcdProjection class and having the same projection properties, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public Object clone()
      Description copied from interface: ILcdProjection
      Makes a deep clone of this ILcdProjection.
      Specified by:
      clone in interface ILcdProjection
      Overrides:
      clone in class ALcdProjection
      Returns:
      deep clone of this ILcdProjection.

    • loadProperties

      public void loadProperties(String aPrefix, Properties aProperty) throws IllegalArgumentException
      Loads the property of pole of a TLcdPolarStereographic. This method will, given aPrefix, analyze the aProperties object to set the properties of this TLcdPolarStereographic. The value of following key is retrieved:
      • <aPrefix>TLcdPolarStereographic.pole
      Specified by:
      loadProperties in interface ILcdProjection
      Parameters:
      aPrefix - prefix for property names.
      aProperty - Properties object containing the serialized projection.
      Throws:
      IllegalArgumentException

    • writePropertiesSFCT

      public void writePropertiesSFCT(String aPrefix, Properties aPropertySFCT)
      Writes the property of pole of an TLcdPolarStereographic. This method will, given aPrefix, store into the aPropertiesSFCT object the properties of this TLcdPolarStereographic. The value of following key is stored:
      • <aPrefix>TLcdPolarStereographic.pole
      Specified by:
      writePropertiesSFCT in interface ILcdProjection
      Parameters:
      aPrefix - prefix for property names.
      aPropertySFCT - Properties object in which to store the serialized projection properties as side effect.

    • getLatitudeExtent

      public double getLatitudeExtent()
      How far the projection extends from the pole, in degrees latitude. The default value is 90. This extends the polar stereographic projection up to the equator.
      Returns:
      the latitude extent of this polar stereographic projection, in degrees latitude.
      Since:
      2022.0

    • setLatitudeExtent

      public void setLatitudeExtent(double aLatitudeExtent)
      Sets the latitude extent of this Polar Stereo projection, which is how far the projection extends outwards from the poles, in degrees latitude. The default value is 90. This extends the polar stereographic projection up to the equator. Values larger than 90 extend the projection beyond the equator. The projection is only defined for extents in range ]0, 180[. Due to the large distortion beyond the equator, it's recommended to not use extents larger than 90.
      Parameters:
      aLatitudeExtent - the latitude extent of this polar stereographic projection, in degrees latitude.
      Since:
      2022.0