marf.Preprocessing
Interface IFilter

All Known Implementing Classes:

BandpassFilter, BandPassFilter, BandStopFilter, BandStopFilter, CFEFilter, FFTFilter, Filter, HighFrequencyBoost, HighPassFilter, HighPassFilter, LowPassFilter, LowPassFilter

public interface IFilter

An interface all filters must comply with.

$Id: IFilter.java,v 1.5 2006/03/20 00:34:10 mokhov Exp $

Since:

0.3.0.4

Author:

Serguei Mokhov

Field Summary

static int	FILTER_DIMENSIONALITY_1D Indicates 1-D filter.
static int	FILTER_DIMENSIONALITY_2D Indicates 2-D filter.
static int	FILTER_DIMENSIONALITY_3D Indicates 3-D filter.
static java.lang.String	MARF_INTERFACE_CODE_REVISION Interface source code revision.

Method Summary

boolean	filter(double[][][] padSample, double[][][] padFiltered) Applies 3D filtering to the sample array and buffers the filtered data.
boolean	filter(double[][] padSample, double[][] padFiltered) Applies 2D filtering to the sample array and buffers the filtered data.
boolean	filter(double[] padSample, double[] padFiltered) Applies filtering to the sample array and buffers the filtered data.

Field Detail

FILTER_DIMENSIONALITY_1D

static final int FILTER_DIMENSIONALITY_1D

Indicates 1-D filter.

Since:

0.3.0.6

See Also:

Constant Field Values

FILTER_DIMENSIONALITY_2D

static final int FILTER_DIMENSIONALITY_2D

Indicates 2-D filter.

Since:

0.3.0.6

See Also:

Constant Field Values

FILTER_DIMENSIONALITY_3D

static final int FILTER_DIMENSIONALITY_3D

Indicates 3-D filter.

Since:

0.3.0.6

See Also:

Constant Field Values

MARF_INTERFACE_CODE_REVISION

static final java.lang.String MARF_INTERFACE_CODE_REVISION

Interface source code revision.

See Also:

Constant Field Values

Method Detail

filter

boolean filter(double[] padSample,
               double[] padFiltered)
               throws PreprocessingException

Applies filtering to the sample array and buffers the filtered data.

Parameters:

padSample - original sample to apply filtering to; should not be altered

padFiltered - buffer for filtered data

Returns:

true if filtering was successful and/or there were any changes

Throws:

PreprocessingException - if any error happened during filtering

filter

boolean filter(double[][] padSample,
               double[][] padFiltered)
               throws PreprocessingException

Applies 2D filtering to the sample array and buffers the filtered data.

Parameters:

padSample - original sample to apply filtering to; should not be altered

padFiltered - buffer for filtered data

Returns:

true if filtering was successful and/or there were any changes

Throws:

PreprocessingException - if any error happened during filtering

Since:

0.3.0.6

filter

boolean filter(double[][][] padSample,
               double[][][] padFiltered)
               throws PreprocessingException

Applies 3D filtering to the sample array and buffers the filtered data.

Parameters:

padSample - original sample to apply filtering to; should not be altered

padFiltered - buffer for filtered data

Returns:

true if filtering was successful and/or there were any changes

Throws:

PreprocessingException - if any error happened during filtering

Since:

0.3.0.6