Package org.orekit.estimation.measurements.modifiers

Class PhaseAmbiguityModifier

java.lang.Object

org.orekit.estimation.measurements.modifiers.PhaseAmbiguityModifier

All Implemented Interfaces:

EstimationModifier<Phase>

public class PhaseAmbiguityModifier
extends Object
implements EstimationModifier<Phase>

Class modifying theoretical phase measurement with ambiguity.

Since:

9.2

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor	Description
PhaseAmbiguityModifier(int key, double ambiguity)	Constructor.

Method Summary

Modifier and Type	Method	Description
List<ParameterDriver>	getParametersDrivers()	Get the drivers for this modifier parameters.
void	modify(EstimatedMeasurement<Phase> estimated)	Apply a modifier to an estimated measurement.

Methods inherited from class java.lang.Object

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

Constructor Detail

PhaseAmbiguityModifier

public PhaseAmbiguityModifier(int key,
                              double ambiguity)
                       throws OrekitException

Constructor.

It is expected that many different ambiguities will be used at the same time during an orbit determination, therefore they are keyed using a simple integer. All ambiguities using the same key will be enforced to be equal. It is the responsibility of the caller to use a proper counter to manage the ambiguities properly.

Parameters:

key - key to identify the ambiguity

ambiguity - initial value of ambiguity

Throws:

OrekitException - if parameter scale is too close to zero (never happens)

Method Detail

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Get the drivers for this modifier parameters.

Specified by:

getParametersDrivers in interface EstimationModifier<Phase>

Returns:

drivers for this modifier parameters

modify

public void modify(EstimatedMeasurement<Phase> estimated)
            throws OrekitException

Description copied from interface: EstimationModifier

Apply a modifier to an estimated measurement.

Specified by:

modify in interface EstimationModifier<Phase>

Parameters:

estimated - estimated measurement to modify

Throws:

OrekitException - if modifier cannot be applied