asptTdlms32f

API Summary

• DT32S tdlms32fInit(asptTdlms32f *tdlms,DT32S L,DT32F mu,DT32S *ip,DT32F *w)
  
• DT32S tdlms32fInitStatic(asptTdlms32f *tdlms,DT32S L,DT32F mu,DT32F *pCof,DT32F *pDat,DT32S *ip,DT32F *w)
  
• void tdlms32fFree(asptTdlms32f *tdlms)
  

• DT32F tdlms32fFilterUpdate(asptTdlms32f *tdlms, DT32F inp, DT32F des)
  
• DT32F tdlms32fFilterOnly(asptTdlms32f *tdlms, DT32F inp)
  
• DT32F tdlms32fLCFilterUpdate(asptTdlms32f *tdlms, DT32F des)
  
• DT32F tdlms32fLCFilterOnly(asptTdlms32f *tdlms)
  

• DT32S tdlms32fGetCoef(asptTdlms32f *tdlms, DT32F *dstBuf, DT32S ind, DT32S N, DT32S flip)
  
• DT32S tdlms32fGetDelayLine(asptTdlms32f *tdlms, DT32F *dstBuf, DT32S ind, DT32S N, DT32S flip)
  
• tdlms32fGetCoefPtr( asptTdlms32f *tdlms )
• tdlms32fGetFilterLength( asptTdlms32f *tdlms )
• tdlms32fGetFftLength( asptTdlms32f *tdlms )
• tdlms32fGetDelayLineLength( asptTdlms32f *tdlms )
• tdlms32fGetStepSize( asptTdlms32f *tdlms )
• tdlms32fGetLastErrorSample( asptTdlms32f *tdlms )

• DT32S tdlms32fReset(asptTdlms32f *tdlms)
  
• DT32S tdlms32fResetDelayLine(asptTdlms32f *tdlms)
  
• DT32S tdlms32fResize(asptTdlms32f *tdlms, DT32S newLen)
  
• DT32S tdlms32fSetCoef(asptTdlms32f *tdlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
  
• DT32S tdlms32fSetDelayLine(asptTdlms32f *tdlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)
  
• tdlms32fSetStepSize( asptTdlms32f *tdlms, newSs )

Description

Copyright

<< Back to top

tdlms32fInit

DT32S tdlms32fInit(asptTdlms32f *tdlms,DT32S L,DT32F mu,DT32S *ip,DT32F *w)

Initializes an asptTdlms32f filter and allocates its necessary storage buffers
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • tdlms : pointer to asptTdlms32f filter to be initialized
  • L : number of time domain filter coefficients
  • mu : step size.
  • ip : fft bit reversal table
  • w : fft twiddle factor table.
• Output Parameters :
  • tdlms is initialized using the given input arguments.
• Error Conditions
  • ASPT_NO_ERR : Initialization is successful
  • ASPT_NULL_PTR_ERR : ip/w is a NULL pointer
  • ASPT_RANGE_ERR : L is not a valid input value
  • ASPT_NO_MEM_ERR : could not allocate memory

<< Back to top

tdlms32fInitStatic

DT32S tdlms32fInitStatic(asptTdlms32f *tdlms,DT32S L,DT32F mu,DT32F *pCof,DT32F *pDat,DT32S *ip,DT32F *w)

Initializes an asptTdlms32f filter to use pre-allocated memory blocks
• Returns :
  • Error code. On failure, the filterLength member of the filter is set to zero.
• Input Parameters :
  • tdlms : pointer to aspttdlms32f filter to be initialized
  • L : number of time domain filter coefficients
  • mu : step size.
  • pCof : pointer to a pre-allocated memory in program memory of at least [fftLength] DT32F locations to be used for the filter coefficients.
  • pDat : pointer to a pre-allocated memory in data memory of at least [3*fftLength + 2] DT32F locations to be used for data storage.
  • ip : fft bit reversal table
  • w : fft twiddle factor table.
• Output Parameters :
  • tdlms is initialized using the given input arguments.
• Error Conditions
  • ASPT_NO_ERR : Initialization is successful
  • ASPT_NULL_PTR_ERR : ip/w is a NULL pointer
  • ASPT_RANGE_ERR : L/M is not a valid input value
  • ASPT_NO_MEM_ERR : could not allocate memory
• Remarks :
  • fftLength = 2^(nextpow2(L-1)).

<< Back to top

tdlms32fFilterUpdate

DT32F tdlms32fFilterUpdate(asptTdlms32f *tdlms, DT32F inp, DT32F des)

Calculates the filter output and updates the filter coefficients for the asptTdlms32f filter.
• Returns :
  • The filter output sample
• Input Parameters :
  • tdlms : asptTdlms32f filter to be processed
  • inp : new input sample
  • des : new desired sample
• Remarks :
  • Error sample is stored internally and can be obtained by calling tdlms32fGetLastErrorSample().

<< Back to top

tdlms32fFilterOnly

DT32F tdlms32fFilterOnly(asptTdlms32f *tdlms, DT32F inp)

Calculates the filter output but does not update the filter coefficients for the asptTdlms32f filter. It also updates the internal buffers and power estimate.
• Returns :
  • Filter output
• Input Parameters :
  • tdlms : asptTdlms32f filter to be processed
  • inp : pointer to the new block of input samples
• Remarks :
  • Error sample not calculated.

<< Back to top

tdlms32fLCFilterUpdate

DT32F tdlms32fLCFilterUpdate(asptTdlms32f *tdlms, DT32F des)

Calculates the filter output and updates the coefficients vector according to the TDLMS algorithm for the Linear Combiner filter configuration. Assumes the delay line has been already updated before calling this function.
• Returns :
  • The filter output sample.
• Input Parameters :
  • tdlms : pointer to the asptTdlms32f filter
  • des : new desired sample
• Remarks :
  • The error sample is stored internally and can be retrieved by calling tdlms32fGetLastErrorSample().

<< Back to top

tdlms32fLCFilterOnly

DT32F tdlms32fLCFilterOnly(asptTdlms32f *tdlms)

Calculates the filter output but does not update the coefficients. It also updates the input power for the Linear Combiner filter configuration. Assumes the delay line has been already updated before calling this function.
• Returns :
  • The filter output sample.
• Input Parameters :
  • tdlms : pointer to the asptTdlms32f filter
• Remarks :
  • error sample is not calculated.

<< Back to top

tdlms32fFree

void tdlms32fFree(asptTdlms32f *tdlms)

Frees the allocated memory for this asptTdlms32f filter.
• Returns :
  • void
• Input Parameters :
  • tdlms : pointer to the asptTdlms32f filter
• Remarks :
  • Use this function only with filters created with tdlms32fInit(). Do not use with asptTdlms32f filters created using tdlms32fInitStatic().

<< Back to top

tdlms32fReset

DT32S tdlms32fReset(asptTdlms32f *tdlms)

Resets all filter coefficients to zero.
• Returns :
  • Error condition
• Input Parameters :
  • tdlms : pointer to an asptTdlms32f filter to be reset.
• Error Conditions
  • ASPT_NO_ERR : success
  • ASPT_NULL_PTR_ERR : NULL pointer error

<< Back to top

tdlms32fResetDelayLine

DT32S tdlms32fResetDelayLine(asptTdlms32f *tdlms)

Resets the internal delay line to zeros.
• Returns :
  • Error condition
• Input Parameters :
  • tdlms : pointer to an asptTdlms32f filter to be reset.
• Error Conditions
  • ASPT_NO_ERR : success
  • ASPT_NULL_PTR_ERR : NULL pointer error

<< Back to top

tdlms32fGetCoef

DT32S tdlms32fGetCoef(asptTdlms32f *tdlms, DT32F *dstBuf, DT32S ind, DT32S N, DT32S flip)

Copies N internal filter coefficients starting from coef[ind] to dstBuf.
• Returns :
  • On success returns the number of coefficients copied, otherwise the error code (negative int).
• Input Parameters :
  • tdlms : pointer to an asptTdlms32f filter.
  • dstBuf : destination buffer.
  • ind : index to the first coefficient to be copied.
  • N : number of coefficients to be copied.
  • flip : if not 0, will flip the coefficients order.
• Error Conditions
  • ASPT_NULL_PTR_ERR : dstBuf/tdlms->wFreq is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

tdlms32fSetCoef

DT32S tdlms32fSetCoef(asptTdlms32f *tdlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)

Initializes N internal (time domain) filter coefficients starting from coef[ind] to the contents of newCoef.
• Returns :
  • On success returns the number of coefficients copied, otherwise the error code (negative int).
• Input Parameters :
  • tdlms : pointer to an asptTdlms32f filter to be set.
  • newCoef : new coefficients vector.
  • ind : index to the first coefficient to be set.
  • N : number of coefficients to be set.
  • flip : if not 0, will copy the coefficients in reverse order.
• Error Conditions
  • ASPT_NULL_PTR_ERR : newCoef/tdlms->wFreq is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value

<< Back to top

tdlms32fGetDelayLine

DT32S tdlms32fGetDelayLine(asptTdlms32f *tdlms, DT32F *dstBuf, DT32S ind, DT32S N, DT32S flip)

Copies N internal delay line samples starting from delayLine[ind] to dstBuf.
• Returns :
  • On success returns the number of samples copied, otherwise the error code (negative int).
• Input Parameters :
  • tdlms : pointer to the asptTdlms32f filter.
  • dstBuf : destination buffer.
  • ind : index to the first sample to be copied.
  • N : number of samples to be copied.
  • flip : if not 0, will flip the samples order.
• Output Parameters :
  • dstBuf is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : dstBuf/tdlms->xTime is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value
• Remarks :
  • Samples are stored in dstBuf with newest sample at index 0, and oldest at index N-1, when flip == 0.

<< Back to top

tdlms32fSetDelayLine

DT32S tdlms32fSetDelayLine(asptTdlms32f *tdlms, DT32F *newCoef, DT32S ind, DT32S N, DT32S flip)

Initializes N internal delay line samples starting from delayLine[ind] to the contents of the given array.
• Returns :
  • On success returns the number of samples initialized, otherwise the error code (negative int).
• Input Parameters :
  • tdlms : pointer to an asptTdlms32f filter.
  • newBuf : new data buffer.
  • ind : index to the first sample to be copied.
  • N : number of samples to be copied.
  • flip : if not 0, will flip the samples order.
• Output Parameters :
  • tdlms->xTime is updated
• Error Conditions
  • ASPT_NULL_PTR_ERR : newBuf/tdlms->xTime is a NULL pointer
  • ASPT_RANGE_ERR : ind/N is not a valid input value
• Remarks :
  • Samples assumed to be stored in newBuf with newest sample at index 0, and oldest at index N-1, when flip == 0.

<< Back to top

tdlms32fResize

DT32S tdlms32fResize(asptTdlms32f *tdlms, DT32S newLen)

Resizes an asptTdlms32f filter keeping as much of the filter state as possible.
• Returns :
  • error code.
• Input Parameters :
  • tdlms : pointer to the asptTdlms32f filter to be resized.
  • newLen : required new filter length
• Error Conditions
  • ASPT_NO_ERR : Resizing is successful
  • ASPT_NULL_PTR_ERR : NULL pointer error
  • ASPT_RANGE_ERR : newLength is not a valid input value
  • ASPT_NO_MEM_ERR : Could not allocate the necessary filter storage
• Remarks :
  • Use this function only with dynamically allocated asptTdlms32f filters.