AbstractProjection (cdm-core 6.0.0-beta1 API)

java.lang.Object
- ucar.unidata.geoloc.projection.AbstractProjection

All Implemented Interfaces:

Projection

Direct Known Subclasses:

AlbersEqualArea, AlbersEqualAreaEllipse, CylindricalEqualAreaProjection, EquidistantAzimuthalProjection, FlatEarth, Geostationary, LambertAzimuthalEqualArea, LambertConformal, LambertConformalConicEllipse, LatLonProjection, Mercator, MSGnavigation, Orthographic, PolyconicProjection, RotatedLatLon, RotatedPole, Sinusoidal, Stereographic, StereographicAzimuthalProjection, TransverseMercator, TransverseMercatorProjection, UtmProjection, VerticalPerspectiveView
```
@Immutable
public abstract class AbstractProjection
extends Object
implements Projection
```
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.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Parameter>`	`atts`
`protected static double`	`EARTH_RADIUS`
`protected static int`	`INDEX_LAT`
`protected static int`	`INDEX_LON`
`protected static int`	`INDEX_X`
`protected static int`	`INDEX_Y`
`protected boolean`	`isLatLon`
`protected String`	`name`
`protected static double`	`PI`
`protected static double`	`PI_OVER_2`
`protected static double`	`PI_OVER_4`
`protected static double`	`TOLERANCE`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractProjection(String name, boolean isLatLon)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractProjection(String name, boolean isLatLon)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addParameter(Attribute att)` Add a parameter to this projection
`protected void`	`addParameter(Parameter p)` Deprecated. use addParameter(Attribute)
`protected void`	`addParameter(String name, double value)` Add an parameter to this projection
`protected void`	`addParameter(String name, String value)` Add an parameter to this projection
`abstract Projection`	`constructCopy()` copy constructor - avoid clone !!
`Parameter`	`findProjectionParameter(String want)` Deprecated. do not use
`String`	`getClassName()` The name of the implementing class.
`static String`	`getHeader()` Get a header for display.
`protected static double`	`getMinOrMaxLon(double lon1, double lon2, boolean wantMin)`
`String`	`getName()` The name of this projection.
`AttributeContainer`	`getProjectionAttributes()` Get projection parameters.
`com.google.common.collect.ImmutableList<Parameter>`	`getProjectionParameters()` Deprecated. use getProjectionAttributes.
`String`	`getProjectionTypeLabel()` Get the label to be used in the gui for this type of projection.
`boolean`	`isLatLon()` Is this the lat/lon Projection ?
`ProjectionRect`	`latLonToProjBB(LatLonRect latlonRect)` Convert a lat/lon bounding box to a world coordinate bounding box, by finding the minimum enclosing box.
`abstract String`	`paramsToString()` String representation of the projection parameters.
`LatLonRect`	`projToLatLonBB(ProjectionRect bb)` Compute lat/lon bounding box from projection bounding box.
`String`	`toString()` Get a String representation of this projection.

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

Methods inherited from interface ucar.unidata.geoloc.Projection
crossSeam, latLonToProj, latLonToProj, projToLatLon, projToLatLon

- Field Detail
  - EARTH_RADIUS
```
protected static final double EARTH_RADIUS
```
    See Also:
    
    Constant Field Values
  - INDEX_LAT
```
protected static final int INDEX_LAT
```
    See Also:
    
    Constant Field Values
  - INDEX_LON
```
protected static final int INDEX_LON
```
    See Also:
    
    Constant Field Values
  - INDEX_X
```
protected static final int INDEX_X
```
    See Also:
    
    Constant Field Values
  - INDEX_Y
```
protected static final int INDEX_Y
```
    See Also:
    
    Constant Field Values
  - TOLERANCE
```
protected static final double TOLERANCE
```
    See Also:
    
    Constant Field Values
  - PI
```
protected static final double PI
```
    See Also:
    
    Constant Field Values
  - PI_OVER_2
```
protected static final double PI_OVER_2
```
    See Also:
    
    Constant Field Values
  - PI_OVER_4
```
protected static final double PI_OVER_4
```
    See Also:
    
    Constant Field Values
  - name
```
protected final String name
```
  - isLatLon
```
protected final boolean isLatLon
```
  - atts
```
protected final List<Parameter> atts
```
- Constructor Detail
  - AbstractProjection
```
protected AbstractProjection(String name,
                             boolean isLatLon)
```
- Method Detail
  - constructCopy
```
public abstract Projection constructCopy()
```
    copy constructor - avoid clone !!
    
    Returns:
    
    a copy of this Projection.
  - getClassName
```
public String getClassName()
```
    Description copied from interface: Projection
    
    The name of the implementing class.
    
    Specified by:
    
    getClassName in interface Projection
  - paramsToString
```
public abstract String paramsToString()
```
    Description copied from interface: Projection
    
    String representation of the projection parameters.
    
    Specified by:
    
    paramsToString in interface Projection
  - getProjectionTypeLabel
```
public String getProjectionTypeLabel()
```
    Get the label to be used in the gui for this type of projection. This defaults to call getClassName
    
    Returns:
    
    Type label
  - getName
```
public String getName()
```
    Description copied from interface: Projection
    
    The name of this projection.
    
    Specified by:
    
    getName in interface Projection
  - getProjectionParameters
```
@Deprecated
public com.google.common.collect.ImmutableList<Parameter> getProjectionParameters()
```
    Deprecated. use getProjectionAttributes.
    
    Description copied from interface: Projection
    
    Get projection parameters. Add as Attributes to a Coordinate Transform Variable (ctv).
    
    Specified by:
    
    getProjectionParameters in interface Projection
  - getProjectionAttributes
```
public AttributeContainer getProjectionAttributes()
```
    Description copied from interface: Projection
    
    Get projection parameters. Add as Attributes to a Coordinate Transform Variable (ctv).
    
    Specified by:
    
    getProjectionAttributes in interface Projection
  - findProjectionParameter
```
@Deprecated
public Parameter findProjectionParameter(String want)
```
    Deprecated. do not use
  - addParameter
```
protected void addParameter(String name,
                            String value)
```
    Add an parameter to this projection
    
    Parameters:
    
    name - name of the attribute
    
    value - parameter value as a string
  - addParameter
```
protected void addParameter(String name,
                            double value)
```
    Add an parameter to this projection
    
    Parameters:
    
    name - name of the parameter
    
    value - parameter value as a double
  - addParameter
```
protected void addParameter(Attribute att)
```
    Add a parameter to this projection
  - addParameter
```
@Deprecated
protected void addParameter(Parameter p)
```
    Deprecated. use addParameter(Attribute)
  - isLatLon
```
public boolean isLatLon()
```
    Is this the lat/lon Projection ?
    
    Specified by:
    
    isLatLon in interface Projection
    
    Returns:
    
    true if it is the lat/lon Projection
  - getHeader
```
public static String getHeader()
```
    Get a header for display.
    
    Returns:
    
    human readable header for display
  - toString
```
public String toString()
```
    Get a String representation of this projection.
    
    Overrides:
    
    toString in class 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)
  - latLonToProjBB
```
public ProjectionRect latLonToProjBB(LatLonRect latlonRect)
```
    Description copied from interface: Projection
    
    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.
    
    Specified by:
    
    latLonToProjBB in interface Projection
    
    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
  - projToLatLonBB
```
public LatLonRect projToLatLonBB(ProjectionRect bb)
```
    Description copied from interface: Projection
    
    Compute lat/lon bounding box from projection bounding box.
    
    Specified by:
    
    projToLatLonBB in interface Projection
    
    Parameters:
    
    bb - projection bounding box
    
    Returns:
    
    lat, lon bounding box.
  - getMinOrMaxLon
```
protected static double getMinOrMaxLon(double lon1,
                                       double lon2,
                                       boolean wantMin)
```

Class AbstractProjection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface ucar.unidata.geoloc.Projection

Field Detail

EARTH_RADIUS

INDEX_LAT

INDEX_LON

INDEX_X

INDEX_Y

TOLERANCE

PI

PI_OVER_2

PI_OVER_4

name

isLatLon

atts

Constructor Detail

AbstractProjection

Method Detail

constructCopy

getClassName

paramsToString

getProjectionTypeLabel

getName

getProjectionParameters

getProjectionAttributes

findProjectionParameter

addParameter

addParameter

addParameter

addParameter

isLatLon

getHeader

toString

latLonToProjBB

projToLatLonBB

getMinOrMaxLon