In file LwsConv.d:

class LwsConv

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

Inheritance:


Public Methods

[more] LwsConv ()
Object creator.
[more] ~LwsConv ()
Object destructor.
[more]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.
[more]long IsValid ()
IsValid will verify that the input paramters are valid.

Private Fields

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

Private Methods

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


Inherited from LwsBase:

Public Methods

ovoid SetErrorMessage( string newErrorMessage)
ovoid AppendErrorMessage( string nextErrorMessage )
ostring GetPreviousErrorMessage()
ostring GetErrorMessage( )
ovoid StdOut( float* output, long numberOfSamples )
ovoid StdFileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )
ovoid FileOut( float* output, long numberOfSamples, string outputFileName="lastDataOutput" )
ofloat* GetFileInput( string inputFileName, long* numberOfSamples )
ostring GetTempName( string seed = "ktmp")

Private Fields

ostring previousError
ostring currentError


Documentation

Given the filter paramters, we convert the input into the output by applying the given filter, using convolution
o LwsConv()
Object creator. You can provide the filter parameters here, or settle for the defaults.
Parameters:
none. -
Returns:
none.

o ~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.

ofloat* 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.

olong 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.

ovoid Clean()
Clean will free up malloc'ed memory, except for the filter array malloc'ed by Build.
Parameters:
none. -
Returns:
none.

ovoid Setup()
Setup will set up the object, making sure we have enough memory.
Parameters:
none. -
Returns:
none.

oGenButterworth myBw
The object used to generate the butterworth filter

ostring lastError
The string associated with the last error encountered in this class. Usually set by IsValid.
See Also:
IsValid

olong numberOfInputSamples
The number of input data samples

ofloat* inputData
The input data before filtering

ofloat* outputData
The output data after filtering

ofloat* myFilter
The filter data buffer

olong numberOfFilterSamples
The number of samples in the filter

olong* 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