org.esa.beam.framework.datamodel
Interface Pointing

All Known Implementing Classes:

TiePointGridPointing

public interface Pointing

The interface Pointing wraps a GeoCoding and optionally provides more geometry information such as sun direction, satellite (view) direction and elevation at a given pixel position.

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

Version:

$Revision$ $Date$

Author:

Norman Fomferra

Method Summary

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.
float	getElevation(PixelPos pixelPos) Gets the elevation above the given pixel position.
GeoCoding	getGeoCoding() Gets the geo-coding.
AngularDirection	getSunDir(PixelPos pixelPos, AngularDirection angularDirection) Gets the vector to the sun at the given pixel position as angular direction.
AngularDirection	getViewDir(PixelPos pixelPos, AngularDirection angularDirection) Gets the vector to the observer at the given pixel position as angular direction.

Method Detail

getGeoCoding

GeoCoding getGeoCoding()

Gets the geo-coding.

Returns:

the geo-coding, never null.

getSunDir

AngularDirection getSunDir(PixelPos pixelPos,
                           AngularDirection angularDirection)

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

Parameters:

pixelPos - the pixel position

angularDirection - 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:

canGetSunDir()

getViewDir

AngularDirection getViewDir(PixelPos pixelPos,
                            AngularDirection angularDirection)

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

Parameters:

pixelPos - the pixel position

angularDirection - 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:

canGetViewDir()

getElevation

float getElevation(PixelPos pixelPos)

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.

Parameters:

pixelPos - the pixel position

Returns:

the elevation at the given pixel position

See Also:

canGetElevation()

canGetSunDir

boolean canGetSunDir()

Returns whether or not the sun direction is available.

Returns:

true, if and only if so

canGetViewDir

boolean canGetViewDir()

Returns whether or not the viewing direction is available.

Returns:

true, if and only if so

canGetElevation

boolean canGetElevation()

Returns whether or not the elevation is available.

Returns:

true, if and only if so