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 anobserved measurement
.- Since:
- 8.0
- Author:
- Luc Maisonobe
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EstimatedMeasurementBase.Status
Enumerate for the status of the measurement.
-
Constructor Summary
Constructors Constructor Description EstimatedMeasurementBase(T observedMeasurement, int iteration, int count, SpacecraftState[] states, TimeStampedPVCoordinates[] participants)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IdentityHashMap<EstimationModifier<T>,double[]>
getAppliedEffects()
Get the applied effects of modifiers.int
getCount()
Get the evaluations counter.AbsoluteDate
getDate()
Get the date.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[]
getOriginalEstimatedValue()
Get the original estimated value prior to any modification.TimeStampedPVCoordinates[]
getParticipants()
Get the coordinates of the measurements participants in signal travel order.SpacecraftState[]
getStates()
Get the states of the spacecrafts.EstimatedMeasurementBase.Status
getStatus()
Get the status.double
getTimeOffset()
Get the time offset from first state date to measurement date.void
modifyEstimatedValue(EstimationModifier<T> modifier, double... newEstimatedValue)
Modify the estimated value.void
setEstimatedValue(double... estimatedValue)
Set the estimated value.void
setStatus(EstimatedMeasurementBase.Status status)
Set the status.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.estimation.measurements.ComparableMeasurement
compareTo
-
Methods inherited from interface org.orekit.time.TimeStamped
durationFrom
-
-
-
-
Constructor Detail
-
EstimatedMeasurementBase
public EstimatedMeasurementBase(T observedMeasurement, int iteration, int count, SpacecraftState[] states, TimeStampedPVCoordinates[] participants)
Simple constructor.- Parameters:
observedMeasurement
- associated observed measurementiteration
- iteration numbercount
- evaluations counterstates
- states of the spacecraftsparticipants
- 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 interfaceTimeStamped
- 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 interfaceComparableMeasurement
- Returns:
- 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 IdentityHashMap<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(EstimationModifier, double...)
-
modifyEstimatedValue
public void modifyEstimatedValue(EstimationModifier<T> modifier, double... newEstimatedValue)
Modify the estimated value.- Parameters:
modifier
- modifier that generates this estimated valuenewEstimatedValue
- 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 toREJECTED
later on, typically byOutlierFilter
orDynamicOutlierFilter
- Returns:
- status
-
setStatus
public void setStatus(EstimatedMeasurementBase.Status status)
Set the status.- Parameters:
status
- status to set
-
-