fr.cnes.sirius.patrius.math.filter

Class FIRFilter

java.lang.Object

fr.cnes.sirius.patrius.math.filter.FIRFilter

public final class FIRFilter
extends Object

This class implements a digital FIR filter.

Author:

GMV

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FIRFilter.DataType Enum for data types
static class	FIRFilter.FilterType Enum for filter types

Constructor Summary

Constructors

Constructor and Description
FIRFilter(FIRFilter.FilterType filterType, FIRFilter.DataType[] dataTypeArray, List<Double> coeffs, double samplingStep) Constructor.

Method Summary

Modifier and Type	Method and Description
double[]	compute(UnivariateVectorFunction f, double x0) Computes the filtered value of the given function at the given computation point.
int	getNbPointsAfter() Getter for the number of points after the computation date to be used by the filter.
int	getNbPointsBefore() Getter for the number of points before the computation date to be used by the filter.
double	getSamplingStep() Getter for sampling step of the filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

FIRFilter

public FIRFilter(FIRFilter.FilterType filterType,
                 FIRFilter.DataType[] dataTypeArray,
                 List<Double> coeffs,
                 double samplingStep)
          throws PatriusException

Constructor.

Parameters:

filterType - FIR filter type

dataTypeArray - data type to be filtered

coeffs - coefficients of the filter (in case of LINEAR filter, coefficients are symmetric so only the half of the coefficients plus one must be defined)

samplingStep - filter sampling step

Throws:

PatriusException - if the specified type of FIR filter is not currently implemented

Method Detail

getNbPointsBefore

public int getNbPointsBefore()

Getter for the number of points before the computation date to be used by the filter.

Returns:

the number of points before the computation date to be used by the filter

getNbPointsAfter

public int getNbPointsAfter()

Getter for the number of points after the computation date to be used by the filter.

Returns:

the number of points after the computation date to be used by the filter

getSamplingStep

public double getSamplingStep()

Getter for sampling step of the filter.

Returns:

the sampling step of the filter

compute

public double[] compute(UnivariateVectorFunction f,
                        double x0)

Computes the filtered value of the given function at the given computation point. Angular values are normalized to [-PI, PI) before being returned.

Parameters:

f - vectorial function to filter

x0 - computation point

Returns:

the filtered value of the function at given computation point