fr.cnes.sirius.patrius.time.interpolation

Class TimeStampedInterpolableEphemeris<IN extends TimeStamped,OUT>

java.lang.Object

fr.cnes.sirius.patrius.time.interpolation.TimeStampedInterpolableEphemeris<IN,OUT>

Type Parameters:

IN - The type of the samples to be interpolated

OUT - The type of the interpolation result.
For generality sake, it can be different from IN (for example, we can interpolate a sub-data of IN).

All Implemented Interfaces:

Serializable

public class TimeStampedInterpolableEphemeris<IN extends TimeStamped,OUT>
extends Object
implements Serializable

Class representing an interpolable ephemeris for any time stamped data. It is thread-safe.

This class makes a difference between 3 interval types:

• The samples interval corresponds to the first and last date of the provided samples.
• The optimal interval is related to the order of interpolation. Indeed, interpolation is of best quality when it is performed between the 2 central points of the interpolation (if interpolation is of order 8, then interpolation quality is best if there are 4 points before and 4 points after).
• The usable interval corresponds, depending on isAcceptOutOfOptimalRange(), either to the samples interval or to the optimal interval

Author:

veuillh

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeStampedInterpolableEphemeris.SearchMethod Enumerate to specify the search method used to find the correct samples interval given a certain date.

Constructor Summary

Constructors

Constructor and Description
TimeStampedInterpolableEphemeris(IN[] samples, int order, TimeStampedInterpolationFunctionBuilder<IN,OUT> interpFctBuilder, boolean acceptOutOfOptimalRange) Simplified constructor. By default, the given samples are copied to be stored, plus they are checked to be strictly sorted (in increasing order and no samples with the same date) and a cache size of FIFOThreadSafeCache.DEFAULT_MAX_SIZE is used.
TimeStampedInterpolableEphemeris(IN[] samples, int order, TimeStampedInterpolationFunctionBuilder<IN,OUT> interpFctBuilder, boolean acceptOutOfOptimalRange, boolean copySamples, boolean checkStrictlySorted, int cacheSize) Standard constructor.

Method Summary

Modifier and Type	Method and Description
TimeStampedInterpolableEphemeris<IN,OUT>	extendInterpolableEphemeris(IN[] extraSamples, boolean addOnTheRight, boolean checkStrictlySorted) Extend the current interpolable ephemeris with new samples while keeping the cache.
double	getCacheReusabilityRatio() Provides the ratio of reusability of the internal cache.
int	getCeilingIndex(AbsoluteDate date) Getter for the ceiling index for the given date. If the provided date is after the last sample, -1 is returned.
IN	getCeilingSample(AbsoluteDate date) Getter for the ceiling sample for the given date.
AbsoluteDate	getFirstDate() Getter for the first date.
AbsoluteDate	getFirstOptimalDate() Getter for the first optimal date.
IN	getFirstSample() Getter for the first sample.
AbsoluteDate	getFirstUsableDate() Getter for the first usable date.
int	getFloorIndex(AbsoluteDate date) Getter for the floor index for the given date. If the provided date is before the first sample, -1 is returned.
IN	getFloorSample(AbsoluteDate date) Getter for the floor sample for the given date.
AbsoluteDate	getLastDate() Getter for the last date.
AbsoluteDate	getLastOptimalDate() Getter for the last optimal date.
IN	getLastSample() Getter for the last sample.
AbsoluteDate	getLastUsableDate() Getter for the last usable date.
IN[]	getSamples(boolean copy) Getter for the samples array.
int	getSampleSize() Getter for the sample size.
TimeStampedInterpolableEphemeris.SearchMethod	getSearchMethod() Getter for the search method.
OUT	interpolate(AbsoluteDate date) Returns an interpolated instance at the required date.
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.
void	setSearchMethod(TimeStampedInterpolableEphemeris.SearchMethod searchMethod) Setter for the search method.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeStampedInterpolableEphemeris

public TimeStampedInterpolableEphemeris(IN[] samples,
                                        int order,
                                        TimeStampedInterpolationFunctionBuilder<IN,OUT> interpFctBuilder,
                                        boolean acceptOutOfOptimalRange)

Simplified constructor.
By default, the given samples are copied to be stored, plus they are checked to be strictly sorted (in increasing order and no samples with the same date) and a cache size of FIFOThreadSafeCache.DEFAULT_MAX_SIZE is used.

Note: The interpolation function builder has to implement Serializable if the interpolable ephemeris should be serializable (not required).

Parameters:

samples - The array of samples

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

interpFctBuilder - The function that can build an interpolation function

acceptOutOfOptimalRange - 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

Throws:

NullArgumentException - if samples is null

IllegalArgumentException - if the samples aren't sorted if the order isn't an even number or is lower than 2 if the interpolable ephemeris length is lower than the order

TimeStampedInterpolableEphemeris

public TimeStampedInterpolableEphemeris(IN[] samples,
                                        int order,
                                        TimeStampedInterpolationFunctionBuilder<IN,OUT> interpFctBuilder,
                                        boolean acceptOutOfOptimalRange,
                                        boolean copySamples,
                                        boolean checkStrictlySorted,
                                        int cacheSize)

Standard constructor.

Note: The interpolation function builder has to implement Serializable if the interpolable ephemeris should be serializable (not required).

Parameters:

samples - The array of samples

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

interpFctBuilder - The function that can build an interpolation function

acceptOutOfOptimalRange - 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

copySamples - Indicates whether the given samples should be copied or stored directly

checkStrictlySorted - Indicates whether the given samples should be checked to be strictly sorted (in increasing order and no samples with the same date) or if it's not necessary

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

Throws:

NullArgumentException - if samples or interpolationFunctionBuilder is null

IllegalArgumentException - if the samples should be sorted (checkStrictlySorted = true) and aren't if the order is an odd number or is lower than 2 if the samples array length is lower than the order

NotPositiveException - if cacheSize < 0

Method Detail

extendInterpolableEphemeris

public TimeStampedInterpolableEphemeris<IN,OUT> extendInterpolableEphemeris(IN[] extraSamples,
                                                                            boolean addOnTheRight,
                                                                            boolean checkStrictlySorted)

Extend the current interpolable ephemeris with new samples while keeping the cache.

Note: The current ephemeris should not be used anymore after being extended since it will share the same cache as the returned extended ephemeris.

Parameters:

extraSamples - The extra sample to extend the ephemeris

addOnTheRight - Indicate if the samples should be added on the right (after) or on the left (before) the existing samples

checkStrictlySorted - Indicate if the extraSample should be checked to be strictly increasingly sorted. Should be deactivated only if it is guaranteed by the user.

Returns:

a new interpolable ephemeris containing the concatenated samples and the cache

Throws:

IllegalArgumentException - if the extra samples dates are not coherent with respect to the addOnTheRight boolean or if the extra samples are not strictly sorted (while checkStrictlySorted is activated)

interpolate

public OUT interpolate(AbsoluteDate date)

Returns an interpolated instance at the required date.

Parameters:

date - The date of the interpolation

Returns:

the interpolated instance

Throws:

IllegalStateException - if the date is outside the supported interval or if the instance has the setting acceptOutOfRange = 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

getFloorIndex

public int getFloorIndex(AbsoluteDate date)

Getter for the floor index for the given date.
If the provided date is before the first sample, -1 is returned.

Parameters:

date - The date to look for

Returns:

the floor index

getCeilingIndex

public int getCeilingIndex(AbsoluteDate date)

Getter for the ceiling index for the given date.
If the provided date is after the last sample, -1 is returned.

Parameters:

date - The date to look for

Returns:

the ceiling index

getFloorSample

public IN getFloorSample(AbsoluteDate date)

Getter for the floor sample for the given date.

Parameters:

date - The date to look for

Returns:

the ceiling index

Throws:

IllegalStateException - if the provided date is before the first sample

getCeilingSample

public IN getCeilingSample(AbsoluteDate date)

Getter for the ceiling sample for the given date.

Parameters:

date - The date to look for

Returns:

the ceiling index

Throws:

IllegalStateException - if the provided date is after the last sample

getFirstSample

public final IN getFirstSample()

Getter for the first sample.

Returns:

the first sample

getLastSample

public final IN getLastSample()

Getter for the last sample.

Returns:

the last sample

getFirstDate

public final AbsoluteDate getFirstDate()

Getter for the first date.

Returns:

the first date

getLastDate

public final AbsoluteDate getLastDate()

Getter for the last date.

Returns:

the last date

getFirstUsableDate

public AbsoluteDate getFirstUsableDate()

Getter for the first usable date.

Returns:

the first usable date

getLastUsableDate

public AbsoluteDate getLastUsableDate()

Getter for the last usable date.

Returns:

the last usable date

getFirstOptimalDate

public final AbsoluteDate getFirstOptimalDate()

Getter for the first optimal date.

Returns:

the first optimal date

getLastOptimalDate

public final AbsoluteDate getLastOptimalDate()

Getter for the last optimal date.

Returns:

the last date

getSampleSize

public int getSampleSize()

Getter for the sample size.

Returns:

the sample size

getSamples

public IN[] getSamples(boolean copy)

Getter for the samples array.

Parameters:

copy - if true return a copy of the samples array, otherwise return the stored array

Returns:

the samples 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

toString

public String toString()

Overrides:

toString in class Object