Typo fixes
[scilab.git] / scilab / modules / signal_processing / help / en_US / wfir_gui.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en_US" xml:id="wfir_gui">
3     <refnamediv>
4         <refname>wfir_gui</refname>
5         <refpurpose>Graphical user interface that can be used to interactively design wfir filters</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>[ftype,forder,cfreq,wtype,fpar] = wfir_gui()</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Parameters</title>
13         <variablelist>
14             <varlistentry>
15                 <term>ftype</term>
16                 <listitem>
17                     <para>
18                         a string: the selected filter type.
19                     </para>
20                 </listitem>
21             </varlistentry>
22             <varlistentry>
23                 <term>forder</term>
24                 <listitem>
25                     <para>
26                         a scalar with positive integer value: the selected filter order
27                     </para>
28                 </listitem>
29             </varlistentry>
30             <varlistentry>
31                 <term>cfreq</term>
32                 <listitem>
33                     <para>
34                         a 2 vector: the cut-off frequencies in normalized frequencies
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>wtype</term>
40                 <listitem>
41                     <para>
42                         a string: the selected window type.
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>fpar</term>
48                 <listitem>
49                     <para>
50                         2-vector of window parameters.
51                     </para>
52                 </listitem>
53             </varlistentry>
54         </variablelist>
55     </refsection>
56     <refsection>
57         <title>Description</title>
58         <para>
59             This function proposes a graphical user interface to allow user
60             interactively select the design parameters of windowed
61             finite impulse response filters (see <link linkend="wfir">wfir</link>). It is called by
62             <literal>wfir</literal> when no input arguments are given.
63         </para>
64         <para>
65             <inlinemediaobject>
66                 <imageobject>
67                     <imagedata fileref="../images/wfir_gui_dialog.png"/>
68                 </imageobject>
69             </inlinemediaobject>
70         </para>
71         <para>
72             If requested, the frequency response of the filter is
73             automatically updated according to the parameters set in the
74             dialog window:
75         </para>
76         <para>
77             <inlinemediaobject>
78                 <imageobject>
79                     <imagedata fileref="../images/wfir_gui_view.svg"/>
80                 </imageobject>
81             </inlinemediaobject>
82         </para>
83     </refsection>
84     <refsection>
85         <title>See Also</title>
86         <simplelist type="inline">
87             <member>
88                 <link linkend="wfir">wfir</link>
89             </member>
90         </simplelist>
91     </refsection>
92     <refsection>
93         <title>Used Functions</title>
94         <para>
95             Based on <link linkend="uicontrol">uicontrol</link> functions.
96         </para>
97     </refsection>
98     <refsection>
99         <title>Examples</title>
100         <programlisting role="example"><![CDATA[
101 wfir_gui()
102  ]]></programlisting>
103     </refsection>
104     
105     <refsection>
106         <title>History</title>
107         <revhistory>
108             <revision>
109                 <revnumber>5.4.0</revnumber>
110                 <revremark>Function wfir_gui is redesigned from scratch to provide a better user experience.</revremark>
111             </revision>
112         </revhistory>
113     </refsection>
114 </refentry>