License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / cacsd / help / en_US / formal_representation / dbphi.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="dbphi">
17     <refnamediv>
18         <refname>dbphi</refname>
19         <refpurpose>frequency response to phase and magnitude representation</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Calling Sequence</title>
23         <synopsis>[db,phi] =dbphi(repf)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>db,phi</term>
30                 <listitem>
31                     <para>vector of gains (db) and phases (degrees)</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>repf</term>
36                 <listitem>
37                     <para>vector of complex frequency response</para>
38                 </listitem>
39             </varlistentry>
40         </variablelist>
41     </refsection>
42     <refsection>
43         <title>Description</title>
44         <para>
45             <literal>db(k)</literal> is the magnitude of <literal>repf(k)</literal> expressed in dB i.e.
46             <literal>db(k)=20*log(abs(repf(k)))/log(10)</literal> and <literal>phi(k)</literal> is the phase
47             of <literal>repf(k)</literal> expressed in degrees.
48         </para>
49     </refsection>
50     <refsection role="see also">
51         <title>See Also</title>
52         <simplelist type="inline">
53             <member>
54                 <link linkend="repfreq">repfreq</link>
55             </member>
56             <member>
57                 <link linkend="bode">bode</link>
58             </member>
59         </simplelist>
60     </refsection>
61 </refentry>