diff scripts/control/system/fir2sys.m @ 5016:bdbee5282954

[project @ 2004-09-22 02:50:35 by jwe]
author jwe
date Wed, 22 Sep 2004 02:50:36 +0000
parents b8105302cfe8
children 4c8a2e4e0717
line wrap: on
line diff
--- a/scripts/control/system/fir2sys.m	Wed Sep 22 02:18:13 2004 +0000
+++ b/scripts/control/system/fir2sys.m	Wed Sep 22 02:50:36 2004 +0000
@@ -18,21 +18,27 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Function File} {} fir2sys (@var{num}, @var{tsam}, @var{inname}, @var{outname})
-## construct a system data structure from FIR description
+## construct a system data structure from @acronym{FIR} description
 ##
-## @strong{Inputs:}
+## @strong{Inputs}
 ## @table @var
 ## @item num
-## vector of coefficients @math{[c_0 c_1 ... c_n]}
-## of the SISO FIR transfer function
+## vector of coefficients 
 ## @ifinfo
-##
-## C(z) = c0 + c1*z^@{-1@} + c2*z^@{-2@} + ... + znz^@{-n@}
-##
+## [c0, c1, ..., cn]
 ## @end ifinfo
 ## @iftex
 ## @tex
-## $$C(z) = c0 + c1*z^{-1} + c2*z^{-2} + ... + znz^{-n}$$
+## $ [c_0, c_1, \ldots, c_n ]$
+## @end tex
+## @end iftex
+## of the @acronym{SISO} @acronym{FIR} transfer function
+## @ifinfo
+## C(z) = c0 + c1*z^(-1) + c2*z^(-2) + ... + cn*z^(-n)
+## @end ifinfo
+## @iftex
+## @tex
+## $$ C(z) = c_0 + c_1z^{-1} + c_2z^{-2} + \ldots + c_nz^{-n} $$
 ## @end tex
 ## @end iftex
 ##
@@ -46,12 +52,16 @@
 ## name of output signal; may be a string or a list with a single entry.
 ## @end table
 ##
-## @strong{Outputs}
-## @var{sys} (system data structure)
+## @strong{Output}
+## @table @var
+## @item sys
+## system data structure
+## @end table
 ##
 ## @strong{Example}
 ## @example
-## octave:1> sys = fir2sys([1 -1 2 4],0.342,"A/D input","filter output");
+## octave:1> sys = fir2sys([1 -1 2 4],0.342,\
+## > "A/D input","filter output");
 ## octave:2> sysout(sys)
 ## Input(s)
 ##         1: A/D input