Typo fixes
[scilab.git] / scilab / modules / signal_processing / help / en_US / filt_sinc.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" xml:id="filt_sinc">
3     <refnamediv>
4         <refname>filt_sinc</refname>
5         <refpurpose>samples of sinc function</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>[x]=filt_sinc(n,fl)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>n</term>
16                 <listitem>
17                     <para>number of samples</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>fl</term>
22                 <listitem>
23                     <para>cut-off frequency of the associated low-pass filter in Hertz.</para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>x</term>
28                 <listitem>
29                     <para>samples of the sinc function</para>
30                 </listitem>
31             </varlistentry>
32         </variablelist>
33     </refsection>
34     <refsection>
35         <title>Description</title>
36         <para>
37             Calculate n samples of the function <literal>sin(2*pi*fl*t)/(pi*t)</literal>
38             for <literal>t=-(n-1)/2:(n-1)/2</literal> (i.e. centred around the origin).
39         </para>
40     </refsection>
41     <refsection>
42         <title>Examples</title>
43         <programlisting role="example"><![CDATA[
44 plot(filt_sinc(100,0.1))
45  ]]></programlisting>
46         <scilab:image>
47             plot(filt_sinc(100,0.1))
48         </scilab:image>
49     </refsection>
50     <refsection role="see also">
51         <title>See Also</title>
52         <simplelist type="inline">
53             <member>
54                 <link linkend="sincd">sincd</link>
55             </member>
56         </simplelist>
57     </refsection>
58 </refentry>