[cacsd] organized the help
[scilab.git] / scilab / modules / cacsd / help / en_US / linear_analysis / freq_domain / freson.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - 
5  * 
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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="freson">
17     <refnamediv>
18         <refname>freson</refname>
19         <refpurpose>peak frequencies</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>fr=freson(h)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>h</term>
30                 <listitem>
31                     <para>
32                         <literal>syslin</literal> list
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>fr</term>
38                 <listitem>
39                     <para>vector of peak frequencies in Hz</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>
47             returns the vector of peak frequencies in Hz for the SISO plant
48             <literal>h</literal>
49         </para>
50     </refsection>
51     <refsection>
52         <title>Examples</title>
53         <programlisting role="example"><![CDATA[ 
54 h=syslin('c',-1+%s,(3+2*%s+%s^2)*(50+0.1*%s+%s^2))
55 fr=freson(h)
56 bode(h)
57 g=20*log(abs(repfreq(h,fr)))/log(10)
58  ]]></programlisting>
59         <scilab:image>
60             h=syslin('c',-1+%s,(3+2*%s+%s^2)*(50+0.1*%s+%s^2))
61             fr=freson(h)
62             bode(h)
63             g=20*log(abs(repfreq(h,fr)))/log(10)
64         </scilab:image>
65     </refsection>
66     <refsection role="see also">
67         <title>See Also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="frep2tf">frep2tf</link>
71             </member>
72             <member>
73                 <link linkend="zgrid">zgrid</link>
74             </member>
75             <member>
76                 <link linkend="h_norm">h_norm</link>
77             </member>
78         </simplelist>
79     </refsection>
80 </refentry>