org.tensorics.core.tensor.resample.impl

Class LinearInterpolationResampler<C,V>

java.lang.Object

org.tensorics.core.tensor.resample.impl.LinearInterpolationResampler<C,V>

Type Parameters:

C - the type of the coordinates of the concerned dimension

V - the type of the tensor values to resample

All Implemented Interfaces:

SingleDimensionResampler<C,V>

public class LinearInterpolationResampler<C,V>
extends java.lang.Object
implements SingleDimensionResampler<C,V>

Resamples in one dimension, by linearly interpolating by two neighboring values. If possible it will try to interpolate between the left and right neighbor. If The requested point is before the first support coordinate or after the last one, then the interpolation will be done from the first two points or the last two points, respectively.

Constructor Summary

Constructors

Constructor and Description
LinearInterpolationResampler(ExtendedField<V> field, java.util.function.Function<C,V> toFieldElementConversion)

Method Summary

Modifier and Type	Method and Description
boolean	canResample(java.util.Set<C> coordinates, C coordinate) Has to return true if the resampling will be possible, provided the the given parameters.
V	resample(java.util.Set<C> coordinates, java.util.function.Function<C,V> yFunction, C coordinate) Performs the actual resampling using the provided input.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinearInterpolationResampler

public LinearInterpolationResampler(ExtendedField<V> field,
                                    java.util.function.Function<C,V> toFieldElementConversion)

Method Detail

resample

public V resample(java.util.Set<C> coordinates,
                  java.util.function.Function<C,V> yFunction,
                  C coordinate)

Description copied from interface: SingleDimensionResampler

Performs the actual resampling using the provided input.

Specified by:

resample in interface SingleDimensionResampler<C,V>

Parameters:

coordinates - the supporting points, which can be used as input to resample

yFunction - a function providing values of type V for all given coordinates

coordinate - the coordinate at which the resampling shall be performed

Returns:

true if the resampling will be possible with the provided input, false if not.

canResample

public boolean canResample(java.util.Set<C> coordinates,
                           C coordinate)

Description copied from interface: SingleDimensionResampler

Has to return true if the resampling will be possible, provided the the given parameters.

Specified by:

canResample in interface SingleDimensionResampler<C,V>

Parameters:

coordinates - the supporting points, which can be used as input to resample

coordinate - the coordinate at which the resampling shall be performed

Returns:

true if the resampling will be possible with the provided input, false if not.