Method miir/miir
MIIR IIR filter object class constructor.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: MIIR IIR filter object class constructor.
Create a miir object.
CONSTRUCTORS:
f = miir() - creates an empty miir object.
f = miir(fi) - creates a copy of the input miir object, fi.
f = miir(pzm) - creates a miir object from a pole/zero model
f = miir(pf) - creates a vector of miir objects from a parfrac model
f = miir(a,b,fs) - creates a miir object from the coefficient
vectors 'a' and 'b' **.
The sample rate for which the filter is
designed should be specified as well.
f = miir('foo_iir.fil') - create a miir object from a
LISO IIR .fil file.
f = miir('foo_iir.xml') - create a miir object loading the miir object
from disk.
f = miir('foo_iir.mat') - create a miir object loading the miir object
from disk.
f = miir(pl) - create a miir object from the description
given in the parameter list.
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', 1, ...
'gain', 2.0, ...
'fs', 10, ...
'fc', 0.2);
>> f = miir(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
b(1)*y(n) = a(1)*x(n) + a(2)*x(n-1) + ... + a(na+1)*x(n-na)
- b(2)*y(n-1) - ... - b(nb+1)*y(n-nb)
Parameters Description
SEE ALSO: mfir, ltpda_filter, ltpda_uoh, ltpda_uo, ltpda_obj, plist
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
| Method Details |
|
| Access |
public |
| Defining Class |
miir |
| 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
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
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
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 |
|
Use binary representation (not always available). |
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
From LISO 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 |
LISO filename. |
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 |
none |
The roll-off frequency [Hz]. |
| GAIN |
1 |
none |
The gain of the filter. |
| FS |
1 |
none |
The sampling frequency to design for. |
| ORDER |
1 |
none |
The filter order. |
| RIPPLE |
0.5 |
none |
Pass/stop-band ripple (%) for bandpass and bandreject filters. |
| IUNITS |
'' |
none |
The input units of the filter. |
| OUNITS |
'' |
none |
The output units of the filter. |
back to top
Allpass |
| no description |
| Key |
Default Value |
Options |
Description |
| NAME |
'' |
none |
The name of the constructed object. |
| DESCRIPTION |
'' |
none |
The description of the constructed object. |
| DELAY |
[] |
none |
The allpass delay. |
| N |
1 |
none |
The filter order. |
| METHOD |
'thirlen' |
none |
The method for generating the filter. |
| IUNITS |
'' |
none |
The input units of the filter. |
| OUNITS |
'' |
none |
The output units of the filter. |
back to top
From Parfrac |
| no description |
| Key |
Default Value |
Options |
Description |
| NAME |
'' |
none |
The name of the constructed object. |
| DESCRIPTION |
'' |
none |
The description of the constructed object. |
| PARFRAC |
parfrac() |
none |
Parfrac object 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
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 |
Pole/zero model object 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
From AB |
| 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 |
Set of numerator coefficients. |
| B |
[] |
none |
Set of denominator coefficients. |
| FS |
[] |
none |
The sampling frequency to design for. |
| IUNITS |
'' |
none |
The input units of the filter. |
| OUNITS |
'' |
none |
The output units of the filter. |
back to top
| Some information of the method miir/miir are listed below: |
| Class name |
miir |
| Method name |
miir |
| Category |
Constructor |
| CVS Version |
1af0b21675e8089cbd0dd1d95314adeb4a9a0023 |
| Min input args |
0 |
| Max input args |
-1 |
| Min output args |
1 |
| Max output args |
1 |
|
Method: mfir/retrieve |
|
Method: miir/rebuild |
 |
©LTP Team