Package 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, Guylaine Prat, Jonathan Guinet, Lucie LabatAllee

See Also:

RuggedBuilder

Method Summary

Modifier and Type	Method	Description
org.orekit.time.AbsoluteDate	dateLocation(String sensorName, double latitude, double longitude, int minLine, int maxLine)	Find the date at which sensor sees a ground point.
org.orekit.time.AbsoluteDate	dateLocation(String sensorName, org.orekit.bodies.GeodeticPoint point, int minLine, int maxLine)	Find the date at which sensor sees a ground point.
org.orekit.bodies.GeodeticPoint[]	directLocation(String sensorName, double lineNumber)	Direct location of a sensor line.
org.orekit.bodies.GeodeticPoint	directLocation(org.orekit.time.AbsoluteDate date, org.hipparchus.geometry.euclidean.threed.Vector3D sensorPosition, org.hipparchus.geometry.euclidean.threed.Vector3D los)	Direct location of a single line-of-sight.
double[]	distanceBetweenLOS(LineSensor sensorA, org.orekit.time.AbsoluteDate dateA, double pixelA, SpacecraftToObservedBody scToBodyA, LineSensor sensorB, org.orekit.time.AbsoluteDate dateB, double pixelB)	Compute distances between two line sensors.
org.hipparchus.analysis.differentiation.DerivativeStructure[]	distanceBetweenLOSderivatives(LineSensor sensorA, org.orekit.time.AbsoluteDate dateA, double pixelA, SpacecraftToObservedBody scToBodyA, LineSensor sensorB, org.orekit.time.AbsoluteDate dateB, double pixelB, DSGenerator generator)	Compute distances between two line sensors with derivatives.
IntersectionAlgorithm	getAlgorithm()	Get the DEM intersection algorithm.
org.orekit.frames.Transform	getBodyToInertial(org.orekit.time.AbsoluteDate date)	Get transform from observed body frame to inertial frame.
ExtendedEllipsoid	getEllipsoid()	Get the observed body ellipsoid.
org.orekit.frames.Transform	getInertialToBody(org.orekit.time.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.
org.orekit.time.AbsoluteDate	getMaxDate()	Get the end of search time span.
org.orekit.time.AbsoluteDate	getMinDate()	Get the start of search time span.
String	getName()	Get the Rugged name.
AtmosphericRefraction	getRefractionCorrection()	Get the atmospheric refraction model.
SpacecraftToObservedBody	getScToBody()	Get converter between spacecraft and body.
org.orekit.frames.Transform	getScToInertial(org.orekit.time.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, org.orekit.bodies.GeodeticPoint point, int minLine, int maxLine)	Inverse location of a point.
org.hipparchus.analysis.differentiation.DerivativeStructure[]	inverseLocationDerivatives(String sensorName, org.orekit.bodies.GeodeticPoint point, int minLine, int maxLine, DSGenerator generator)	Inverse location of a point with derivatives.
boolean	isAberrationOfLightCorrected()	Get flag for aberration of light correction.
boolean	isInRange(org.orekit.time.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

getName

public String getName()

Get the Rugged name.

Returns:

Rugged name

Since:

2.0

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

getRefractionCorrection

public AtmosphericRefraction getRefractionCorrection()

Get the atmospheric refraction model.

Returns:

atmospheric refraction model

Since:

2.0

getLineSensors

public Collection<LineSensor> getLineSensors()

Get the line sensors.

Returns:

line sensors

getMinDate

public org.orekit.time.AbsoluteDate getMinDate()

Get the start of search time span.

Returns:

start of search time span

getMaxDate

public org.orekit.time.AbsoluteDate getMaxDate()

Get the end of search time span.

Returns:

end of search time span

isInRange

public boolean isInRange(org.orekit.time.AbsoluteDate date)

Check if a date is in the supported range.

The support 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 org.orekit.bodies.GeodeticPoint[] directLocation(String sensorName,
                                                        double lineNumber)

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

directLocation

public org.orekit.bodies.GeodeticPoint directLocation(org.orekit.time.AbsoluteDate date,
                                                      org.hipparchus.geometry.euclidean.threed.Vector3D sensorPosition,
                                                      org.hipparchus.geometry.euclidean.threed.Vector3D los)

Direct location of a single line-of-sight.

Parameters:

date - date of the location

sensorPosition - sensor position in spacecraft frame. For simplicity, due to the size of sensor, we consider each pixel to be at sensor position

los - normalized line-of-sight in spacecraft frame

Returns:

ground position of intersection point between specified los and ground

dateLocation

public org.orekit.time.AbsoluteDate dateLocation(String sensorName,
                                                 double latitude,
                                                 double longitude,
                                                 int minLine,
                                                 int maxLine)

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 (rad)

longitude - ground point longitude (rad)

minLine - minimum line number

maxLine - maximum line number

Returns:

date at which ground point is seen by line sensor

See Also:

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

dateLocation

public org.orekit.time.AbsoluteDate dateLocation(String sensorName,
                                                 org.orekit.bodies.GeodeticPoint point,
                                                 int minLine,
                                                 int maxLine)

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

See Also:

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

inverseLocation

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

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 (rad)

longitude - ground point longitude (rad)

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

See Also:

RoughVisibilityEstimator

inverseLocation

public SensorPixel inverseLocation(String sensorName,
                                   org.orekit.bodies.GeodeticPoint point,
                                   int minLine,
                                   int maxLine)

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 - geodetic point to localize

minLine - minimum line number where the search will be performed

maxLine - maximum line number where the search will be performed

Returns:

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

See Also:

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

distanceBetweenLOS

public double[] distanceBetweenLOS(LineSensor sensorA,
                                   org.orekit.time.AbsoluteDate dateA,
                                   double pixelA,
                                   SpacecraftToObservedBody scToBodyA,
                                   LineSensor sensorB,
                                   org.orekit.time.AbsoluteDate dateB,
                                   double pixelB)

Compute distances between two line sensors.

Parameters:

sensorA - line sensor A

dateA - current date for sensor A

pixelA - pixel index for sensor A

scToBodyA - spacecraft to body transform for sensor A

sensorB - line sensor B

dateB - current date for sensor B

pixelB - pixel index for sensor B

Returns:

distances computed between LOS and to the ground

Since:

2.0

distanceBetweenLOSderivatives

public org.hipparchus.analysis.differentiation.DerivativeStructure[] distanceBetweenLOSderivatives(LineSensor sensorA,
                                                                                                   org.orekit.time.AbsoluteDate dateA,
                                                                                                   double pixelA,
                                                                                                   SpacecraftToObservedBody scToBodyA,
                                                                                                   LineSensor sensorB,
                                                                                                   org.orekit.time.AbsoluteDate dateB,
                                                                                                   double pixelB,
                                                                                                   DSGenerator generator)

Compute distances between two line sensors with derivatives.

Parameters:

sensorA - line sensor A

dateA - current date for sensor A

pixelA - pixel index for sensor A

scToBodyA - spacecraftToBody transform for sensor A

sensorB - line sensor B

dateB - current date for sensor B

pixelB - pixel index for sensor B

generator - generator to use for building DerivativeStructure instances

Returns:

distances computed, with derivatives, between LOS and to the ground

See Also:

distanceBetweenLOS(LineSensor, AbsoluteDate, double, SpacecraftToObservedBody, LineSensor, AbsoluteDate, double)

inverseLocationDerivatives

public org.hipparchus.analysis.differentiation.DerivativeStructure[] inverseLocationDerivatives(String sensorName,
                                                                                                org.orekit.bodies.GeodeticPoint point,
                                                                                                int minLine,
                                                                                                int maxLine,
                                                                                                DSGenerator generator)

Inverse location of a point with derivatives.

Parameters:

sensorName - name of the line sensor

point - point to localize

minLine - minimum line number

maxLine - maximum line number

generator - generator to use for building DerivativeStructure instances

Returns:

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

Since:

2.0

See Also:

inverseLocation(String, GeodeticPoint, int, int)

getScToInertial

public org.orekit.frames.Transform getScToInertial(org.orekit.time.AbsoluteDate date)

Get transform from spacecraft to inertial frame.

Parameters:

date - date of the transform

Returns:

transform from spacecraft to inertial frame

getInertialToBody

public org.orekit.frames.Transform getInertialToBody(org.orekit.time.AbsoluteDate date)

Get transform from inertial frame to observed body frame.

Parameters:

date - date of the transform

Returns:

transform from inertial frame to observed body frame

getBodyToInertial

public org.orekit.frames.Transform getBodyToInertial(org.orekit.time.AbsoluteDate date)

Get transform from observed body frame to inertial frame.

Parameters:

date - date of the transform

Returns:

transform from observed body frame to inertial frame

getLineSensor

public LineSensor getLineSensor(String sensorName)

Get a sensor.

Parameters:

sensorName - sensor name

Returns:

selected sensor

getScToBody

public SpacecraftToObservedBody getScToBody()

Get converter between spacecraft and body.

Returns:

the scToBody

Since:

2.0