org.esa.beam.framework.datamodel
Interface GeoCoding

All Known Implementing Classes:

AbstractGeoCoding, CombinedFXYGeoCoding, CrsGeoCoding, FXYGeoCoding, GcpGeoCoding, MapGeoCoding, Orthorectifier, Orthorectifier2, PixelGeoCoding, TiePointGeoCoding

public interface GeoCoding

The GeoCoding interface provides geo-spatial latitude and longitude information for a given X/Y position of any (two-dimensional) raster.

Note: New geo-coding implementations shall implement the abstract class AbstractGeoCoding, instead of implementing this interface.

All GeoCoding implementations should override the equals() and hashCode() methods.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

Method Summary

boolean	canGetGeoPos() Checks whether or not this geo-coding can determine the geodetic position from a pixel position.
boolean	canGetPixelPos() Checks whether or not this geo-coding can determine the pixel position from a geodetic position.
void	dispose() Releases all of the resources used by this object instance and all of its owned children.
Datum	getDatum() Deprecated. use the datum of the associated map CRS.
org.opengis.referencing.crs.CoordinateReferenceSystem	getGeoCRS()
GeoPos	getGeoPos(PixelPos pixelPos, GeoPos geoPos) Returns the latitude and longitude value for a given pixel co-ordinate.
org.opengis.referencing.crs.CoordinateReferenceSystem	getImageCRS()
org.opengis.referencing.operation.MathTransform	getImageToMapTransform()
org.opengis.referencing.crs.CoordinateReferenceSystem	getMapCRS()
PixelPos	getPixelPos(GeoPos geoPos, PixelPos pixelPos) Returns the pixel co-ordinates as x/y for a given geographical position given as lat/lon.
boolean	isCrossingMeridianAt180() Checks whether or not the longitudes of this geo-coding cross the +/- 180 degree meridian.

Method Detail

isCrossingMeridianAt180

boolean isCrossingMeridianAt180()

Checks whether or not the longitudes of this geo-coding cross the +/- 180 degree meridian.

Returns:

true, if so

canGetPixelPos

boolean canGetPixelPos()

Checks whether or not this geo-coding can determine the pixel position from a geodetic position.

Returns:

true, if so

canGetGeoPos

boolean canGetGeoPos()

Checks whether or not this geo-coding can determine the geodetic position from a pixel position.

Returns:

true, if so

getPixelPos

PixelPos getPixelPos(GeoPos geoPos,
                     PixelPos pixelPos)

Returns the pixel co-ordinates as x/y for a given geographical position given as lat/lon.

Parameters:

geoPos - the geographical position as lat/lon in the coodinate system determined by getDatum()

pixelPos - an instance of Point to be used as retun value. If this parameter is null, the method creates a new instance which it then returns.

Returns:

the pixel co-ordinates as x/y

getGeoPos

GeoPos getGeoPos(PixelPos pixelPos,
                 GeoPos geoPos)

Returns the latitude and longitude value for a given pixel co-ordinate.

Parameters:

pixelPos - the pixel's co-ordinates given as x,y

geoPos - an instance of GeoPos to be used as retun value. If this parameter is null, the method creates a new instance which it then returns.

Returns:

the geographical position as lat/lon in the coodinate system determined by getDatum()

getDatum

@Deprecated
Datum getDatum()

Deprecated. use the datum of the associated map CRS.

Gets the datum, the reference point or surface against which GeoPos measurements are made.

Returns:

the datum

dispose

void dispose()

Releases all of the resources used by this object instance and all of its owned children. Its primary use is to allow the garbage collector to perform a vanilla job.

This method should be called only if it is for sure that this object instance will never be used again. The results of referencing an instance of this class after a call to dispose() are undefined.

getImageCRS

org.opengis.referencing.crs.CoordinateReferenceSystem getImageCRS()

Returns:

The image coordinate reference system (CRS). It is usually derived from the base CRS by including a linear or non-linear transformation from base (geodetic) coordinates to image coordinates.

getMapCRS

org.opengis.referencing.crs.CoordinateReferenceSystem getMapCRS()

Returns:

The map coordinate reference system (CRS). It may be either a geographical CRS (nominal case is "WGS-84") or a derived projected CRS, e.g. "UTM 32 - North".

getGeoCRS

org.opengis.referencing.crs.CoordinateReferenceSystem getGeoCRS()

Returns:

The geographical coordinate reference system (CRS). It may be either "WGS-84" (nominal case) or any other geographical CRS.

getImageToMapTransform

org.opengis.referencing.operation.MathTransform getImageToMapTransform()

Returns:

The math transformation used to convert image coordinates to map coordinates.