[doc] misc. fix & improvements
[scilab.git] / scilab / modules / signal_processing / help / en_US / sincd.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="sincd">
3     <refnamediv>
4         <refname>sincd</refname>
5         <refpurpose>digital sinc function or Dirichlet kernel</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>[s]=sincd(n,flag)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>n</term>
16                 <listitem>
17                     <para>integer</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>flag</term>
22                 <listitem>
23                     <para>
24                         if <literal>flag = 1</literal> the function is centred around the origin; if <literal>flag = 2</literal> the function is delayed by <literal>%pi/(2*n)</literal>
25                     </para>
26                 </listitem>
27             </varlistentry>
28             <varlistentry>
29                 <term>s</term>
30                 <listitem>
31                     <para>vector of values of the function on a dense grid of frequencies</para>
32                 </listitem>
33             </varlistentry>
34         </variablelist>
35     </refsection>
36     <refsection>
37         <title>Description</title>
38         <para>
39             function which calculates the function <literal>Sin(N*x)/N*Sin(x)</literal>
40         </para>
41     </refsection>
42     <refsection>
43         <title>Examples</title>
44         <programlisting role="example"><![CDATA[
45 plot(sincd(10,1))
46  ]]></programlisting>
47     </refsection>
48 </refentry>