|
3430
|
1 ## Copyright (C) 1996, 1998 Auburn University. All rights reserved. |
|
|
2 ## |
|
|
3 ## This file is part of Octave. |
|
|
4 ## |
|
|
5 ## Octave is free software; you can redistribute it and/or modify it |
|
|
6 ## under the terms of the GNU General Public License as published by the |
|
|
7 ## Free Software Foundation; either version 2, or (at your option) any |
|
|
8 ## later version. |
|
|
9 ## |
|
|
10 ## Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
11 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
12 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
13 ## for more details. |
|
|
14 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
|
16 ## along with Octave; see the file COPYING. If not, write to the Free |
|
|
17 ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. |
|
|
18 |
|
|
19 ## -*- texinfo -*- |
|
3500
|
20 ## @deftypefn {Function File} {} fir2sys (@var{num}, @var{tsam}, @var{inname}, @var{outname}) |
|
5016
|
21 ## construct a system data structure from @acronym{FIR} description |
|
3430
|
22 ## |
|
5016
|
23 ## @strong{Inputs} |
|
3430
|
24 ## @table @var |
|
|
25 ## @item num |
|
5016
|
26 ## vector of coefficients |
|
3430
|
27 ## @ifinfo |
|
5016
|
28 ## [c0, c1, ..., cn] |
|
3430
|
29 ## @end ifinfo |
|
|
30 ## @iftex |
|
|
31 ## @tex |
|
5016
|
32 ## $ [c_0, c_1, \ldots, c_n ]$ |
|
|
33 ## @end tex |
|
|
34 ## @end iftex |
|
|
35 ## of the @acronym{SISO} @acronym{FIR} transfer function |
|
|
36 ## @ifinfo |
|
|
37 ## C(z) = c0 + c1*z^(-1) + c2*z^(-2) + ... + cn*z^(-n) |
|
|
38 ## @end ifinfo |
|
|
39 ## @iftex |
|
|
40 ## @tex |
|
|
41 ## $$ C(z) = c_0 + c_1z^{-1} + c_2z^{-2} + \ldots + c_nz^{-n} $$ |
|
3430
|
42 ## @end tex |
|
|
43 ## @end iftex |
|
|
44 ## |
|
|
45 ## @item tsam |
|
|
46 ## sampling time (default: 1) |
|
|
47 ## |
|
|
48 ## @item inname |
|
|
49 ## name of input signal; may be a string or a list with a single entry. |
|
|
50 ## |
|
|
51 ## @item outname |
|
|
52 ## name of output signal; may be a string or a list with a single entry. |
|
|
53 ## @end table |
|
|
54 ## |
|
5016
|
55 ## @strong{Output} |
|
|
56 ## @table @var |
|
|
57 ## @item sys |
|
|
58 ## system data structure |
|
|
59 ## @end table |
|
3430
|
60 ## |
|
|
61 ## @strong{Example} |
|
|
62 ## @example |
|
5016
|
63 ## octave:1> sys = fir2sys([1 -1 2 4],0.342,\ |
|
|
64 ## > "A/D input","filter output"); |
|
3430
|
65 ## octave:2> sysout(sys) |
|
|
66 ## Input(s) |
|
|
67 ## 1: A/D input |
|
|
68 ## |
|
|
69 ## Output(s): |
|
|
70 ## 1: filter output (discrete) |
|
|
71 ## |
|
|
72 ## Sampling interval: 0.342 |
|
|
73 ## transfer function form: |
|
|
74 ## 1*z^3 - 1*z^2 + 2*z^1 + 4 |
|
|
75 ## ------------------------- |
|
|
76 ## 1*z^3 + 0*z^2 + 0*z^1 + 0 |
|
|
77 ## @end example |
|
|
78 ## @end deftypefn |
|
|
79 |
|
|
80 ## Author: R. Bruce Tenison <btenison@eng.auburn.edu> |
|
|
81 ## Created: July 29, 1994 |
|
|
82 ## Name changed to TF2SYS July 1995 |
|
|
83 ## updated for new system data structure format July 1996 |
|
|
84 ## adapted from tf2sys july 1996 |
|
|
85 |
|
|
86 function sys = fir2sys (num, tsam, inname, outname) |
|
|
87 |
|
|
88 ## Test for the correct number of input arguments |
|
|
89 if (nargin < 1 | nargin > 4) |
|
|
90 usage ("sys = fir2sys(num [, tsam, inname, outname])"); |
|
|
91 endif |
|
|
92 |
|
4771
|
93 ## let tf do the argument checking |
|
3430
|
94 den = [1,zeros(1,length(num)-1)]; |
|
|
95 |
|
|
96 ## check sampling interval (if any) |
|
|
97 if (nargin <= 1) |
|
|
98 tsam = 1; # default |
|
|
99 elseif (isempty(tsam)) |
|
|
100 tsam = 1; |
|
|
101 endif |
|
|
102 |
|
|
103 ## Set name of input |
|
|
104 if (nargin < 3) |
|
3438
|
105 inname = __sysdefioname__ (1, "u"); |
|
3430
|
106 endif |
|
|
107 |
|
|
108 ## Set name of output |
|
|
109 if (nargin < 4) |
|
3438
|
110 outname = __sysdefioname__ (1, "y"); |
|
3430
|
111 endif |
|
|
112 |
|
4771
|
113 sys = tf (num, den, tsam, inname, outname); |
|
3430
|
114 |
|
|
115 endfunction |
