class GenButterworth

In file GenButterworth.d:

class GenButterworth

Provides a C++ object interface to the routine FlButterworth.

Inheritance:

Public Methods
Private Fields

Inherited from LwsBase:

Public Methods
void SetErrorMessage( string newErrorMessage)
void AppendErrorMessage( string nextErrorMessage )
string GetPreviousErrorMessage()
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

Provides a C++ object interface to the routine FlButterworth. The user must provide the low cut, high cut, low rate, high rate, numer of samples, and the sample rate required.
This object will allocate an array that the user is responsible for. The user must free that array when done.

GenButterworth()

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


Parameters:: none. -
Returns:: none.

~GenButterworth()

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 lowCut=0.5, float highCut=25.0, float lowRollOff=24, float highRollOff=24, float sampleRate=0.01, long numberOfSamples=1024 )

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. The length of the filter is 0 based, i.e. nsamples=1024 implies a filter of 1025 samples, 0 through 1024.


Parameters:: float - lowCut, the lower cutoff frequency of the filter, must be positive, default 0.05.
float - highCut, the higher cutoff frequency of the filter, must be greater than lowCut, default 25.0.
float - lowRollOff, the slope of the low cutoff in decibels per octave, default 24.
float - highRollOff, the slope of the high cutoff in decibels per octave, default 24.
float - sampleRate, default .01 hertz.
float - numberOfSamples, default 1024.
Returns:: float *filter, an array numberOfSamples long, user must free using delete [] filter. Null on failure.

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.

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.

string GetErrorMessage( )

GetErrorMessage will return a string describing what the most recent error was.


Parameters:: none. -
Returns:: string errorMessage, a character string with the error message, which must be free'd by the caller.

string lastError

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


See Also:: IsValid

float lowCut

The low frequency cutoff of the filter, in cycles per second. default 0.05.

float highCut

The highfrequency cutoff of the filter, in cycles per second. Default 25.0.

float lowRollOff

The slope in decibels per octave of the low cut of the filter. Default 24.

float highRollOff

The slope in decibels per octave of the high cut of the filter. Default 24.

float sampleRate

The sample rate in cycles per second. Default 0.01.

long numberOfSamples

The number of samples, default 1024

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

	GenButterworth () Object creator.
	~GenButterworth () Object destructor.
float*	Build ( float lowCut=0.5, float highCut=25.0, float lowRollOff=24, float highRollOff=24, float sampleRate=0.01, long numberOfSamples=1024 ) Build is used to make the filter, and return the array that holds the filter.
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.
long	IsValid () IsValid will verify that the input paramters are valid.
string	GetErrorMessage ( ) GetErrorMessage will return a string describing what the most recent error was.