fr.cnes.sirius.patrius.propagation.precomputed

Class PVEphemeris

java.lang.Object

fr.cnes.sirius.patrius.propagation.AbstractPropagator

fr.cnes.sirius.patrius.propagation.precomputed.PVEphemeris

All Implemented Interfaces:

PVCoordinatesProvider, BoundedPropagator, Propagator, SpacecraftStateProvider, Serializable

public class PVEphemeris
extends AbstractPropagator
implements BoundedPropagator

This class is designed to accept and handle tabulated orbital entries described by time-stamped PVCoordinates.
Tabulated entries are classified and then extrapolated in a way to obtain continuous output, with accuracy and computation methods configured by the user.

Note: This implementation does not support all the methods of the Propagator interface in the case the provided frame is not pseudo-inertial. In particular, the propagate methods.

Author:

veuillh

See Also:

Serialized Form

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.propagation.AbstractPropagator

MASS

Fields inherited from interface fr.cnes.sirius.patrius.propagation.Propagator

EPHEMERIS_GENERATION_MODE, MASTER_MODE, SLAVE_MODE

Constructor Summary

Constructors

Constructor and Description
PVEphemeris(List<TimeStampedPVCoordinates> pvts, int order, Frame frame, double mu, CartesianDerivativesFilter filter) Standard constructor.
PVEphemeris(List<TimeStampedPVCoordinates> pvts, int order, Frame frame, double mu, CartesianDerivativesFilter filter, AttitudeProvider attitudeProvider) Standard constructor.
PVEphemeris(List<TimeStampedPVCoordinates> pvts, int order, Frame frame, double mu, CartesianDerivativesFilter filter, AttitudeProvider attitudeProvider, boolean acceptOutOfOptimalRange) Standard constructor.
PVEphemeris(List<TimeStampedPVCoordinates> pvts, int order, Frame frame, double mu, CartesianDerivativesFilter filter, AttitudeProvider attitudeProvider, boolean acceptOutOfOptimalRange, int cacheSize) Standard constructor.
PVEphemeris(List<TimeStampedPVCoordinates> pvts, int order, Frame frame, double mu, CartesianDerivativesFilter filter, AttitudeProvider attitudeProvider, boolean acceptOutOfOptimalRange, int cacheSize, boolean computeAcceleration) Full constructor.

Method Summary

Modifier and Type	Method and Description
double	getCacheReusabilityRatio() Provides the ratio of reusability of the internal cache.
TimeStampedPVCoordinates	getFirstTimeStampedPVCoordinates() Getter for the first time-stamped PVCoordinates.
Frame	getFrame() Getter for the frame in which the time-stamped PVCoordinates are defined.
SpacecraftState	getInitialState() Get the propagator initial state.
TimeStampedPVCoordinates	getLastTimeStampedPVCoordinates() Getter for the last time-stamped PVCoordinates.
AbsoluteDate	getMaxDate() Get the last date of the range.
AbsoluteDate	getMaxOptimalDate()
AbsoluteDate	getMaxSampleDate()
AbsoluteDate	getMinDate() Get the first date of the range.
AbsoluteDate	getMinOptimalDate()
AbsoluteDate	getMinSampleDate()
Frame	getNativeFrame(AbsoluteDate date) Getter for the frame in which the time-stamped PVCoordinates are defined.
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frameOut) Default implementation for PVCoordinatesProvider feature using the SpacecraftState object's orbit.
TimeStampedInterpolableEphemeris.SearchMethod	getSearchMethod() Getter for the search method.
SpacecraftState	getSpacecraftState(AbsoluteDate date) Get the SpacecraftState at provided date.
TimeStampedPVCoordinates[]	getTimeStampedPVCoordinates(boolean copy) Getter for the time-stamped PVCoordinates array.
int	getTimeStampedPVCoordinatesSize() Getter for the time-stamped PVCoordinates size.
boolean	isAcceptOutOfOptimalRange() Indicates whether accept dates outside of the optimal interval which is a sub-interval from the full interval interval required for interpolation with respect to the interpolation order.
Orbit	propagateOrbit(AbsoluteDate date) Extrapolate an orbit up to a specific target date.
void	resetInitialState(SpacecraftState state) Try (and fail) to reset the initial state.
void	setOrbitFrame(Frame frameIn) Set propagation frame.
void	setSearchMethod(TimeStampedInterpolableEphemeris.SearchMethod searchMethod) Setter for the search method.

Methods inherited from class fr.cnes.sirius.patrius.propagation.AbstractPropagator

acceptStep, addAdditionalStateProvider, addAdditionalStateProvider, addEventDetector, basicPropagate, clearEventsDetectors, getAttitudeProvider, getAttitudeProviderEvents, getAttitudeProviderForces, getEventsDetectors, getGeneratedEphemeris, getMode, getPvProvider, manageStateFrame, propagate, propagate, setAttitudeProvider, setAttitudeProviderEvents, setAttitudeProviderForces, setEphemerisMode, setMasterMode, setMasterMode, setSlaveMode, setStartDate

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.propagation.Propagator

addEventDetector, clearEventsDetectors, getAttitudeProvider, getAttitudeProviderEvents, getAttitudeProviderForces, getEventsDetectors, getGeneratedEphemeris, getMode, propagate, propagate, setAttitudeProvider, setAttitudeProviderEvents, setAttitudeProviderForces, setEphemerisMode, setMasterMode, setMasterMode, setSlaveMode

Constructor Detail

PVEphemeris

public PVEphemeris(List<TimeStampedPVCoordinates> pvts,
                   int order,
                   Frame frame,
                   double mu,
                   CartesianDerivativesFilter filter)

Standard constructor. This ephemeris doesn't describe an attitude provider.

By default, the dates outside of the optimal interval aren't allowed.

By default, the cache size is set to DEFAULT_MAX_SIZE.

By default, the acceleration is computed.

Parameters:

pvts - Tabulated time-stamped PVCoordinates

order - Interpolation order (number of points to use for the interpolation). It must be even.

frame - The frame in which the time-stamped PVCoordinates are defined

mu - Central attraction coefficient (m³/s²)

filter - Filter describing which derivatives to use in TimeStampedPVCoordinates and interpolation

Throws:

NullArgumentException - if pvts, frame or filter is null

IllegalArgumentException - if the tabulated time-stamped PVCoordinates contained elements defined at the same date if the order is an odd number or is lower than 2 if the tabulated time-stamped PVCoordinates array length is lower than the order

PVEphemeris

public PVEphemeris(List<TimeStampedPVCoordinates> pvts,
                   int order,
                   Frame frame,
                   double mu,
                   CartesianDerivativesFilter filter,
                   AttitudeProvider attitudeProvider)

Standard constructor. This ephemeris describes an attitude provider.

By default, the dates outside of the optimal interval aren't allowed.

By default, the cache size is set to DEFAULT_MAX_SIZE.

By default, the acceleration is computed.

Parameters:

pvts - Tabulated time-stamped PVCoordinates

order - Interpolation order (number of points to use for the interpolation)

frame - The frame in which the time-stamped PVCoordinates are defined

mu - Central attraction coefficient (m³/s²)

filter - Filter describing which derivatives to use in TimeStampedPVCoordinates and interpolation

attitudeProvider - Provider for attitude computation in case of both forces and events computation. Can be null.

Throws:

NullArgumentException - if pvts, frame or filter is null

IllegalArgumentException - if the tabulated time-stamped PVCoordinates contained elements defined at the same date if the order is an odd number or is lower than 2 if the tabulated time-stamped PVCoordinates array length is lower than the order

PVEphemeris

public PVEphemeris(List<TimeStampedPVCoordinates> pvts,
                   int order,
                   Frame frame,
                   double mu,
                   CartesianDerivativesFilter filter,
                   AttitudeProvider attitudeProvider,
                   boolean acceptOutOfOptimalRange)

Standard constructor. This ephemeris describes an attitude provider.

By default, the cache size is set to DEFAULT_MAX_SIZE.

By default, the acceleration is computed.

Parameters:

pvts - Tabulated time-stamped PVCoordinates

order - Interpolation order (number of points to use for the interpolation)

frame - The frame in which the time-stamped PVCoordinates are defined

mu - Central attraction coefficient (m³/s²)

filter - Filter describing which derivatives to use in TimeStampedPVCoordinates and interpolation

attitudeProvider - Provider for attitude computation in case of both forces and events computation. Can be null.

acceptOutOfOptimalRange - Indicates whether accept dates outside of the optimal interval which is a sub-interval from the full interval required for interpolation with respect to the interpolation order

Throws:

NullArgumentException - if pvts, frame or filter is null

IllegalArgumentException - if the tabulated time-stamped PVCoordinates contained elements defined at the same date if the order is an odd number or is lower than 2 if the tabulated time-stamped PVCoordinates array length is lower than the order

PVEphemeris

public PVEphemeris(List<TimeStampedPVCoordinates> pvts,
                   int order,
                   Frame frame,
                   double mu,
                   CartesianDerivativesFilter filter,
                   AttitudeProvider attitudeProvider,
                   boolean acceptOutOfOptimalRange,
                   int cacheSize)

Standard constructor. This ephemeris describes an attitude provider.

By default, the acceleration is computed.

Parameters:

pvts - Tabulated time-stamped PVCoordinates

order - Interpolation order (number of points to use for the interpolation)

frame - The frame in which the time-stamped PVCoordinates are defined

mu - Central attraction coefficient (m³/s²)

filter - Filter describing which derivatives to use in TimeStampedPVCoordinates and interpolation

attitudeProvider - Provider for attitude computation in case of both forces and events computation. Can be null.

acceptOutOfOptimalRange - Indicates whether accept dates outside of the optimal interval which is a sub-interval from the full interval required for interpolation with respect to the interpolation order

cacheSize - The size of the cache. 0 is a legitimate value emulating the absence of cache.

Throws:

NullArgumentException - if pvts, frame or filter is null

IllegalArgumentException - if the tabulated time-stamped PVCoordinates contained elements defined at the same date if the order is an odd number or is lower than 2 if the tabulated time-stamped PVCoordinates array length is lower than the order

PVEphemeris

public PVEphemeris(List<TimeStampedPVCoordinates> pvts,
                   int order,
                   Frame frame,
                   double mu,
                   CartesianDerivativesFilter filter,
                   AttitudeProvider attitudeProvider,
                   boolean acceptOutOfOptimalRange,
                   int cacheSize,
                   boolean computeAcceleration)

Full constructor.

Parameters:

pvts - Tabulated time-stamped PVCoordinates

order - Interpolation order (number of points to use for the interpolation)

frame - The frame in which the time-stamped PVCoordinates are defined

mu - Central attraction coefficient (m³/s²)

filter - Filter describing which derivatives to use in TimeStampedPVCoordinates and interpolation

attitudeProvider - Provider for attitude computation in case of both forces and events computation. Can be null.

acceptOutOfOptimalRange - Indicates whether accept dates outside of the optimal interval which is a sub-interval from the full interval required for interpolation with respect to the interpolation order

cacheSize - The size of the cache. 0 is a legitimate value emulating the absence of cache.

computeAcceleration - true if the acceleration should be computed, false otherwise

Throws:

NullArgumentException - if pvts, frame or filter is null

IllegalArgumentException - if the tabulated time-stamped PVCoordinates contained elements defined at the same date if the order is an odd number or is lower than 2 if the tabulated time-stamped PVCoordinates array length is lower than the order

NotPositiveException - if cacheSize < 0

Method Detail

propagateOrbit

public Orbit propagateOrbit(AbsoluteDate date)

Extrapolate an orbit up to a specific target date.

Specified by:

propagateOrbit in class AbstractPropagator

Parameters:

date - target date for the orbit

Returns:

extrapolated parameters

Throws:

IllegalStateException - if the date is outside the supported interval if the instance has been built with the setting acceptOutOfOptimalRange = false and the date is outside the optimal interval which is a sub-interval from the full interval interval required for interpolation with respect to the interpolation order

getPVCoordinates

public PVCoordinates getPVCoordinates(AbsoluteDate date,
                                      Frame frameOut)
                               throws PatriusException

Default implementation for PVCoordinatesProvider feature using the SpacecraftState object's orbit.

Get the PVCoordinates of the body in the selected frame.

Specified by:

getPVCoordinates in interface PVCoordinatesProvider

Specified by:

getPVCoordinates in interface SpacecraftStateProvider

Overrides:

getPVCoordinates in class AbstractPropagator

Parameters:

date - current date

frameOut - the frame where to define the position

Returns:

position/velocity of the body (m and m/s)

Throws:

IllegalStateException - if the date is outside the supported interval if the instance has been built with the setting acceptOutOfOptimalRange = false and the date is outside the optimal interval which is a sub-interval from the full interval interval required for interpolation with respect to the interpolation order

PatriusException - if position cannot be computed in given frame

getSpacecraftState

public SpacecraftState getSpacecraftState(AbsoluteDate date)
                                   throws PropagationException

Get the SpacecraftState at provided date.

Specified by:

getSpacecraftState in interface SpacecraftStateProvider

Overrides:

getSpacecraftState in class AbstractPropagator

Parameters:

date - target date

Returns:

spacecraft state

Throws:

IllegalStateException - if the date is outside the supported interval if the instance has been built with the setting acceptOutOfOptimalRange = false and the date is outside the optimal interval which is a sub-interval from the full interval interval required for interpolation with respect to the interpolation order

PropagationException - if state cannot be computed

resetInitialState

public void resetInitialState(SpacecraftState state)
                       throws PropagationException

Try (and fail) to reset the initial state.

This method always throws an exception, as ephemeris cannot be reset.

Specified by:

resetInitialState in interface Propagator

Overrides:

resetInitialState in class AbstractPropagator

Parameters:

state - New initial state to consider

Throws:

PropagationException - always thrown as ephemeris cannot be reset

getInitialState

public SpacecraftState getInitialState()
                                throws PropagationException

Get the propagator initial state.

Specified by:

getInitialState in interface Propagator

Overrides:

getInitialState in class AbstractPropagator

Returns:

initial state

Throws:

PropagationException

getFirstTimeStampedPVCoordinates

public TimeStampedPVCoordinates getFirstTimeStampedPVCoordinates()

Getter for the first time-stamped PVCoordinates.

Returns:

the first time-stamped PVCoordinates

getLastTimeStampedPVCoordinates

public TimeStampedPVCoordinates getLastTimeStampedPVCoordinates()

Getter for the last time-stamped PVCoordinates.

Returns:

the last time-stamped PVCoordinates

getMinDate

public AbsoluteDate getMinDate()

Get the first date of the range.

Specified by:

getMinDate in interface BoundedPropagator

Returns:

the first date of the range

getMaxDate

public AbsoluteDate getMaxDate()

Get the last date of the range.

Specified by:

getMaxDate in interface BoundedPropagator

Returns:

the last date of the range

getMinSampleDate

public AbsoluteDate getMinSampleDate()

Returns:

The first sample date.

getMaxSampleDate

public AbsoluteDate getMaxSampleDate()

Returns:

The last sample date.

getMinOptimalDate

public AbsoluteDate getMinOptimalDate()

Returns:

The first optimal date.

getMaxOptimalDate

public AbsoluteDate getMaxOptimalDate()

Returns:

The last optimal date.

getTimeStampedPVCoordinatesSize

public int getTimeStampedPVCoordinatesSize()

Getter for the time-stamped PVCoordinates size.

Returns:

the time-stamped PVCoordinates size

getTimeStampedPVCoordinates

public TimeStampedPVCoordinates[] getTimeStampedPVCoordinates(boolean copy)

Getter for the time-stamped PVCoordinates array.

Parameters:

copy - if true return a copy of the time-stamped PVCoordinates array, otherwise return the stored array

Returns:

the time-stamped PVCoordinates array

getCacheReusabilityRatio

public double getCacheReusabilityRatio()

Provides the ratio of reusability of the internal cache. This method can help to chose the size of the cache.

Returns:

the reusability ratio (0 means no reusability at all, 0.5 means that the supplier is called only half time compared to computeIf method)

isAcceptOutOfOptimalRange

public boolean isAcceptOutOfOptimalRange()

Indicates whether accept dates outside of the optimal interval which is a sub-interval from the full interval interval required for interpolation with respect to the interpolation order.

Returns:

true if the dates outside of the optimal interval are accepted, false otherwise

getSearchMethod

public TimeStampedInterpolableEphemeris.SearchMethod getSearchMethod()

Getter for the search method.

Returns:

the search method

setSearchMethod

public void setSearchMethod(TimeStampedInterpolableEphemeris.SearchMethod searchMethod)

Setter for the search method.

Parameters:

searchMethod - the search method to set

Throws:

NullArgumentException - if searchMethod is null

getFrame

public Frame getFrame()

Getter for the frame in which the time-stamped PVCoordinates are defined.

Specified by:

getFrame in interface Propagator

Overrides:

getFrame in class AbstractPropagator

Returns:

frame in which the time-stamped PVCoordinates are defined.

getNativeFrame

public Frame getNativeFrame(AbsoluteDate date)

Getter for the frame in which the time-stamped PVCoordinates are defined.

Specified by:

getNativeFrame in interface PVCoordinatesProvider

Specified by:

getNativeFrame in interface Propagator

Parameters:

date - a date

Returns:

frame in which the time-stamped PVCoordinates are defined.

setOrbitFrame

public void setOrbitFrame(Frame frameIn)

Set propagation frame.

This feature isn't supported by this implementation as the frame in which the time-stamped PVCoordinates are defined is set in the constructor and this frame is used to propagate the time-stamped PVCoordinates.

Specified by:

setOrbitFrame in interface BoundedPropagator

Overrides:

setOrbitFrame in class AbstractPropagator

Parameters:

frameIn - the frame to use

Throws:

UnsupportedOperationException - always thrown by this implementation