Method mfir/mfir


  MFIR FIR filter object class constructor.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: MFIR FIR filter object class constructor.
               Create a mfir object.
 
  CONSTRUCTORS:
 
        f = mfir()         - creates an empty mfir object.
        f = mfir(fi)       - creates a copy of the input mfir object, fi.
        f = mfir(a)        - creates a mfir object based on the magnitude of
                             the input AO/fsdata object a.
        f = mfir(pzm)      - creates a mfir object from a pole/zero model
        f = mfir(c,fs)     - creates an mfir object based on the vector of input
                             coefficients c.
                             The sample rate for which the filter is designed
                             should be specified as well.
        f = mfir(filename) - creates an mfir object loading the  mfir object from disk
        f = mfir(pl)       - creates an mfir object from the description given
                             in the parameter list.
 
 
  Parameter sets examples for plist constructor:
 
  EXAMPLE 1:   Create an order 1 highpass filter with high frequency gain 2.
               Filter is designed for 10 Hz sampled data and has a cut-off
               frequency of 0.2 Hz.
 
               >> pl = plist('type', 'highpass', ...
                             'order', 128,       ...
                             'gain',  2.0,       ...
                             'fs',    10,        ...
                             'fc',    0.2);
               >> f = mfir(pl)
 
  NOTES:
            ** The convention used here for naming the filter coefficients is
               the opposite to MATLAB's convention. The recursion formula
               for this convention is
 
               y(n) = a(1)*x(n) + a(2)*x(n-1) + ... + a(na+1)*x(n-na)
 
  Parameters Description
 
  SEE ALSO:    miir, ltpda_filter, ltpda_uoh, ltpda_uo, ltpda_obj, plist
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class mfir
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
back to top back to top

From MAT File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
FILENAME '' none MAT filename.
back to top back to top

From XML File

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
FILENAME '' none XML filename.
back to top back to top

From Repository

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
HOSTNAME '' none Database server hostname.
DATABASE '' none Database name.
USERNAME '' none User name to use when connecting to the database. Leave blank to be prompted.
PASSWORD {} [0x0] none Password to use when connecting to the database. Leave blank to be prompted.
CONN [] none Java mysql object.
ID, IDS [] none A vector of object IDs.
CID [] none A vector of collection IDs.
BINARY 1
  • 1
  • 0
Use binary representation (not always available).
back to top back to top

From Built-in Model

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
BUILT-IN '' none Choose one of the built-in models. (use class.getBuiltInModels to get a list for a particular user class)
back to top back to top

From Standard Type

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
TYPE 'lowpass'
  • 'highpass'
  • 'lowpass'
  • 'bandpass'
  • 'bandreject'
Choose the filter type.
FC [0.10000000000000001 0.40000000000000002] none The roll-off frequency [Hz].
GAIN 1 none The gain of the filter.
WIN 'BH92'
  • 'Rectangular'
  • 'Welch'
  • 'Bartlett'
  • 'Hanning'
  • 'Hamming'
  • 'Nuttall3'
  • 'Nuttall4'
  • 'Nuttall3a'
  • 'Nuttall3b'
  • 'Nuttall4a'
  • 'Nuttall4b'
  • 'Nuttall4c'
  • 'BH92'
  • 'SFT3F'
  • 'SFT3M'
  • 'FTNI'
  • 'SFT4F'
  • 'SFT5F'
  • 'SFT4M'
  • 'FTHP'
  • 'HFT70'
  • 'FTSRS'
  • 'SFT5M'
  • 'HFT90D'
  • 'HFT95'
  • 'HFT116D'
  • 'HFT144D'
  • 'HFT169D'
  • 'HFT196D'
  • 'HFT223D'
  • 'HFT248D'
  • 'Kaiser'
  • 'levelledHanning'
The window function used in the design of the filter.
FS 1 none The sampling frequency to design for.
ORDER 128 none The filter order.
IUNITS '' none The input units of the filter.
OUNITS '' none The output units of the filter.
back to top back to top

From Pzmodel

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
PZMODEL pzmodel(g:no gain p:no pole z:no zero) none A pole/zero model to design from.
FS [] none The sampling frequency to design for.
IUNITS '' none The input units of the transfer function.
OUNITS '' none The output units of the transfer function.
back to top back to top

From A

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
A [] none Vector of A coefficients.
FS [] none Sampling frequency of the filter.
IUNITS '' none The input units of the transfer function.
OUNITS '' none The output units of the transfer function.
back to top back to top

From AO

no description
Key Default Value Options Description
NAME '' none The name of the constructed object.
DESCRIPTION '' none The description of the constructed object.
AO /No data-object none The AO object to design from.
N 512 none The filter order.
METHOD 'frequency-sampling'
  • 'frequency-sampling'
  • 'least-squares'
  • 'Parks-McClellan'
The filter design method:
WIN 'BH92'
  • 'Rectangular'
  • 'Welch'
  • 'Bartlett'
  • 'Hanning'
  • 'Hamming'
  • 'Nuttall3'
  • 'Nuttall4'
  • 'Nuttall3a'
  • 'Nuttall3b'
  • 'Nuttall4a'
  • 'Nuttall4b'
  • 'Nuttall4c'
  • 'BH92'
  • 'SFT3F'
  • 'SFT3M'
  • 'FTNI'
  • 'SFT4F'
  • 'SFT5F'
  • 'SFT4M'
  • 'FTHP'
  • 'HFT70'
  • 'FTSRS'
  • 'SFT5M'
  • 'HFT90D'
  • 'HFT95'
  • 'HFT116D'
  • 'HFT144D'
  • 'HFT169D'
  • 'HFT196D'
  • 'HFT223D'
  • 'HFT248D'
  • 'Kaiser'
  • 'levelledHanning'
A window to design with when using the frequency-sampling method.
PSLL 100 none If you specify a Kaiser window, you can also specify the PSLL.
IUNITS '' none The input units of the transfer function.
OUNITS '' none The output units of the transfer function.
back to top back to top

Some information of the method mfir/mfir are listed below:
Class name mfir
Method name mfir
Category Constructor
Package name ltpda
VCS Version 3542afe99dea25c636b7ac3b82a9f6f8be9d447d
Min input args 0
Max input args -1
Min output args 1
Max output args 1




©LTP Team