Package org.orekit.estimation.measurements

Class EstimatedMeasurement<T extends ObservedMeasurement<T>>

java.lang.Object

org.orekit.estimation.measurements.EstimatedMeasurement<T>

Type Parameters:

T - the type of the measurement

All Implemented Interfaces:

Comparable<T>, ComparableMeasurement, TimeStamped

public class EstimatedMeasurement<T extends ObservedMeasurement<T>>
extends Object
implements ComparableMeasurement

Class holding an estimated theoretical value associated to an observed measurement.

Since:

8.0

Author:

Luc Maisonobe

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EstimatedMeasurement.Status	Enumerate for the status of the measurement.

Constructor Summary

Constructors

Constructor	Description
EstimatedMeasurement(T observedMeasurement, int iteration, int count, SpacecraftState[] states, TimeStampedPVCoordinates[] participants)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
int	getCount()	Get the evaluations counter.
double[]	getCurrentWeight()	Deprecated. as of 9.2, weight should not be changed anymore, rejected measurements are identified by their status
AbsoluteDate	getDate()	Get the date.
Stream<ParameterDriver>	getDerivativesDrivers()	Get all the drivers with set derivatives.
double[]	getEstimatedValue()	Get the estimated value.
int	getIteration()	Get the iteration number.
T	getObservedMeasurement()	Get the associated observed measurement.
double[]	getObservedValue()	Get the observed value.
double[]	getParameterDerivatives(ParameterDriver driver)	Get the partial derivatives of the simulated measurement with respect to a parameter.
TimeStampedPVCoordinates[]	getParticipants()	Get the coordinates of the measurements participants in signal travel order.
double[][]	getStateDerivatives(int index)	Get the partial derivatives of the simulated measurement with respect to state Cartesian coordinates.
SpacecraftState[]	getStates()	Get the states of the spacecrafts.
EstimatedMeasurement.Status	getStatus()	Get the status.
double	getTimeOffset()	Get the time offset from first state date to measurement date.
void	setCurrentWeight(double... currentWeight)	Deprecated. as of 9.2, weight should not be changed anymore, rejected measurements are identified by their status
void	setEstimatedValue(double... estimatedValue)	Set the estimated value.
void	setParameterDerivatives(ParameterDriver driver, double... parameterDerivatives)	Set the partial derivatives of the simulated measurement with respect to parameter.
void	setStateDerivatives(int index, double[]... derivatives)	Set the partial derivatives of the simulated measurement with respect to state Cartesian coordinates.
void	setStatus(EstimatedMeasurement.Status status)	Set the status.

Methods inherited from interface org.orekit.estimation.measurements.ComparableMeasurement

compareTo

Methods inherited from class java.lang.Object

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

Constructor Detail

EstimatedMeasurement

public EstimatedMeasurement(T observedMeasurement,
                            int iteration,
                            int count,
                            SpacecraftState[] states,
                            TimeStampedPVCoordinates[] participants)

Simple constructor.

Parameters:

observedMeasurement - associated observed measurement

iteration - iteration number

count - evaluations counter

states - states of the spacecrafts

participants - coordinates of the participants in signal travel order in inertial frame

Method Detail

getObservedMeasurement

public T getObservedMeasurement()

Get the associated observed measurement.

Returns:

associated observed measurement

getDate

public AbsoluteDate getDate()

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object

getIteration

public int getIteration()

Get the iteration number.

Returns:

iteration number

getCount

public int getCount()

Get the evaluations counter.

Returns:

evaluations counter

getStates

public SpacecraftState[] getStates()

Get the states of the spacecrafts.

Returns:

states of the spacecrafts

getParticipants

public TimeStampedPVCoordinates[] getParticipants()

Get the coordinates of the measurements participants in signal travel order.

First participant (at index 0) emits the signal (it is for example a ground station for two-way range measurement). Last participant receives the signal (it is also the ground station for two-way range measurement, but a few milliseconds later). Intermediate participants relfect the signal (it is the spacecraft for two-way range measurement).

Returns:

coordinates of the measurements participants in signal travel order in inertial frame

getTimeOffset

public double getTimeOffset()

Get the time offset from first state date to measurement date.

Returns:

time offset from first state date to measurement date

getObservedValue

public double[] getObservedValue()

Get the observed value.

The observed value is the value that was measured by the instrument.

Specified by:

getObservedValue in interface ComparableMeasurement

Returns:

observed value

getEstimatedValue

public double[] getEstimatedValue()

Get the estimated value.

Returns:

estimated value

setEstimatedValue

public void setEstimatedValue(double... estimatedValue)

Set the estimated value.

Parameters:

estimatedValue - estimated value

getCurrentWeight

@Deprecated
public double[] getCurrentWeight()

Deprecated. as of 9.2, weight should not be changed anymore, rejected measurements are identified by their status

Get the current weight.

By default, the current weight is measurement base weight.

Returns:

current weight

setCurrentWeight

@Deprecated
public void setCurrentWeight(double... currentWeight)

Deprecated. as of 9.2, weight should not be changed anymore, rejected measurements are identified by their status

Set the current weight.

Parameters:

currentWeight - current weight

getStatus

public EstimatedMeasurement.Status getStatus()

Get the status.

The status is set to PROCESSED at construction, and can be reset to REJECTED later on, typically by OutlierFilter or DynamicOutlierFilter

Returns:

status

setStatus

public void setStatus(EstimatedMeasurement.Status status)

Set the status.

Parameters:

status - status to set

getStateDerivatives

public double[][] getStateDerivatives(int index)

Get the partial derivatives of the simulated measurement with respect to state Cartesian coordinates.

Parameters:

index - index of the state, according to the states passed at construction

Returns:

partial derivatives of the simulated value (array of size dimension x 6)

setStateDerivatives

public void setStateDerivatives(int index,
                                double[]... derivatives)

Set the partial derivatives of the simulated measurement with respect to state Cartesian coordinates.

Parameters:

index - index of the state, according to the states passed at construction

derivatives - partial derivatives with respect to state

getDerivativesDrivers

public Stream<ParameterDriver> getDerivativesDrivers()

Get all the drivers with set derivatives.

Returns:

all the drivers with set derivatives

Since:

9.0

getParameterDerivatives

public double[] getParameterDerivatives(ParameterDriver driver)
                                 throws OrekitIllegalArgumentException

Get the partial derivatives of the simulated measurement with respect to a parameter.

Parameters:

driver - driver for the parameter

Returns:

partial derivatives of the simulated value

Throws:

OrekitIllegalArgumentException - if parameter is unknown

setParameterDerivatives

public void setParameterDerivatives(ParameterDriver driver,
                                    double... parameterDerivatives)

Set the partial derivatives of the simulated measurement with respect to parameter.

Parameters:

driver - driver for the parameter

parameterDerivatives - partial derivatives with respect to parameter