summaryrefslogtreecommitdiff
path: root/help/en_US/freqs.xml
diff options
context:
space:
mode:
authorbgtushar2017-11-27 20:50:49 +0530
committerbgtushar2017-11-27 20:50:49 +0530
commitd972a68bc5b3c4c059b70e4f8cd64a64538c2be8 (patch)
tree0d2ed042fd29153bd9444a15f2d7807750472042 /help/en_US/freqs.xml
parent1a9dc5fe1e700a123787f6183bceacaefaf954d6 (diff)
parent25a88252ee49c73acb18232f6e916d7742a1af80 (diff)
downloadFOSSEE-Signal-Processing-Toolbox-d972a68bc5b3c4c059b70e4f8cd64a64538c2be8.tar.gz
FOSSEE-Signal-Processing-Toolbox-d972a68bc5b3c4c059b70e4f8cd64a64538c2be8.tar.bz2
FOSSEE-Signal-Processing-Toolbox-d972a68bc5b3c4c059b70e4f8cd64a64538c2be8.zip
merge
Diffstat (limited to 'help/en_US/freqs.xml')
-rw-r--r--help/en_US/freqs.xml61
1 files changed, 61 insertions, 0 deletions
diff --git a/help/en_US/freqs.xml b/help/en_US/freqs.xml
new file mode 100644
index 0000000..258f280
--- /dev/null
+++ b/help/en_US/freqs.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from freqs.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="freqs" 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>freqs</refname>
+ <refpurpose>Compute the s-plane frequency response of the IIR filter.</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ h = freqs (b, a, w)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>b:</term>
+ <listitem><para> vector containing the coefficients of the numerator of the filter.</para></listitem></varlistentry>
+ <varlistentry><term>a:</term>
+ <listitem><para> vector containing the coefficients of the denominator of the filter.</para></listitem></varlistentry>
+ <varlistentry><term>w:</term>
+ <listitem><para> vector containing frequencies</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This is an Octave function.
+It computes the s-plane frequency response of the IIR filter B(s)/A(s) as H = polyval(B,j*W)./polyval(A,j*W).
+If called with no output argument, a plot of magnitude and phase are displayed.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+B = [1 2];
+A = [1 1];
+w = linspace(0,4,128);
+freqs(B,A,w);
+ ]]></programlisting>
+</refsection>
+</refentry>