Package org.esa.snap.core.datamodel

Class TiePointGridPointing

java.lang.Object

org.esa.snap.core.datamodel.TiePointGridPointing

All Implemented Interfaces:

Pointing

public final class TiePointGridPointing
extends Object
implements Pointing

A Pointing which uses tie-point grids to compute the geometry for a given pixel position.

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor	Description
TiePointGridPointing(GeoCoding geoCoding, TiePointGrid szGrid, TiePointGrid saGrid, TiePointGrid vzGrid, TiePointGrid vaGrid, TiePointGrid elGrid)	Constructs a new pointing based on tie-point grids.

Method Summary

Modifier and Type	Method	Description
boolean	canGetElevation()	Returns whether or not the elevation is available.
boolean	canGetSunDir()	Returns whether or not the sun direction is available.
boolean	canGetViewDir()	Returns whether or not the viewing direction is available.
boolean	equals(Object obj)
double	getElevation(PixelPos pixelPos)	Gets the elevation above the given pixel position.
GeoCoding	getGeoCoding()	Gets the geo-coding.
AngularDirection	getSunDir(PixelPos pixelPos, AngularDirection sd)	Gets the vector to the sun at the given pixel position as angular direction.
AngularDirection	getViewDir(PixelPos pixelPos, AngularDirection vd)	Gets the vector to the observer at the given pixel position as angular direction.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TiePointGridPointing

public TiePointGridPointing(GeoCoding geoCoding,
                            TiePointGrid szGrid,
                            TiePointGrid saGrid,
                            TiePointGrid vzGrid,
                            TiePointGrid vaGrid,
                            TiePointGrid elGrid)

Constructs a new pointing based on tie-point grids.

Parameters:

geoCoding - the geo-coding, must not be null

szGrid - the sun zenith tie-point grid, can be null

saGrid - the sun azimuth tie-point grid, can be null

vzGrid - the viewing zenith tie-point grid, can be null

vaGrid - the viewing azimuth tie-point grid, can be null

elGrid - the elevation tie-point grid, can be null

Method Detail

getGeoCoding

public final GeoCoding getGeoCoding()

Description copied from interface: Pointing

Gets the geo-coding.

Specified by:

getGeoCoding in interface Pointing

Returns:

the geo-coding, never null.

getSunDir

public final AngularDirection getSunDir(PixelPos pixelPos,
                                        AngularDirection sd)

Description copied from interface: Pointing

Gets the vector to the sun at the given pixel position as angular direction.

Specified by:

getSunDir in interface Pointing

Parameters:

pixelPos - the pixel position

sd - the return value to be re-used. If null, a new AngularDirection will be returned

Returns:

the direction to the sun or null, if this information is not available

See Also:

Pointing.canGetSunDir()

getViewDir

public final AngularDirection getViewDir(PixelPos pixelPos,
                                         AngularDirection vd)

Description copied from interface: Pointing

Gets the vector to the observer at the given pixel position as angular direction.

Specified by:

getViewDir in interface Pointing

Parameters:

pixelPos - the pixel position

vd - the return value to be re-used. If null, a new AngularDirection will be returned

Returns:

the direction to the observer or null, if this information is not available

See Also:

Pointing.canGetViewDir()

getElevation

public double getElevation(PixelPos pixelPos)

Description copied from interface: Pointing

Gets the elevation above the given pixel position.

This method is called by the Orthorectifier in the case that no ElevationModel is available.

Note that a particular implementation is not able to retrieve a meaningful elevation, it should return zero.

Specified by:

getElevation in interface Pointing

Parameters:

pixelPos - the pixel position

Returns:

the elevation at the given pixel position

See Also:

Pointing.canGetElevation()

canGetElevation

public final boolean canGetElevation()

Description copied from interface: Pointing

Returns whether or not the elevation is available.

Specified by:

canGetElevation in interface Pointing

Returns:

true, if and only if so

canGetSunDir

public final boolean canGetSunDir()

Description copied from interface: Pointing

Returns whether or not the sun direction is available.

Specified by:

canGetSunDir in interface Pointing

Returns:

true, if and only if so

canGetViewDir

public final boolean canGetViewDir()

Description copied from interface: Pointing

Returns whether or not the viewing direction is available.

Specified by:

canGetViewDir in interface Pointing

Returns:

true, if and only if so

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object