ProjectionImpl (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

java.lang.Object
- ucar.unidata.geoloc.ProjectionImpl

All Implemented Interfaces:

java.io.Serializable, Projection

Direct Known Subclasses:

AlbersEqualArea, AlbersEqualAreaEllipse, CylindricalEqualAreaProjection, EquidistantAzimuthalProjection, FlatEarth, Geostationary, LambertAzimuthalEqualArea, LambertConformal, LambertConformalConicEllipse, LatLonProjection, McIDASAreaProjection, Mercator, MSGnavigation, Orthographic, PolyconicProjection, ProjectionAdapter, RotatedLatLon, RotatedPole, Sinusoidal, Stereographic, StereographicAzimuthalProjection, TransverseMercator, TransverseMercatorProjection, UtmProjection, VerticalPerspectiveView
```
public abstract class ProjectionImpl
extends java.lang.Object
implements Projection, java.io.Serializable
```
Superclass for our implementations of geoloc.Projection.

All subclasses must:
- override equals() and return true when all parameters are equal
- create "atts" list of parameters as string-valued Attribute pairs
- implement abstract methods
If possible, set defaultmapArea to some reasonable world coord bounding box otherwise, provide a way for the user to specify it when a specific projection is created.

Note on "false_easting" and "fale_northing" projection parameters:
- false_easting(northing) = The value added to all x (y) values in the rectangular coordinates for a map projection. This value frequently is assigned to eliminate negative numbers. Expressed in the unit of measure identified in Planar Coordinate Units.
- We dont currently use, assuming that the x and y are just fine as negetive numbers.
See Also:

Projection, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<Parameter>`	`atts` list of attributes
`protected ProjectionRect`	`defaultMapArea` default map area
`static double`	`EARTH_RADIUS` Earth radius in kilometers
`static int`	`INDEX_LAT` Latitude index
`static int`	`INDEX_LON` Longitude index
`static int`	`INDEX_X` X index
`static int`	`INDEX_Y` Y index
`protected boolean`	`isLatLon` flag for latlon
`protected java.lang.String`	`name` name of this projection.
`static double`	`PI` PI
`static double`	`PI_OVER_2` PI/2
`static double`	`PI_OVER_4` PI/4
`protected static double`	`TOLERANCE` tolerence for checks

Constructor Summary

Constructors
Modifier Constructor and Description

protected ProjectionImpl(java.lang.String name, boolean isLatLon)

Constructors
Modifier	Constructor and Description
`protected`	`ProjectionImpl(java.lang.String name, boolean isLatLon)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addParameter(Parameter p)` Add an attribute to this projection
`protected void`	`addParameter(java.lang.String name, double value)` Add an attribute to this projection
`protected void`	`addParameter(java.lang.String name, java.lang.String value)` Add an attribute to this projection
`abstract ProjectionImpl`	`constructCopy()` copy constructor - avoid clone !!
`abstract boolean`	`crossSeam(ProjectionPoint pt1, ProjectionPoint pt2)` Does the line between these two points cross the projection "seam".
`abstract boolean`	`equals(java.lang.Object proj)` Returns true if this represents the same Projection as proj.
`Parameter`	`findProjectionParameter(java.lang.String want)`
`java.lang.String`	`getClassName()` Get the name of the type of the projection.
`ProjectionRect`	`getDefaultMapArea()` Get a reasonable bounding box for this projection.
`LatLonRect`	`getDefaultMapAreaLL()` Get the bounding box in lat/lon.
`static java.lang.String`	`getHeader()` Get a header for display.
`java.lang.String`	`getName()` Get the name of this specific projection (also see getClassName)
`java.util.List<Parameter>`	`getProjectionParameters()` Get parameters as list of ucar.unidata.util.Parameter
`java.lang.String`	`getProjectionTypeLabel()` Get the label to be used in the gui for this type of projection.
`boolean`	`isLatLon()` Is this the lat/lon Projection ?
`double[][]`	`latLonToProj(double[][] from)` Convert lat/lon coordinates to projection coordinates.
`double[][]`	`latLonToProj(double[][] from, double[][] to)` Convert lat/lon coordinates to projection coordinates.
`double[][]`	`latLonToProj(double[][] from, double[][] to, int latIndex, int lonIndex)` Convert lat/lon coordinates to projection coordinates.
`double[][]`	`latLonToProj(double[][] from, int latIndex, int lonIndex)` Convert lat/lon coordinates to projection coordinates.
`ProjectionPoint`	`latLonToProj(double lat, double lon)` Convert a LatLonPoint to projection coordinates Note: a new object is now created on each call for the return value, as of 4.0.46
`float[][]`	`latLonToProj(float[][] from)` Convert lat/lon coordinates to projection coordinates.
`float[][]`	`latLonToProj(float[][] from, float[][] to)` Convert lat/lon coordinates to projection coordinates.
`float[][]`	`latLonToProj(float[][] from, float[][] to, int latIndex, int lonIndex)` Convert lat/lon coordinates to projection coordinates.
`float[][]`	`latLonToProj(float[][] from, int latIndex, int lonIndex)` Convert lat/lon coordinates to projection coordinates.
`ProjectionPoint`	`latLonToProj(LatLonPoint latLon)` Convert a LatLonPoint to projection coordinates Note: a new object is now created on each call for the return value, as of 4.0.46
`abstract ProjectionPoint`	`latLonToProj(LatLonPoint latlon, ProjectionPointImpl destPoint)` Convert a LatLonPoint to projection coordinates
`ProjectionRect`	`latLonToProjBB(LatLonRect latlonRect)` Convert a lat/lon bounding box to a world coordinate bounding box, by finding the minimum enclosing box.
`abstract java.lang.String`	`paramsToString()` Get a string representation of the projection parameters
`double[][]`	`projToLatLon(double[][] from)` Convert projection coordinates to lat/lon coordinates.
`double[][]`	`projToLatLon(double[][] from, double[][] to)` Convert projection coordinates to lat/lon coordinate.
`LatLonPoint`	`projToLatLon(double x, double y)` Convert a projection coordinate to a LatLonPoint Note: a new object is now created on each call for the return value, as of 4.0.46
`float[][]`	`projToLatLon(float[][] from)` Convert projection coordinates to lat/lon coordinates.
`float[][]`	`projToLatLon(float[][] from, float[][] to)` Convert projection coordinates to lat/lon coordinate.
`LatLonPoint`	`projToLatLon(ProjectionPoint ppt)` Convert projection coordinates to a LatLonPoint Note: a new object is now created on each call for the return value, as of 4.0.46
`abstract LatLonPoint`	`projToLatLon(ProjectionPoint ppt, LatLonPointImpl destPoint)` Convert projection coordinates to a LatLonPoint Note: a new object is not created on each call for the return value.
`LatLonRect`	`projToLatLonBB(ProjectionRect bb)` Compute lat/lon bounding box from projection bounding box by finding the minimum enclosing box.
`LatLonRect`	`projToLatLonBBold(ProjectionRect world)` Convert a world coordinate bounding box to a lat/lon bounding box, by finding the minimum enclosing box.
`void`	`setDefaultMapArea(ProjectionRect bb)` Set a reasonable bounding box for this specific projection.
`void`	`setName(java.lang.String name)`
`java.lang.String`	`toString()` Get a String representation of this projection.

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

- Field Detail
  - EARTH_RADIUS
```
public static final double EARTH_RADIUS
```
    Earth radius in kilometers
  - INDEX_LAT
```
public static final int INDEX_LAT
```
    Latitude index
    
    See Also:
    
    Constant Field Values
  - INDEX_LON
```
public static final int INDEX_LON
```
    Longitude index
    
    See Also:
    
    Constant Field Values
  - INDEX_X
```
public static final int INDEX_X
```
    X index
    
    See Also:
    
    Constant Field Values
  - INDEX_Y
```
public static final int INDEX_Y
```
    Y index
    
    See Also:
    
    Constant Field Values
  - TOLERANCE
```
protected static final double TOLERANCE
```
    tolerence for checks
    
    See Also:
    
    Constant Field Values
  - PI
```
public static final double PI
```
    PI
    
    See Also:
    
    Constant Field Values
  - PI_OVER_2
```
public static final double PI_OVER_2
```
    PI/2
    
    See Also:
    
    Constant Field Values
  - PI_OVER_4
```
public static final double PI_OVER_4
```
    PI/4
    
    See Also:
    
    Constant Field Values
  - name
```
protected java.lang.String name
```
    name of this projection.
  - isLatLon
```
protected final boolean isLatLon
```
    flag for latlon
  - atts
```
protected final java.util.List<Parameter> atts
```
    list of attributes
  - defaultMapArea
```
protected ProjectionRect defaultMapArea
```
    default map area
- Constructor Detail
  - ProjectionImpl
```
protected ProjectionImpl(java.lang.String name,
                         boolean isLatLon)
```
- Method Detail
  - constructCopy
```
public abstract ProjectionImpl constructCopy()
```
    copy constructor - avoid clone !!
    
    Returns:
    
    a copy of this Projection
  - getClassName
```
public java.lang.String getClassName()
```
    Get the name of the type of the projection.
    
    Specified by:
    
    getClassName in interface Projection
    
    Returns:
    
    the class name
  - paramsToString
```
public abstract java.lang.String paramsToString()
```
    Get a string representation of the projection parameters
    
    Specified by:
    
    paramsToString in interface Projection
    
    Returns:
    
    string representation of the projection parameters
  - getProjectionTypeLabel
```
public java.lang.String getProjectionTypeLabel()
```
    Get the label to be used in the gui for this type of projection. This defaults to call getClassName
    
    Returns:
    
    Type label
  - latLonToProj
```
public abstract ProjectionPoint latLonToProj(LatLonPoint latlon,
                                             ProjectionPointImpl destPoint)
```
    Convert a LatLonPoint to projection coordinates
    
    Specified by:
    
    latLonToProj in interface Projection
    
    Parameters:
    
    latlon - convert from these lat, lon coordinates
    
    destPoint - the object to write to
    
    Returns:
    
    the given destPoint
  - projToLatLon
```
public abstract LatLonPoint projToLatLon(ProjectionPoint ppt,
                                         LatLonPointImpl destPoint)
```
    Convert projection coordinates to a LatLonPoint Note: a new object is not created on each call for the return value.
    
    Specified by:
    
    projToLatLon in interface Projection
    
    Parameters:
    
    ppt - convert from these projection coordinates
    
    destPoint - the object to write to
    
    Returns:
    
    LatLonPoint convert to these lat/lon coordinates
  - latLonToProj
```
public ProjectionPoint latLonToProj(LatLonPoint latLon)
```
    Convert a LatLonPoint to projection coordinates Note: a new object is now created on each call for the return value, as of 4.0.46
    
    Parameters:
    
    latLon - convert from these lat, lon coordinates
    
    Returns:
    
    ProjectionPoint convert to these projection coordinates
  - projToLatLon
```
public LatLonPoint projToLatLon(ProjectionPoint ppt)
```
    Convert projection coordinates to a LatLonPoint Note: a new object is now created on each call for the return value, as of 4.0.46
    
    Parameters:
    
    ppt - convert from these projection coordinates
    
    Returns:
    
    LatLonPoint convert to these lat/lon coordinates
  - crossSeam
```
public abstract boolean crossSeam(ProjectionPoint pt1,
                                  ProjectionPoint pt2)
```
    Does the line between these two points cross the projection "seam".
    
    Specified by:
    
    crossSeam in interface Projection
    
    Parameters:
    
    pt1 - the line goes between these two points
    
    pt2 - the line goes between these two points
    
    Returns:
    
    false if there is no seam
  - equals
```
public abstract boolean equals(java.lang.Object proj)
```
    Returns true if this represents the same Projection as proj.
    
    Specified by:
    
    equals in interface Projection
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    proj - projection in question
    
    Returns:
    
    true if this represents the same Projection as proj.
  - getName
```
public java.lang.String getName()
```
    Get the name of this specific projection (also see getClassName)
    
    Specified by:
    
    getName in interface Projection
    
    Returns:
    
    name of the projection
  - setName
```
public void setName(java.lang.String name)
```
  - getProjectionParameters
```
public java.util.List<Parameter> getProjectionParameters()
```
    Get parameters as list of ucar.unidata.util.Parameter
    
    Specified by:
    
    getProjectionParameters in interface Projection
    
    Returns:
    
    List of parameters
  - findProjectionParameter
```
public Parameter findProjectionParameter(java.lang.String want)
```
  - addParameter
```
protected void addParameter(java.lang.String name,
                            java.lang.String value)
```
    Add an attribute to this projection
    
    Parameters:
    
    name - name of the attribute
    
    value - attribute value as a string
  - addParameter
```
protected void addParameter(java.lang.String name,
                            double value)
```
    Add an attribute to this projection
    
    Parameters:
    
    name - name of the attribute
    
    value - attribute value as a double
  - addParameter
```
protected void addParameter(Parameter p)
```
    Add an attribute to this projection
    
    Parameters:
    
    p - specify as a Parameter
  - isLatLon
```
public boolean isLatLon()
```
    Is this the lat/lon Projection ?
    
    Returns:
    
    true if it is the lat/lon Projection
  - getHeader
```
public static java.lang.String getHeader()
```
    Get a header for display.
    
    Returns:
    
    human readable header for display
  - toString
```
public java.lang.String toString()
```
    Get a String representation of this projection.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the name of the projection. This is what gets displayed when you add the projection object to a UI widget (e.g. label, combobox)
  - getDefaultMapArea
```
public ProjectionRect getDefaultMapArea()
```
    Get a reasonable bounding box for this projection.
    
    Specified by:
    
    getDefaultMapArea in interface Projection
    
    Returns:
    
    reasonable bounding box
  - getDefaultMapAreaLL
```
public LatLonRect getDefaultMapAreaLL()
```
    Get the bounding box in lat/lon.
    
    Returns:
    
    the LatLonRectangle for the bounding box
  - setDefaultMapArea
```
public void setDefaultMapArea(ProjectionRect bb)
```
    Set a reasonable bounding box for this specific projection. Projections are typically specific to an area of the world; theres no bounding box that works for all projections.
    
    Parameters:
    
    bb - bounding box
  - latLonToProj
```
public ProjectionPoint latLonToProj(double lat,
                                    double lon)
```
    Convert a LatLonPoint to projection coordinates Note: a new object is now created on each call for the return value, as of 4.0.46
    
    Parameters:
    
    lat - latitude of point to convert
    
    lon - longitude of point to convert
    
    Returns:
    
    ProjectionPointImpl convert to these projection coordinates
  - projToLatLon
```
public LatLonPoint projToLatLon(double x,
                                double y)
```
    Convert a projection coordinate to a LatLonPoint Note: a new object is now created on each call for the return value, as of 4.0.46
    
    Parameters:
    
    x - x value to convert
    
    y - y value to convert
    
    Returns:
    
    LatLonPointImpl convert to these lat/lon coordinates
  - projToLatLon
```
public double[][] projToLatLon(double[][] from)
```
    Convert projection coordinates to lat/lon coordinates.
    
    Parameters:
    
    from - array of projection coordinates: from[2][n], where from[0][i], from[1][i] is the x, y coordinate of the ith point
    
    Returns:
    
    resulting array of lat/lon coordinates, where to[0][i], to[1][i] is the lat,lon coordinate of the ith point
  - projToLatLon
```
public double[][] projToLatLon(double[][] from,
                               double[][] to)
```
    Convert projection coordinates to lat/lon coordinate.
    
    Parameters:
    
    from - array of projection coordinates: from[2][n], where (from[0][i], from[1][i]) is the (x, y) coordinate of the ith point
    
    to - resulting array of lat/lon coordinates: to[2][n] where (to[0][i], to[1][i]) is the (lat, lon) coordinate of the ith point
    
    Returns:
    
    the "to" array
  - projToLatLon
```
public float[][] projToLatLon(float[][] from)
```
    Convert projection coordinates to lat/lon coordinates.
    
    Parameters:
    
    from - array of projection coordinates: from[2][n], where from[0][i], from[1][i] is the x, y coordinate of the ith point
    
    Returns:
    
    resulting array of lat/lon coordinates, where to[0][i], to[1][i] is the lat,lon coordinate of the ith point
  - projToLatLon
```
public float[][] projToLatLon(float[][] from,
                              float[][] to)
```
    Convert projection coordinates to lat/lon coordinate.
    
    Parameters:
    
    from - array of projection coordinates: from[2][n], where (from[0][i], from[1][i]) is the (x, y) coordinate of the ith point
    
    to - resulting array of lat/lon coordinates: to[2][n] where (to[0][i], to[1][i]) is the (lat, lon) coordinate of the ith point
    
    Returns:
    
    the "to" array
  - latLonToProj
```
public double[][] latLonToProj(double[][] from)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where from[0][i], from[1][i] is the (lat,lon) coordinate of the ith point
    
    Returns:
    
    resulting array of projection coordinates, where to[0][i], to[1][i] is the (x,y) coordinate of the ith point
  - latLonToProj
```
public double[][] latLonToProj(double[][] from,
                               double[][] to)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where (from[0][i], from[1][i]) is the (lat,lon) coordinate of the ith point
    
    to - resulting array of projection coordinates: to[2][n] where (to[0][i], to[1][i]) is the (x,y) coordinate of the ith point
    
    Returns:
    
    the "to" array
  - latLonToProj
```
public double[][] latLonToProj(double[][] from,
                               int latIndex,
                               int lonIndex)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where (from[latIndex][i], from[lonIndex][i]) is the (lat,lon) coordinate of the ith point
    
    latIndex - index of lat coordinate; must be 0 or 1
    
    lonIndex - index of lon coordinate; must be 0 or 1
    
    Returns:
    
    resulting array of projection coordinates: to[2][n] where (to[0][i], to[1][i]) is the (x,y) coordinate of the ith point
  - latLonToProj
```
public double[][] latLonToProj(double[][] from,
                               double[][] to,
                               int latIndex,
                               int lonIndex)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where (from[latIndex][i], from[lonIndex][i]) is the (lat,lon) coordinate of the ith point
    
    to - resulting array of projection coordinates: to[2][n] where (to[0][i], to[1][i]) is the (x,y) coordinate of the ith point
    
    latIndex - index of lat coordinate; must be 0 or 1
    
    lonIndex - index of lon coordinate; must be 0 or 1
    
    Returns:
    
    the "to" array
  - latLonToProj
```
public float[][] latLonToProj(float[][] from)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where from[0][i], from[1][i] is the (lat,lon) coordinate of the ith point
    
    Returns:
    
    resulting array of projection coordinates, where to[0][i], to[1][i] is the (x,y) coordinate of the ith point
  - latLonToProj
```
public float[][] latLonToProj(float[][] from,
                              float[][] to)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where (from[0][i], from[1][i]) is the (lat,lon) coordinate of the ith point
    
    to - resulting array of projection coordinates: to[2][n] where (to[0][i], to[1][i]) is the (x,y) coordinate of the ith point
    
    Returns:
    
    the "to" array
  - latLonToProj
```
public float[][] latLonToProj(float[][] from,
                              int latIndex,
                              int lonIndex)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where (from[latIndex][i], from[lonIndex][i]) is the (lat,lon) coordinate of the ith point
    
    latIndex - index of lat coordinate; must be 0 or 1
    
    lonIndex - index of lon coordinate; must be 0 or 1
    
    Returns:
    
    resulting array of projection coordinates: to[2][n] where (to[0][i], to[1][i]) is the (x,y) coordinate of the ith point
  - latLonToProj
```
public float[][] latLonToProj(float[][] from,
                              float[][] to,
                              int latIndex,
                              int lonIndex)
```
    Convert lat/lon coordinates to projection coordinates.
    
    Parameters:
    
    from - array of lat/lon coordinates: from[2][n], where (from[latIndex][i], from[lonIndex][i]) is the (lat,lon) coordinate of the ith point
    
    to - resulting array of projection coordinates: to[2][n] where (to[0][i], to[1][i]) is the (x,y) coordinate of the ith point
    
    latIndex - index of lat coordinate; must be 0 or 1
    
    lonIndex - index of lon coordinate; must be 0 or 1
    
    Returns:
    
    the "to" array
  - latLonToProjBB
```
public ProjectionRect latLonToProjBB(LatLonRect latlonRect)
```
    Convert a lat/lon bounding box to a world coordinate bounding box, by finding the minimum enclosing box. Handles lat/lon points that do not intersect the projection panel.
    
    Parameters:
    
    latlonRect - input lat,lon bounding box
    
    Returns:
    
    minimum enclosing box in world coordinates, or null if no part of the LatLonRect intersects the projection plane
  - projToLatLonBBold
```
public LatLonRect projToLatLonBBold(ProjectionRect world)
```
    Convert a world coordinate bounding box to a lat/lon bounding box, by finding the minimum enclosing box.
    
    Parameters:
    
    world - input world coordinate bounding box
    
    Returns:
    
    minimum enclosing box in lat,lon coordinates.
  - projToLatLonBB
```
public LatLonRect projToLatLonBB(ProjectionRect bb)
```
    Compute lat/lon bounding box from projection bounding box by finding the minimum enclosing box.
    
    Parameters:
    
    bb - projection bounding box
    
    Returns:
    
    lat, lon bounding box.

Class ProjectionImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EARTH_RADIUS

INDEX_LAT

INDEX_LON

INDEX_X

INDEX_Y

TOLERANCE

PI

PI_OVER_2

PI_OVER_4

name

isLatLon

atts

defaultMapArea

Constructor Detail

ProjectionImpl

Method Detail

constructCopy

getClassName

paramsToString

getProjectionTypeLabel

latLonToProj

projToLatLon

latLonToProj

projToLatLon

crossSeam

equals

getName

setName

getProjectionParameters

findProjectionParameter

addParameter

addParameter

addParameter

isLatLon

getHeader

toString

getDefaultMapArea

getDefaultMapAreaLL

setDefaultMapArea

latLonToProj

projToLatLon

projToLatLon

projToLatLon

projToLatLon

projToLatLon

latLonToProj

latLonToProj

latLonToProj

latLonToProj

latLonToProj

latLonToProj

latLonToProj

latLonToProj

latLonToProjBB

projToLatLonBBold

projToLatLonBB