Given the filter paramters, we convert the input into the output by applying the given filter, using convolution

Inheritance:

Public Methods

	LwsConv () Object creator.
	~LwsConv () Object destructor.
float*	Build ( float* filter, long numberOfFilterSamples, float* inputData, long numberOfInputDataSamples, long* outputNumberOfSamples ) Build is used to make the filter, and return the array that holds the filter.
long	IsValid () IsValid will verify that the input paramters are valid.

Private Fields

GenButterworth	myBw The object used to generate the butterworth filter
string	lastError The string associated with the last error encountered in this class.
long	numberOfInputSamples The number of input data samples
float*	inputData The input data before filtering
float*	outputData The output data after filtering
float*	myFilter The filter data buffer
long	numberOfFilterSamples The number of samples in the filter
long*	numberOfOutputSamples The number of samples in the output

Private Methods

void	Clean () Clean will free up malloc'ed memory, except for the filter array malloc'ed by Build.
void	Setup () Setup will set up the object, making sure we have enough memory.

Inherited from LwsBase:

Public Methods

void SetErrorMessage( string newErrorMessage)

void AppendErrorMessage( string nextErrorMessage )

string GetPreviousErrorMessage()

string GetErrorMessage( )

void StdOut( float* output, long numberOfSamples )

void StdFileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )

void FileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )

float* GetFileInput( string inputFileName, long* numberOfSamples )

string GetTempName( string seed = "ktmp")

Private Fields

string previousError

string currentError

Documentation

Given the filter paramters, we convert the input into the output by applying the given filter, using convolution

LwsConv()

Object creator. You can provide the filter parameters here, or settle for the defaults.

Parameters:

none. -

Returns:

none.

~LwsConv()

Object destructor. Frees up the objects memory. Does not free up the array returned by build. The latter is the user's responsibility.

Parameters:

none. -

Returns:

none.

float* Build( float* filter, long numberOfFilterSamples, float* inputData, long numberOfInputDataSamples, long* outputNumberOfSamples )

Build is used to make the filter, and return the array that holds the filter. The user may provide paramters, or use the defaults provided below.

Parameters:

filter - is the array conataining the filter we will use.
- numberOfFilterSamples is the number of elements in the filter.
- inputData is the input data array
numberOfInputDataSamples - is the number of samples in the inputData array.
outputNumberOfSamples - , the number of samples in the filtered array.

Returns:

output the filtered output data, called outputData.

See Also:

GenButterworth for an example filter.

long IsValid()

IsValid will verify that the input paramters are valid. You can use the routine GetErrorMsg to find out what the problem is if the return is not 0. (O means valid, non-zero means invalid.)

Parameters:

none. -

Returns:

0 if valid, 1 or more if not valid.

void Clean()

Clean will free up malloc'ed memory, except for the filter array malloc'ed by Build.

Parameters:

none. -

Returns:

none.

void Setup()

Setup will set up the object, making sure we have enough memory.

Parameters:

none. -

Returns:

none.

GenButterworth myBw

The object used to generate the butterworth filter

string lastError

The string associated with the last error encountered in this class. Usually set by IsValid.

See Also:

IsValid

long numberOfInputSamples

The number of input data samples

float* inputData

The input data before filtering

float* outputData

The output data after filtering

float* myFilter

The filter data buffer

long numberOfFilterSamples

The number of samples in the filter

long* numberOfOutputSamples

The number of samples in the output

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

Copyright 1993, 1994 Geophysical Software, Inc.

2603 Peninsulas Drive, Missouri City Texas 77459, (713)438-0583.

All Rights Reserved Company Confidential

Prepared for University of Minnesota, October, 2001