Package org.orekit.estimation.measurements

Class EstimatedMeasurementBase<T extends ObservedMeasurement<T>>

java.lang.Object
org.orekit.estimation.measurements.EstimatedMeasurementBase<T>
Type Parameters:
T - the type of the measurement
All Implemented Interfaces:
Comparable<ComparableMeasurement>, ComparableMeasurement, TimeStamped
Direct Known Subclasses:
EstimatedMeasurement
public class EstimatedMeasurementBase<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

  • Constructor Details

    • EstimatedMeasurementBase

      public EstimatedMeasurementBase(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 of first state

  • Method Details

    • 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. Can be empty if not computed beforehand for performance reasons.

      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 reflect the signal (it is the spacecraft for two-way range measurement).

      Returns:
      coordinates of the measurements participants in signal travel order in inertial frame of first state

    • 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

    • setObservedValue

      public void setObservedValue(double[] observed)
      Set the observed value.

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

      Specified by:
      setObservedValue in interface ComparableMeasurement
      Parameters:
      observed - observed value

    • getOriginalEstimatedValue

      public double[] getOriginalEstimatedValue()
      Get the original estimated value prior to any modification.
      Returns:
      original estimated value prior to any modification
      Since:
      12.1

    • getAppliedEffects

      public Map<EstimationModifier<T>,double[]> getAppliedEffects()
      Get the applied effects of modifiers.

      The effects have already accounted for in getEstimatedValue()

      Returns:
      applied modifier effects
      Since:
      12.1

    • 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
      See Also:

    • modifyEstimatedValue

      public void modifyEstimatedValue(EstimationModifier<T> modifier, double... newEstimatedValue)
      Modify the estimated value.
      Parameters:
      modifier - modifier that generates this estimated value
      newEstimatedValue - new estimated value
      Since:
      12.1

    • getStatus

      public EstimatedMeasurementBase.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(EstimatedMeasurementBase.Status status)
      Set the status.
      Parameters:
      status - status to set