ucar.unidata.geoloc.projection
Class TransverseMercator

java.lang.Object
  ucar.unidata.geoloc.ProjectionImpl
      ucar.unidata.geoloc.projection.TransverseMercator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Projection

public class TransverseMercator
extends ProjectionImpl

Transverse Mercator projection, spherical earth. Projection plane is a cylinder tangent to the earth at tangentLon. See John Snyder, Map Projections used by the USGS, Bulletin 1532, 2nd edition (1983), p 53

Author:

John Caron

See Also:

Projection, ProjectionImpl, Serialized Form

Field Summary

Fields inherited from class ucar.unidata.geoloc.ProjectionImpl

ATTR_NAME, atts, defaultMapArea, EARTH_RADIUS, INDEX_LAT, INDEX_LON, INDEX_X, INDEX_Y, isLatLon, name, PI, PI_OVER_2, PI_OVER_4, TOLERANCE

Constructor Summary

TransverseMercator()
Constructor with default parameteres

TransverseMercator(double lat0, double tangentLon, double scale)
Construct a TransverseMercator Projection.

TransverseMercator(double lat0, double tangentLon, double scale, double east, double north)
Construct a TransverseMercator Projection.

Method Summary

java.lang.Object	clone() Clone this projection
ProjectionImpl	constructCopy() copy constructor - avoid clone !!
boolean	crossSeam(ProjectionPoint pt1, ProjectionPoint pt2) Does the line between these two points cross the projection "seam".
boolean	equals(java.lang.Object proj) Returns true if this represents the same Projection as proj.
double	getFalseEasting() Get the false easting, in km.
double	getFalseNorthing() Get the false northing, in km.
double	getOriginLat() Get the origin latitude
java.lang.String	getProjectionTypeLabel() Get the label to be used in the gui for this type of projection
double	getScale() Get the scale
double	getTangentLon() Get the tangent longitude
double[][]	latLonToProj(double[][] from, double[][] to, int latIndex, int lonIndex) Convert lat/lon coordinates to projection coordinates.
float[][]	latLonToProj(float[][] from, float[][] to, int latIndex, int lonIndex) Convert lat/lon coordinates to projection coordinates.
ProjectionPoint	latLonToProj(LatLonPoint latLon, ProjectionPointImpl result) Convert a LatLonPoint to projection coordinates
java.lang.String	paramsToString() Get the parameters as a String
double[][]	projToLatLon(double[][] from, double[][] to) Convert lat/lon coordinates to projection coordinates.
float[][]	projToLatLon(float[][] from, float[][] to) Convert lat/lon coordinates to projection coordinates.
LatLonPoint	projToLatLon(ProjectionPoint world, LatLonPointImpl result) Convert projection coordinates to a LatLonPoint Note: a new object is not created on each call for the return value.
void	setFalseEasting(double falseEasting) Set the false_easting, in km.
void	setFalseNorthing(double falseNorthing) Set the false northing, in km.
void	setOriginLat(double lat) Set the origin latitude
void	setScale(double scale) Set the scale
void	setTangentLon(double lon) Set the tangent longitude

Methods inherited from class ucar.unidata.geoloc.ProjectionImpl

addParameter, addParameter, addParameter, getClassName, getDefaultMapArea, getDefaultMapAreaLL, getHeader, getLatLonBoundingBox, getName, getProjectionParameters, isLatLon, latLonToProj, latLonToProj, latLonToProj, latLonToProj, latLonToProj, latLonToProj, latLonToProj, latLonToProj, latLonToProjBB, projToLatLon, projToLatLon, projToLatLon, projToLatLon, projToLatLonBB, setDefaultMapArea, setName, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TransverseMercator

public TransverseMercator()

Constructor with default parameteres

TransverseMercator

public TransverseMercator(double lat0,
                          double tangentLon,
                          double scale)

Construct a TransverseMercator Projection.

Parameters:

lat0 - origin of projection coord system is at (lat0, tangentLon)

tangentLon - longitude that the cylinder is tangent at ("central meridian")

scale - scale factor along the central meridian

TransverseMercator

public TransverseMercator(double lat0,
                          double tangentLon,
                          double scale,
                          double east,
                          double north)

Construct a TransverseMercator Projection.

Parameters:

lat0 - origin of projection coord system is at (lat0, tangentLon)

tangentLon - longitude that the cylinder is tangent at ("central meridian")

scale - scale factor along the central meridian

east - false easting in km

north - false northing in km

Method Detail

constructCopy

public ProjectionImpl constructCopy()

copy constructor - avoid clone !!

Specified by:

constructCopy in class ProjectionImpl

Returns:

_more_

getScale

public double getScale()

Get the scale

Returns:

the scale

setScale

public void setScale(double scale)

Set the scale

Parameters:

scale - the scale

getTangentLon

public double getTangentLon()

Get the tangent longitude

Returns:

the tangent longitude

setTangentLon

public void setTangentLon(double lon)

Set the tangent longitude

Parameters:

lon - the tangent longitude

getOriginLat

public double getOriginLat()

Get the origin latitude

Returns:

the origin latitude

setOriginLat

public void setOriginLat(double lat)

Set the origin latitude

Parameters:

lat - the origin latitude

getFalseEasting

public double getFalseEasting()

Get the false easting, in km.

Returns:

the false easting.

setFalseEasting

public void setFalseEasting(double falseEasting)

Set the false_easting, in km. natural_x_coordinate + false_easting = x coordinate

Parameters:

falseEasting - x offset

getFalseNorthing

public double getFalseNorthing()

Get the false northing, in km.

Returns:

the false northing.

setFalseNorthing

public void setFalseNorthing(double falseNorthing)

Set the false northing, in km. natural_y_coordinate + false_northing = y coordinate

Parameters:

falseNorthing - y offset

getProjectionTypeLabel

public java.lang.String getProjectionTypeLabel()

Get the label to be used in the gui for this type of projection

Overrides:

getProjectionTypeLabel in class ProjectionImpl

Returns:

Type label

paramsToString

public java.lang.String paramsToString()

Get the parameters as a String

Specified by:

paramsToString in interface Projection

Specified by:

paramsToString in class ProjectionImpl

Returns:

the parameters as a String

crossSeam

public boolean crossSeam(ProjectionPoint pt1,
                         ProjectionPoint pt2)

Does the line between these two points cross the projection "seam".

Specified by:

crossSeam in interface Projection

Specified by:

crossSeam in class ProjectionImpl

Parameters:

pt1 - the line goes between these two points

pt2 - the line goes between these two points

Returns:

false if there is no seam

clone

public java.lang.Object clone()

Clone this projection

Overrides:

clone in class ProjectionImpl

Returns:

a clone of this.

equals

public boolean equals(java.lang.Object proj)

Returns true if this represents the same Projection as proj.

Specified by:

equals in interface Projection

Specified by:

equals in class ProjectionImpl

Parameters:

proj - projection in question

Returns:

true if this represents the same Projection as proj.

latLonToProj

public ProjectionPoint latLonToProj(LatLonPoint latLon,
                                    ProjectionPointImpl result)

Convert a LatLonPoint to projection coordinates

Specified by:

latLonToProj in interface Projection

Specified by:

latLonToProj in class ProjectionImpl

Parameters:

latLon - convert from these lat, lon coordinates

result - the object to write to

Returns:

the given result

projToLatLon

public LatLonPoint projToLatLon(ProjectionPoint world,
                                LatLonPointImpl result)

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

Specified by:

projToLatLon in class ProjectionImpl

Parameters:

world - convert from these projection coordinates

result - the object to write to

Returns:

LatLonPoint convert to these lat/lon coordinates

latLonToProj

public float[][] latLonToProj(float[][] from,
                              float[][] to,
                              int latIndex,
                              int lonIndex)

Convert lat/lon coordinates to projection coordinates.

Overrides:

latLonToProj in class ProjectionImpl

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, where to[0][i], to[1][i] is the (x,y) coordinate of the ith point

latIndex - index of latitude in "from"

lonIndex - index of longitude in "from"

Returns:

the "to" array.

projToLatLon

public float[][] projToLatLon(float[][] from,
                              float[][] to)

Convert lat/lon coordinates to projection coordinates.

Overrides:

projToLatLon in class ProjectionImpl

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,
                               double[][] to,
                               int latIndex,
                               int lonIndex)

Convert lat/lon coordinates to projection coordinates.

Overrides:

latLonToProj in class ProjectionImpl

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, where to[0][i], to[1][i] is the (x,y) coordinate of the ith point

latIndex - index of latitude in "from"

lonIndex - index of longitude in "from"

Returns:

the "to" array.

projToLatLon

public double[][] projToLatLon(double[][] from,
                               double[][] to)

Convert lat/lon coordinates to projection coordinates.

Overrides:

projToLatLon in class ProjectionImpl

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