summaryrefslogtreecommitdiff
path: root/help/en_US/islinphase.xml
blob: 47e4407d3b9364b355819869bf3e968c9a50a72e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from islinphase.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="islinphase" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:scilab="http://www.scilab.org"
          xmlns:db="http://docbook.org/ns/docbook">

  <refnamediv>
    <refname>islinphase</refname>
    <refpurpose>Checks given system function is linearphase or not</refpurpose>
    <para> </para>
  </refnamediv>

<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   flag = islinphase(b,a)
   flag = islinphase(sos)
   flag = islinphase(...,tol)
   </synopsis>
    <para> </para>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>b</term>
      <listitem><para> Coefficients of numerator polynomial of system function </para></listitem></varlistentry>
   <varlistentry><term>a</term>
      <listitem><para> Coefficients of denumerator polynomial of system function</para></listitem></varlistentry>
   <varlistentry><term>sos</term>
      <listitem><para> Second order section matrix of order Kx6 </para></listitem></varlistentry>
   <varlistentry><term>tol</term>
      <listitem><para> Tolerence in similarities between two numbers in phase response </para></listitem></varlistentry>
   <varlistentry><term>flag</term>
      <listitem><para> This function returns logical 1 if system is linear phase (flag = 1) </para> <para> Otherwise it returns logical 0 (flag = 0)</para></listitem></varlistentry>
   </variablelist>
    <para> </para>
</refsection>

<refsection>
   <title>Description</title>
   <para> This function takes input a System function in terms of numerator and denumerator coefficients or in second order section (sos) matrix and checks for system having Linear Phase Response or not </para>
    <para> </para>
</refsection>

<refsection>
   <title>Examples</title>

   <para>Checking given system function is linear-phase or not</para>
   <para>
    <latex>
      \begin{eqnarray}
      H(z) = z^{-1} + 2 z^{-2} + 2 z^{-3} + z^{-4}
      \end{eqnarray}
    </latex>
   </para>
    <para> </para>

   <programlisting role="example"><![CDATA[
b = [0 1 2 2 1 0] ; //Numerator polynomial coefficients
a = 1 ; //Denumerator polynomial coefficients
flag = islinphase(b,a) //This is an example of Symmetric FIR Filter which is Linear Phase, hence it will give output : flag = 1
]]></programlisting>
</refsection>


</refentry>