← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/fr/signal/group.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/fr/signal/group.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>group</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>April 1993</DATE>
 
8
  <SHORT_DESCRIPTION name="group"> group delay for digital filter</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>[tg,fr]=group(npts,a1i,a2i,b1i,b2i)  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <PARAM>
 
13
    <PARAM_INDENT>
 
14
      <PARAM_ITEM>
 
15
        <PARAM_NAME>npts</PARAM_NAME>
 
16
        <PARAM_DESCRIPTION>
 
17
          <SP>: integer : number of points desired in calculation of group delay</SP>
 
18
        </PARAM_DESCRIPTION>
 
19
      </PARAM_ITEM>
 
20
      <PARAM_ITEM>
 
21
        <PARAM_NAME>a1i</PARAM_NAME>
 
22
        <PARAM_DESCRIPTION>
 
23
          <SP>: in coefficient, polynomial, rational polynomial, or cascade polynomial form this variable is the transfer function of the filter. In coefficient polynomial form this is a vector of coefficients (see below).</SP>
 
24
        </PARAM_DESCRIPTION>
 
25
      </PARAM_ITEM>
 
26
      <PARAM_ITEM>
 
27
        <PARAM_NAME>a2i</PARAM_NAME>
 
28
        <PARAM_DESCRIPTION>
 
29
          <SP>: in coeff poly form this is a vector of coeffs</SP>
 
30
        </PARAM_DESCRIPTION>
 
31
      </PARAM_ITEM>
 
32
      <PARAM_ITEM>
 
33
        <PARAM_NAME>b1i</PARAM_NAME>
 
34
        <PARAM_DESCRIPTION>
 
35
          <SP>: in coeff poly form this is a vector of coeffs</SP>
 
36
        </PARAM_DESCRIPTION>
 
37
      </PARAM_ITEM>
 
38
      <PARAM_ITEM>
 
39
        <PARAM_NAME>b2i</PARAM_NAME>
 
40
        <PARAM_DESCRIPTION>
 
41
          <SP>: in coeff poly form this is a vector of coeffs</SP>
 
42
        </PARAM_DESCRIPTION>
 
43
      </PARAM_ITEM>
 
44
      <PARAM_ITEM>
 
45
        <PARAM_NAME>tg</PARAM_NAME>
 
46
        <PARAM_DESCRIPTION>
 
47
          <SP>: values of group delay evaluated on the grid fr</SP>
 
48
        </PARAM_DESCRIPTION>
 
49
      </PARAM_ITEM>
 
50
      <PARAM_ITEM>
 
51
        <PARAM_NAME>fr</PARAM_NAME>
 
52
        <PARAM_DESCRIPTION>
 
53
          <SP>: grid of frequency values where group delay is evaluated</SP>
 
54
        </PARAM_DESCRIPTION>
 
55
      </PARAM_ITEM>
 
56
    </PARAM_INDENT>
 
57
  </PARAM>
 
58
  <DESCRIPTION>
 
59
    <P>
 
60
    Calculate the group delay of a digital filter
 
61
    with transfer function h(z).</P>
 
62
    <P>
 
63
    The filter specification can be in coefficient form,
 
64
    polynomial form, rational polynomial form, cascade
 
65
    polynomial form, or in coefficient polynomial form.</P>
 
66
    <P>
 
67
    In the coefficient polynomial form the transfer function is
 
68
    formulated by the following expression</P>
 
69
    <P>
 
70
      <VERB>h(z)=prod(a1i+a2i*z+z**2)/prod(b1i+b2i*z+z^2)</VERB>
 
71
    </P>
 
72
  </DESCRIPTION>
 
73
  <EXAMPLE>
 
74
<![CDATA[
 
75
z=poly(0,'z');
 
76
h=z/(z-.5);
 
77
[tg,fr]=group(100,h);
 
78
plot(fr,tg)
 
79
 ]]>
 
80
  </EXAMPLE>
 
81
  <AUTHOR>C. B.  </AUTHOR>
 
82
</MAN>