fr.cnes.sirius.patrius.signalpropagation.ionosphere

Class BentModel

java.lang.Object

fr.cnes.sirius.patrius.signalpropagation.ionosphere.BentModel

All Implemented Interfaces:

IParameterizable, IonosphericCorrection, Serializable

public class BentModel
extends Object
implements IonosphericCorrection

Bent model for the electronic content used in ionospheric corrections. This class was directly lifted from FORTRAN 90 code. For debugging ease reasons, and for lack of knowlegde on the original code, the ported code is as close as possible to the original, which means it's rather unreadable as it is.

This class is restricted to be used with EllipsoidBodyShape.

Since:

1.3

Version:

$Id$

Author:

Thomas Trapier

See Also:

IonosphericCorrection, Serialized Form

Concurrency :

thread-safe

Constructor Summary

Constructors

Constructor and Description
BentModel(R12Provider r12Provider, SolarActivityDataProvider solarActivity, USKProvider uskProvider, EllipsoidBodyShape earth, Vector3D station, Frame frameSta) Constructor for the Bent ionospheric correction model.
BentModel(R12Provider r12Provider, SolarActivityDataProvider solarActivity, USKProvider uskProvider, TopocentricFrame stationTopoFrame) Constructor for the Bent ionospheric correction model.

Method Summary

Modifier and Type	Method and Description
double	computeElectronicCont(AbsoluteDate date, Vector3D satellite, Frame frameSat) Computation of the electric content between the station and the satellite at a date.
double	computeSignalDelay(double freq, AbsoluteDate date, Vector3D satellite, Frame frameSat) Calculates the ionospheric signal delay for the signal path from the position of the transmitter and the receiver and the current date.
double	derivativeValue(Parameter p, AbsoluteDate date, Vector3D satellite, Frame satFrame) Compute the derivative value with respect to the input parameter.
ArrayList<Parameter>	getParameters() Get the supported parameters.
boolean	isDifferentiableBy(Parameter p) Tell if the function is differentiable by the given parameter.
boolean	supportsParameter(Parameter param) Check if a parameter is supported.

Methods inherited from class java.lang.Object

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

Constructor Detail

BentModel

public BentModel(R12Provider r12Provider,
                 SolarActivityDataProvider solarActivity,
                 USKProvider uskProvider,
                 EllipsoidBodyShape earth,
                 Vector3D station,
                 Frame frameSta)
          throws PatriusException

Constructor for the Bent ionospheric correction model.

Parameters:

r12Provider - provider for the R12 value

solarActivity - provider for the solar activity

uskProvider - provider for the model data

earth - earth body shape

station - coordinates of the position of the STATION in the frameSta frame

frameSta - frame in witch the STATION coordinates are expressed

Throws:

PatriusException - if point cannot be converted to body frame

BentModel

public BentModel(R12Provider r12Provider,
                 SolarActivityDataProvider solarActivity,
                 USKProvider uskProvider,
                 TopocentricFrame stationTopoFrame)

Constructor for the Bent ionospheric correction model.

Parameters:

r12Provider - provider for the R12 value

solarActivity - provider for the solar activity

uskProvider - provider for the model data

stationTopoFrame - topocentric frame defining the STATION frame. Warning this frame should only relate to EllipsoidBodyShape and EllipsoidPoint.

Method Detail

supportsParameter

public boolean supportsParameter(Parameter param)

Check if a parameter is supported.

Specified by:

supportsParameter in interface IParameterizable

Parameters:

param - parameter to check

Returns:

true if the parameter is supported

getParameters

public ArrayList<Parameter> getParameters()

Get the supported parameters.

Specified by:

getParameters in interface IParameterizable

Returns:

list of supported parameters

derivativeValue

public double derivativeValue(Parameter p,
                              AbsoluteDate date,
                              Vector3D satellite,
                              Frame satFrame)

Compute the derivative value with respect to the input parameter.

Specified by:

derivativeValue in interface IonosphericCorrection

Parameters:

p - parameter

date - the current date

satellite - the satellite position

satFrame - the satellite position frame

Returns:

the derivative value

isDifferentiableBy

public boolean isDifferentiableBy(Parameter p)

Tell if the function is differentiable by the given parameter.

Specified by:

isDifferentiableBy in interface IonosphericCorrection

Parameters:

p - function parameter

Returns:

true if the function is differentiable by the given parameter.

computeSignalDelay

public double computeSignalDelay(double freq,
                                 AbsoluteDate date,
                                 Vector3D satellite,
                                 Frame frameSat)
                          throws PatriusException

Calculates the ionospheric signal delay for the signal path from the position of the transmitter and the receiver and the current date.

Specified by:

computeSignalDelay in interface IonosphericCorrection

Parameters:

freq - signal frequency [Hz]

date - the current date

satellite - the satellite position

frameSat - the satellite position frame

Returns:

the ionospheric signal delay

Throws:

PatriusException - thrown if computation failed

computeElectronicCont

public double computeElectronicCont(AbsoluteDate date,
                                    Vector3D satellite,
                                    Frame frameSat)
                             throws PatriusException

Computation of the electric content between the station and the satellite at a date.

Parameters:

date - current date

satellite - coordinates of the position of the SATELLITE in the frameSta frame

frameSat - frame in witch the SATELLITE coordinates are expressed

Returns:

the electronic content between the station and the satellite at this date.

Throws:

PatriusException - if an error occur with the dates and frames management