org.orekit.rugged.api

Class Rugged

java.lang.Object

org.orekit.rugged.api.Rugged

public class Rugged
extends Object

Main class of Rugged library API.

Author:

Luc Maisonobe

See Also:

RuggedBuilder

Method Summary

Methods

Modifier and Type	Method and Description
AbsoluteDate	dateLocation(String sensorName, double latitude, double longitude, int minLine, int maxLine) Find the date at which sensor sees a ground point.
AbsoluteDate	dateLocation(String sensorName, GeodeticPoint point, int minLine, int maxLine) Find the date at which sensor sees a ground point.
GeodeticPoint	directLocation(AbsoluteDate date, Vector3D position, Vector3D los) Direct location of a single line-of-sight.
GeodeticPoint[]	directLocation(String sensorName, double lineNumber) Direct location of a sensor line.
IntersectionAlgorithm	getAlgorithm() Get the DEM intersection algorithm.
Transform	getBodyToInertial(AbsoluteDate date) Get transform from observed body frame to inertial frame.
ExtendedEllipsoid	getEllipsoid() Get the observed body ellipsoid.
Transform	getInertialToBody(AbsoluteDate date) Get transform from inertial frame to observed body frame.
LineSensor	getLineSensor(String sensorName) Get a sensor.
Collection<LineSensor>	getLineSensors() Get the line sensors.
AbsoluteDate	getMaxDate() Get the end of search time span.
AbsoluteDate	getMinDate() Get the start of search time span.
Transform	getScToInertial(AbsoluteDate date) Get transform from spacecraft to inertial frame.
SensorPixel	inverseLocation(String sensorName, double latitude, double longitude, int minLine, int maxLine) Inverse location of a ground point.
SensorPixel	inverseLocation(String sensorName, GeodeticPoint point, int minLine, int maxLine) Inverse location of a point.
boolean	isAberrationOfLightCorrected() Get flag for aberration of light correction.
boolean	isInRange(AbsoluteDate date) Check if a date is in the supported range.
boolean	isLightTimeCorrected() Get flag for light time correction.

Methods inherited from class java.lang.Object

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

Method Detail

getAlgorithm

public IntersectionAlgorithm getAlgorithm()

Get the DEM intersection algorithm.

Returns:

DEM intersection algorithm

isLightTimeCorrected

public boolean isLightTimeCorrected()

Get flag for light time correction.

Returns:

true if the light time between ground and spacecraft is compensated for more accurate location

isAberrationOfLightCorrected

public boolean isAberrationOfLightCorrected()

Get flag for aberration of light correction.

Returns:

true if the aberration of light time is corrected for more accurate location

getLineSensors

public Collection<LineSensor> getLineSensors()

Get the line sensors.

Returns:

line sensors

getMinDate

public AbsoluteDate getMinDate()

Get the start of search time span.

Returns:

start of search time span

getMaxDate

public AbsoluteDate getMaxDate()

Get the end of search time span.

Returns:

end of search time span

isInRange

public boolean isInRange(AbsoluteDate date)

Check if a date is in the supported range.

The supporte range is given by the minDate and maxDate construction parameters, with an overshootTolerance margin accepted (i.e. a date slightly before minDate or slightly after maxDate will be considered in range if the overshoot does not exceed the tolerance set at construction).

Parameters:

date - date to check

Returns:

true if date is in the supported range

getEllipsoid

public ExtendedEllipsoid getEllipsoid()

Get the observed body ellipsoid.

Returns:

observed body ellipsoid

directLocation

public GeodeticPoint[] directLocation(String sensorName,
                             double lineNumber)
                               throws RuggedException

Direct location of a sensor line.

Parameters:

sensorName - name of the line sensor

lineNumber - number of the line to localize on ground

Returns:

ground position of all pixels of the specified sensor line

Throws:

RuggedException - if line cannot be localized, or sensor is unknown

directLocation

public GeodeticPoint directLocation(AbsoluteDate date,
                           Vector3D position,
                           Vector3D los)
                             throws RuggedException

Direct location of a single line-of-sight.

Parameters:

date - date of the location

position - pixel position in spacecraft frame

los - normalized line-of-sight in spacecraft frame

Returns:

ground position of intersection point between specified los and ground

Throws:

RuggedException - if line cannot be localized, or sensor is unknown

dateLocation

public AbsoluteDate dateLocation(String sensorName,
                        double latitude,
                        double longitude,
                        int minLine,
                        int maxLine)
                          throws RuggedException

Find the date at which sensor sees a ground point.

This method is a partial inverse location focusing only on date.

The point is given only by its latitude and longitude, the elevation is computed from the Digital Elevation Model.

Note that for each sensor name, the minLine and maxLine settings are cached, because they induce costly frames computation. So these settings should not be tuned very finely and changed at each call, but should rather be a few thousand lines wide and refreshed only when needed. If for example an inverse location is roughly estimated to occur near line 53764 (for example using RoughVisibilityEstimator), minLine and maxLine could be set for example to 50000 and 60000, which would be OK also if next line inverse location is expected to occur near line 53780, and next one ... The setting could be changed for example to 55000 and 65000 when an inverse location is expected to occur after 55750. Of course, these values are only an example and should be adjusted depending on mission needs.

Parameters:

sensorName - name of the line sensor

latitude - ground point latitude

longitude - ground point longitude

minLine - minimum line number

maxLine - maximum line number

Returns:

date at which ground point is seen by line sensor

Throws:

RuggedException - if line cannot be localized, or sensor is unknown

See Also:

inverseLocation(String, double, double, int, int), RoughVisibilityEstimator

dateLocation

public AbsoluteDate dateLocation(String sensorName,
                        GeodeticPoint point,
                        int minLine,
                        int maxLine)
                          throws RuggedException

Find the date at which sensor sees a ground point.

This method is a partial inverse location focusing only on date.

Note that for each sensor name, the minLine and maxLine settings are cached, because they induce costly frames computation. So these settings should not be tuned very finely and changed at each call, but should rather be a few thousand lines wide and refreshed only when needed. If for example an inverse location is roughly estimated to occur near line 53764 (for example using RoughVisibilityEstimator), minLine and maxLine could be set for example to 50000 and 60000, which would be OK also if next line inverse location is expected to occur near line 53780, and next one ... The setting could be changed for example to 55000 and 65000 when an inverse location is expected to occur after 55750. Of course, these values are only an example and should be adjusted depending on mission needs.

Parameters:

sensorName - name of the line sensor

point - point to localize

minLine - minimum line number

maxLine - maximum line number

Returns:

date at which ground point is seen by line sensor

Throws:

RuggedException - if line cannot be localized, or sensor is unknown

See Also:

inverseLocation(String, GeodeticPoint, int, int), RoughVisibilityEstimator

inverseLocation

public SensorPixel inverseLocation(String sensorName,
                          double latitude,
                          double longitude,
                          int minLine,
                          int maxLine)
                            throws RuggedException

Inverse location of a ground point.

The point is given only by its latitude and longitude, the elevation is computed from the Digital Elevation Model.

Note that for each sensor name, the minLine and maxLine settings are cached, because they induce costly frames computation. So these settings should not be tuned very finely and changed at each call, but should rather be a few thousand lines wide and refreshed only when needed. If for example an inverse location is roughly estimated to occur near line 53764 (for example using RoughVisibilityEstimator), minLine and maxLine could be set for example to 50000 and 60000, which would be OK also if next line inverse location is expected to occur near line 53780, and next one ... The setting could be changed for example to 55000 and 65000 when an inverse location is expected to occur after 55750. Of course, these values are only an example and should be adjusted depending on mission needs.

Parameters:

sensorName - name of the line sensor

latitude - ground point latitude

longitude - ground point longitude

minLine - minimum line number

maxLine - maximum line number

Returns:

sensor pixel seeing ground point, or null if ground point cannot be seen between the prescribed line numbers

Throws:

RuggedException - if line cannot be localized, or sensor is unknown

See Also:

RoughVisibilityEstimator

inverseLocation

public SensorPixel inverseLocation(String sensorName,
                          GeodeticPoint point,
                          int minLine,
                          int maxLine)
                            throws RuggedException

Inverse location of a point.

Note that for each sensor name, the minLine and maxLine settings are cached, because they induce costly frames computation. So these settings should not be tuned very finely and changed at each call, but should rather be a few thousand lines wide and refreshed only when needed. If for example an inverse location is roughly estimated to occur near line 53764 (for example using RoughVisibilityEstimator), minLine and maxLine could be set for example to 50000 and 60000, which would be OK also if next line inverse location is expected to occur near line 53780, and next one ... The setting could be changed for example to 55000 and 65000 when an inverse location is expected to occur after 55750. Of course, these values are only an example and should be adjusted depending on mission needs.

Parameters:

sensorName - name of the line sensor

point - point to localize

minLine - minimum line number

maxLine - maximum line number

Returns:

sensor pixel seeing point, or null if point cannot be seen between the prescribed line numbers

Throws:

RuggedException - if line cannot be localized, or sensor is unknown

See Also:

dateLocation(String, GeodeticPoint, int, int), RoughVisibilityEstimator

getScToInertial

public Transform getScToInertial(AbsoluteDate date)
                          throws RuggedException

Get transform from spacecraft to inertial frame.

Parameters:

date - date of the transform

Returns:

transform from spacecraft to inertial frame

Throws:

RuggedException - if spacecraft position or attitude cannot be computed at date

getInertialToBody

public Transform getInertialToBody(AbsoluteDate date)
                            throws RuggedException

Get transform from inertial frame to observed body frame.

Parameters:

date - date of the transform

Returns:

transform from inertial frame to observed body frame

Throws:

RuggedException - if frames cannot be computed at date

getBodyToInertial

public Transform getBodyToInertial(AbsoluteDate date)
                            throws RuggedException

Get transform from observed body frame to inertial frame.

Parameters:

date - date of the transform

Returns:

transform from observed body frame to inertial frame

Throws:

RuggedException - if frames cannot be computed at date

getLineSensor

public LineSensor getLineSensor(String sensorName)
                         throws RuggedException

Get a sensor.

Parameters:

sensorName - sensor name

Returns:

selected sensor

Throws:

RuggedException - if sensor is not known