TLcdObliqueMercator (LuciadFusion API documentation)

java.lang.Object
- com.luciad.projection.ALcdProjection
- - com.luciad.projection.ALcdObliqueCylindrical
  - - com.luciad.projection.TLcdObliqueMercator

All Implemented Interfaces:

ILcdObliqueCylindrical, ILcdProjection, ILcdPropertyChangeSource, Serializable, Cloneable
```
public class TLcdObliqueMercator
extends ALcdObliqueCylindrical
```
Oblique Mercator projection.

Introduction

Oblique Mercator projection for the State Plane Coordinate System. There are several ways to define this projection. Only the one using an origin and an azimuth at that origin is considered now.

Properties
- The projection is conformal.
- Two particular meridians 180° apart are straight lines.
- Other meridians and parallels are complex curves.
- Scale on the spherical form is true along the chosen central line.
- It is also true along a great circle at an oblique angle or along two straight lines parallel to the chosen central line.
- Scale becomes infinite 90° from the central line.
Example

Sample code
```
 ILcdProjection projection =
     new TLcdObliqueMercator(-30.0, 20.0, 30.0);
 
```
Implementation aspects

The equations of the oblique mercator projection are taken from [Snyder1987].
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TLcdObliqueMercator.Variant
The variant of this projection.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TLcdObliqueMercator.Variant` The variant of this projection.

Field Summary
- Fields inherited from class com.luciad.projection.ALcdProjection
  fPropertyChangeDispatcher
- Fields inherited from interface com.luciad.projection.ILcdProjection
  EPSILON

Constructor Summary

Constructors
Constructor and Description
`TLcdObliqueMercator()` Constructs a oblique mercator projection.
`TLcdObliqueMercator(double aCentralMeridian, double aStandardParallel, double aAzimuth)` Constructs a oblique mercator projection.
`TLcdObliqueMercator(double aCentralMeridian, double aStandardParallel, double aAzimuth, TLcdObliqueMercator.Variant aVariant)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double[][]`	`boundaryLats(double lon)` Default implementation.
`double[][]`	`boundaryLons(double lat)` Default implementation.
`protected void`	`calculateCachedValues()` Constants based on the longitude, latitude, standard parallel, and azimuth of the projection don't have to be recalculated every time a method is called.
`Object`	`clone()` Makes a deep clone of this `ILcdProjection`.
`boolean`	`equals(Object o)` Checks if this `ILcdProjection` equals some other Object.
`TLcdObliqueMercator.Variant`	`getVariant()` Returns the variant of this projection.
`int`	`hashCode()`
`boolean`	`inLonLatBounds(ILcdPoint aLLP)` Checks if an `ILcdPoint` is inside the valid area of geodetic coordinates of the projection.
`boolean`	`inWorldBoundsOnEllipsoid(ILcdPoint aXYPoint, ILcdEllipsoid aEllipsoid)` Default implementation calls `inWorldBoundsOnSphere` with `aEllipsoid.getAuxRadius()` as sphere radius.
`boolean`	`inWorldBoundsOnSphere(ILcdPoint aXYPoint, double aRadius)` Checks if a `ILcdPoint` is inside the valid cartesian area of the projection.
`boolean`	`isAllInBounds()` If all geodetic coordinates (l ,j ) are projected (visible) by an `ILcdProjection` and all (x,y ) coordinates are bounded this is `true`.
`boolean`	`isContinuous()` An `ILcdProjection` is continuous if there are no interruptions in the world coordinates.
`void`	`loadProperties(String aPrefix, Properties aProperty)` Loads the 3 properties of an `ALcdObliqueCylindrical`: the centralMeridian, the azimuth and the standardParallel.
`void`	`lonlatheight2worldOnEllipsoidSFCT(ILcdPoint aLLP, ILcdEllipsoid aEllipsoid, ILcd2DEditablePoint aXYPointSFCT)` Default implementation calls `lonlatheight2worldOnEllipsoidSFCT` with `aEllipsoid.getAuxRadius()` as sphere radius.
`void`	`lonlatheight2worldOnSphereSFCT(ILcdPoint aLLHP, double aRadius, ILcd2DEditablePoint aXYPointSFCT)` Transforms an `ILcd2DEditablePoint` on a sphere into the cartesian coordinate system of the projection.
`void`	`setAzimuth(double aAzimuth)` Sets the azimuth of this `ILcdObliqueCylindrical` to `aAzimuth`.
`void`	`setCentralMeridian(double aCentralMeridian)` Sets the centralMeridian of this `ILcdObliqueCylindrical` to the meridian with longitude `aLongitude`.
`void`	`setStandardParallel(double aStandardParallel)` Sets the standardParallel of this `ILcdObliqueCylindrical` to the parallel with latitude `aLatitude`.
`String`	`toString()` Returns the `String` representation of the oblique mercator projection.
`void`	`world2DEditableBoundsOnEllipsoidSFCT(ILcdEllipsoid aEllipsoid, ILcd2DEditableBounds aWorldBoundsSFCT)` Default implementation calls `world2lonlatOnSphereSFCT` with `aEllipsoid.getAuxRadius()` as sphere radius.
`void`	`world2DEditableBoundsOnSphereSFCT(double aRadius, ILcd2DEditableBounds aWorldBound)` Sets the `ILcd2DEditableBounds` object to the bounds of the projection in world coordinates.
`void`	`world2lonlatOnEllipsoidSFCT(ILcdPoint aXYPoint, ILcdEllipsoid aEllipsoid, ILcd2DEditablePoint aLLPSFCT)` Default implementation calls `world2lonlatOnSphereSFCT` with `aEllipsoid.getAuxRadius()` as sphere radius.
`void`	`world2lonlatOnSphereSFCT(ILcdPoint aXYPoint, double aRadius, ILcd2DEditablePoint aLLPSFCT)` Transforms an `ILcdPoint` from the cartesian coordinate system of the projection into an `ILcd2DEditablePoint` onto a sphere.
`void`	`writePropertiesSFCT(String aPrefix, Properties aPropertySFCT)` Writes the 3 properties of an `ALcdObliqueCylindrical`: the centralMeridian, the azimuth and the standardParallel.

Methods inherited from class com.luciad.projection.ALcdObliqueCylindrical
getAzimuth, getCentralMeridian, getOrigin, getStandardParallel

Methods inherited from class com.luciad.projection.ALcdProjection
addPropertyChangeListener, firePropertyChangeEvent, removePropertyChangeListener

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource
addPropertyChangeListener, removePropertyChangeListener

- Constructor Detail
  - TLcdObliqueMercator
```
public TLcdObliqueMercator()
```
    Constructs a oblique mercator projection. All property values (centralMeridian, standardParallel, and azimuth are set to zero.
  - TLcdObliqueMercator
```
public TLcdObliqueMercator(double aCentralMeridian,
                           double aStandardParallel,
                           double aAzimuth)
```
    Constructs a oblique mercator projection.
    
    Parameters:
    
    aCentralMeridian - the value for the central meridian property.
    
    aStandardParallel - the value for the standard parallel property.
    
    aAzimuth - the value for the azimuth property.
  - TLcdObliqueMercator
```
public TLcdObliqueMercator(double aCentralMeridian,
                           double aStandardParallel,
                           double aAzimuth,
                           TLcdObliqueMercator.Variant aVariant)
```
- Method Detail
  - setStandardParallel
```
public void setStandardParallel(double aStandardParallel)
```
    Description copied from interface: ILcdObliqueCylindrical
    
    Sets the standardParallel of this ILcdObliqueCylindrical to the parallel with latitude aLatitude.
    
    Specified by:
    
    setStandardParallel in interface ILcdObliqueCylindrical
    
    Overrides:
    
    setStandardParallel in class ALcdObliqueCylindrical
    
    Parameters:
    
    aStandardParallel - The new standardParallel value.
    
    See Also:
    
    ILcdObliqueCylindrical.getStandardParallel()
  - setCentralMeridian
```
public void setCentralMeridian(double aCentralMeridian)
```
    Description copied from interface: ILcdObliqueCylindrical
    
    Sets the centralMeridian of this ILcdObliqueCylindrical to the meridian with longitude aLongitude.
    
    Specified by:
    
    setCentralMeridian in interface ILcdObliqueCylindrical
    
    Overrides:
    
    setCentralMeridian in class ALcdObliqueCylindrical
    
    Parameters:
    
    aCentralMeridian - The new centralMeridian value.
    
    See Also:
    
    ILcdObliqueCylindrical.getCentralMeridian()
  - setAzimuth
```
public void setAzimuth(double aAzimuth)
```
    Description copied from interface: ILcdObliqueCylindrical
    
    Sets the azimuth of this ILcdObliqueCylindrical to aAzimuth.
    
    Specified by:
    
    setAzimuth in interface ILcdObliqueCylindrical
    
    Overrides:
    
    setAzimuth in class ALcdObliqueCylindrical
    
    Parameters:
    
    aAzimuth - The new azimuth value.
    
    See Also:
    
    ILcdObliqueCylindrical.getAzimuth()
  - getVariant
```
public TLcdObliqueMercator.Variant getVariant()
```
    Returns the variant of this projection.
    
    Returns:
    
    the variant of this projection.
  - lonlatheight2worldOnSphereSFCT
```
public void lonlatheight2worldOnSphereSFCT(ILcdPoint aLLHP,
                                           double aRadius,
                                           ILcd2DEditablePoint aXYPointSFCT)
                                    throws TLcdOutOfBoundsException
```
    Description copied from interface: ILcdProjection
    
    Transforms an ILcd2DEditablePoint on a sphere into the cartesian coordinate system of the projection.
    
    Parameters:
    
    aLLHP - point to be projected.
    
    aRadius - radius of the sphere (meters).
    
    aXYPointSFCT - 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.
    
    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.
  - 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.
    
    Returns:
    
    true if all LonLatPoints are within the bounds of the projection, false otherwise.
  - 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
    
    Overrides:
    
    isContinuous in class ALcdObliqueCylindrical
    
    Returns:
    
    true if the projection is continuous, false otherwise.
  - 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.
    
    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.
    
    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 aWorldBound)
```
    Description copied from interface: ILcdProjection
    
    Sets the ILcd2DEditableBounds object to the bounds of the projection in world coordinates.
    
    Parameters:
    
    aRadius - radius of the sphere.
    
    aWorldBound - the bounds of the projection in world coordinates as side effect.
  - calculateCachedValues
```
protected void calculateCachedValues()
```
    Description copied from class: ALcdObliqueCylindrical
    
    Constants based on the longitude, latitude, standard parallel, and azimuth of the projection don't have to be recalculated every time a method is called. They only have to be calculated when the projection properties change. Within the methods the precalculated values then can be used in order to gain efficiency.
    
    Overrides:
    
    calculateCachedValues in class ALcdObliqueCylindrical
  - lonlatheight2worldOnEllipsoidSFCT
```
public void lonlatheight2worldOnEllipsoidSFCT(ILcdPoint aLLP,
                                              ILcdEllipsoid aEllipsoid,
                                              ILcd2DEditablePoint aXYPointSFCT)
                                       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:
    
    aLLP - point to be projected.
    
    aEllipsoid - ellipsoid on which the point is defined.
    
    aXYPointSFCT - 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.
  - 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.
  - 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:
    
    ILcdProjection.inWorldBoundsOnSphere(com.luciad.shape.ILcdPoint, double)
  - 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.
  - 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 ALcdObliqueCylindrical
    
    Returns:
    
    deep clone of this ILcdProjection.
  - toString
```
public String toString()
```
    Returns the String representation of the oblique mercator projection.
    
    Specified by:
    
    toString in interface ILcdProjection
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the String representation of the oblique mercator 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 ALcdObliqueCylindrical
    
    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 ALcdObliqueCylindrical
  - loadProperties
```
public void loadProperties(String aPrefix,
                           Properties aProperty)
                    throws IllegalArgumentException
```
    Description copied from class: ALcdObliqueCylindrical
    Loads the 3 properties of an ALcdObliqueCylindrical: the centralMeridian, the azimuth and the standardParallel. This method will, given aPrefix, analyze the aProperties object to set the properties of this ALcdObliqueCylindrical. The values of following keys are retrieved:
    - <aPrefix><the name of the class that extends this abstract class>.centralMeridian
    - <aPrefix><the name of the class that extends this abstract class>.standardParallel
    - <aPrefix><the name of the class that extends this abstract class>.azimuth
    Specified by:
    
    loadProperties in interface ILcdProjection
    
    Overrides:
    
    loadProperties in class ALcdObliqueCylindrical
    
    Parameters:
    
    aPrefix - prefix of the property names.
    
    aProperty - Properties object containing the serialized properties.
    
    Throws:
    
    IllegalArgumentException - if the projection cannot be created.
  - writePropertiesSFCT
```
public void writePropertiesSFCT(String aPrefix,
                                Properties aPropertySFCT)
```
    Description copied from class: ALcdObliqueCylindrical
    Writes the 3 properties of an ALcdObliqueCylindrical: the centralMeridian, the azimuth and the standardParallel. This method will, given aPrefix, store the properties of this ALcdObliqueCylindrical into the aProperties object. The values of following keys are stored:
    - <aPrefix><the name of the class that extends this abstract class>.centralMeridian
    - <aPrefix><the name of the class that extends this abstract class>.standardParallel
    - <aPrefix><the name of the class that extends this abstract class>.azimuth
    Specified by:
    
    writePropertiesSFCT in interface ILcdProjection
    
    Overrides:
    
    writePropertiesSFCT in class ALcdObliqueCylindrical
    
    Parameters:
    
    aPrefix - prefix for the property names.
    
    aPropertySFCT - Properties object to store the serialized properties by side effect.

LuciadFusionClass TLcdObliqueMercator

Introduction

Properties

Example

Sample code

Implementation aspects

Nested Class Summary

Field Summary

Fields inherited from class com.luciad.projection.ALcdProjection

Fields inherited from interface com.luciad.projection.ILcdProjection

Constructor Summary

Method Summary

Methods inherited from class com.luciad.projection.ALcdObliqueCylindrical

Methods inherited from class com.luciad.projection.ALcdProjection

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.util.ILcdPropertyChangeSource

Constructor Detail

TLcdObliqueMercator

TLcdObliqueMercator

TLcdObliqueMercator

Method Detail

setStandardParallel

setCentralMeridian

setAzimuth

getVariant

lonlatheight2worldOnSphereSFCT

world2lonlatOnSphereSFCT

isAllInBounds

isContinuous

inLonLatBounds

boundaryLons

boundaryLats

inWorldBoundsOnSphere

world2DEditableBoundsOnSphereSFCT

calculateCachedValues

lonlatheight2worldOnEllipsoidSFCT

world2lonlatOnEllipsoidSFCT

inWorldBoundsOnEllipsoid

world2DEditableBoundsOnEllipsoidSFCT

clone

toString

equals

hashCode

loadProperties

writePropertiesSFCT