Package org.esa.snap.core.datamodel

Class AbstractGeoCoding

java.lang.Object

org.esa.snap.core.datamodel.AbstractGeoCoding

All Implemented Interfaces:

GeoCoding

Direct Known Subclasses:

CombinedFXYGeoCoding, ComponentGeoCoding, CrsGeoCoding, FXYGeoCoding, GcpGeoCoding, MapGeoCoding, PixelGeoCoding, TiePointGeoCoding

public abstract class AbstractGeoCoding
extends Object
implements GeoCoding

AbstractGeoCoding is the base class of all geo-coding implementation.

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGeoCoding()	Default constructor.
protected	AbstractGeoCoding(org.opengis.referencing.crs.CoordinateReferenceSystem geoCRS)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canClone()	Check if geocoding can be cloned.
GeoCoding	clone()	Creates a shallow clone of this geocoding.
protected static org.geotools.referencing.crs.DefaultDerivedCRS	createImageCRS(org.opengis.referencing.crs.CoordinateReferenceSystem baseCRS, org.opengis.referencing.operation.MathTransform baseToDerivedTransform)
org.opengis.referencing.crs.CoordinateReferenceSystem	getGeoCRS()
org.opengis.referencing.crs.CoordinateReferenceSystem	getImageCRS()
org.opengis.referencing.operation.MathTransform	getImageToMapTransform()
org.opengis.referencing.crs.CoordinateReferenceSystem	getMapCRS()
void	setGeoCRS(org.opengis.referencing.crs.CoordinateReferenceSystem geoCRS)
protected void	setImageCRS(org.opengis.referencing.crs.CoordinateReferenceSystem imageCRS)
protected void	setMapCRS(org.opengis.referencing.crs.CoordinateReferenceSystem mapCRS)
abstract boolean	transferGeoCoding(Scene srcScene, Scene destScene, ProductSubsetDef subsetDef)	Transfers the geo-coding of the srcScene to the destScene with respect to the given subsetDef.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.esa.snap.core.datamodel.GeoCoding

canGetGeoPos, canGetPixelPos, dispose, getDatum, getGeoPos, getPixelPos, isCrossingMeridianAt180

Constructor Detail

AbstractGeoCoding

protected AbstractGeoCoding()

Default constructor. Sets WGS84 as both the geographic CRS and map CRS.

AbstractGeoCoding

protected AbstractGeoCoding(org.opengis.referencing.crs.CoordinateReferenceSystem geoCRS)

Constructor.

Parameters:

geoCRS - The CRS to be used as both the geographic CRS and map CRS.

Method Detail

transferGeoCoding

public abstract boolean transferGeoCoding(Scene srcScene,
                                          Scene destScene,
                                          ProductSubsetDef subsetDef)

Transfers the geo-coding of the srcScene to the destScene with respect to the given subsetDef.

Parameters:

srcScene - the source scene

destScene - the destination scene

subsetDef - the definition of the subset, may be null

Returns:

true, if the geo-coding could be transferred.

getImageCRS

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

Specified by:

getImageCRS in interface GeoCoding

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.

setImageCRS

protected final void setImageCRS(org.opengis.referencing.crs.CoordinateReferenceSystem imageCRS)

getMapCRS

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

Specified by:

getMapCRS in interface GeoCoding

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".

setMapCRS

protected final void setMapCRS(org.opengis.referencing.crs.CoordinateReferenceSystem mapCRS)

getGeoCRS

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

Specified by:

getGeoCRS in interface GeoCoding

Returns:

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

setGeoCRS

public final void setGeoCRS(org.opengis.referencing.crs.CoordinateReferenceSystem geoCRS)

getImageToMapTransform

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

Specified by:

getImageToMapTransform in interface GeoCoding

Returns:

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

clone

public GeoCoding clone()

Creates a shallow clone of this geocoding. Geolocation raster data is shared.

Specified by:

clone in interface GeoCoding

Overrides:

clone in class Object

Returns:

the cloned geocoding

canClone

public boolean canClone()

Check if geocoding can be cloned.

Specified by:

canClone in interface GeoCoding

Returns:

if so or not

createImageCRS

protected static org.geotools.referencing.crs.DefaultDerivedCRS createImageCRS(org.opengis.referencing.crs.CoordinateReferenceSystem baseCRS,
                                                                               org.opengis.referencing.operation.MathTransform baseToDerivedTransform)