fr.cnes.sirius.patrius.frames.transformations

Class InterpolatingTransformProvider

java.lang.Object

fr.cnes.sirius.patrius.frames.transformations.InterpolatingTransformProvider

All Implemented Interfaces:

TransformProvider, Serializable

public class InterpolatingTransformProvider
extends Object
implements TransformProvider

Transform provider using thread-safe interpolation on transforms sample.

The interpolation is a polynomial Hermite interpolation, which can either use or ignore the derivatives provided by the raw provider. This means that simple raw providers that do not compute derivatives can be used, the derivatives will be added appropriately by the interpolation process.

Spin derivative is available and computed if required.

Frames configuration is unused.

Author:

Luc Maisonobe

See Also:

TimeStampedCache, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InterpolatingTransformProvider(TransformProvider rawProviderIn, boolean useVelocitiesIn, boolean useRotationRatesIn, AbsoluteDate earliestIn, AbsoluteDate latestIn, int gridPoints, double stepIn, int maxSlots, double maxSpan, double newSlotInterval) Simple constructor.
InterpolatingTransformProvider(TransformProvider rawProviderIn, boolean useVelocitiesIn, boolean useRotationRatesIn, AbsoluteDate earliestIn, AbsoluteDate latestIn, int gridPoints, double stepIn, int maxSlots, double maxSpan, double newSlotInterval, boolean computeSpinDerivatives) Simple constructor.

Method Summary

Modifier and Type	Method and Description
TransformProvider	getRawProvider() Get the underlying provider for raw (non-interpolated) transforms.
Transform	getTransform(AbsoluteDate date) Get the Transform corresponding to specified date.
Transform	getTransform(AbsoluteDate date, boolean computeSpinDerivatives) Get the Transform corresponding to specified date.
Transform	getTransform(AbsoluteDate date, FramesConfiguration config) Get the Transform corresponding to specified date.
Transform	getTransform(AbsoluteDate date, FramesConfiguration config, boolean computeSpinDerivatives) Get the Transform corresponding to specified date.

Methods inherited from class java.lang.Object

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

Constructor Detail

InterpolatingTransformProvider

public InterpolatingTransformProvider(TransformProvider rawProviderIn,
                                      boolean useVelocitiesIn,
                                      boolean useRotationRatesIn,
                                      AbsoluteDate earliestIn,
                                      AbsoluteDate latestIn,
                                      int gridPoints,
                                      double stepIn,
                                      int maxSlots,
                                      double maxSpan,
                                      double newSlotInterval)

Simple constructor.

Parameters:

rawProviderIn - provider for raw (non-interpolated) transforms

useVelocitiesIn - if true, use sample transforms velocities, otherwise ignore them and use only positions

useRotationRatesIn - if true, use sample points rotation rates, otherwise ignore them and use only rotations

earliestIn - earliest supported date

latestIn - latest supported date

gridPoints - number of interpolation grid points

stepIn - grid points time step

maxSlots - maximum number of independent cached time slots in the time-stamped cache

maxSpan - maximum duration span in seconds of one slot in the time-stamped cache

newSlotInterval - time interval above which a new slot is created in the time-stamped cache

InterpolatingTransformProvider

public InterpolatingTransformProvider(TransformProvider rawProviderIn,
                                      boolean useVelocitiesIn,
                                      boolean useRotationRatesIn,
                                      AbsoluteDate earliestIn,
                                      AbsoluteDate latestIn,
                                      int gridPoints,
                                      double stepIn,
                                      int maxSlots,
                                      double maxSpan,
                                      double newSlotInterval,
                                      boolean computeSpinDerivatives)

Simple constructor.

Parameters:

rawProviderIn - provider for raw (non-interpolated) transforms

useVelocitiesIn - if true, use sample transforms velocities, otherwise ignore them and use only positions

useRotationRatesIn - if true, use sample points rotation rates, otherwise ignore them and use only rotations

earliestIn - earliest supported date

latestIn - latest supported date

gridPoints - number of interpolation grid points

stepIn - grid points time step

maxSlots - maximum number of independent cached time slots in the time-stamped cache

maxSpan - maximum duration span in seconds of one slot in the time-stamped cache

newSlotInterval - time interval above which a new slot is created

computeSpinDerivatives - spin derivatives are computed : true, or not : false in the time-stamped cache

Method Detail

getRawProvider

public TransformProvider getRawProvider()

Get the underlying provider for raw (non-interpolated) transforms.

Returns:

provider for raw (non-interpolated) transforms

getTransform

public Transform getTransform(AbsoluteDate date)
                       throws PatriusException

Get the Transform corresponding to specified date.

Warning: spin derivative is not computed.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date

getTransform

public Transform getTransform(AbsoluteDate date,
                              FramesConfiguration config)
                       throws PatriusException

Get the Transform corresponding to specified date.

Warning: spin derivative is not computed.

Frames configuration is unused.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

config - frames configuration to use

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date

getTransform

public Transform getTransform(AbsoluteDate date,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the Transform corresponding to specified date.

Spin derivative is available and computed if required.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

computeSpinDerivatives - true if spin derivatives should be computed. If not, spin derivative is set to null

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date

getTransform

public Transform getTransform(AbsoluteDate date,
                              FramesConfiguration config,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the Transform corresponding to specified date.

Spin derivative is available and computed if required.

Frames configuration is unused.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - current date

config - frames configuration to use

computeSpinDerivatives - true if spin derivatives should be computed. If not, spin derivative is set to null

Returns:

transform at specified date

Throws:

PatriusException - if transform cannot be computed at given date