summaryrefslogtreecommitdiff
path: root/help/en_US/qp_kaiser.xml
diff options
context:
space:
mode:
authorBrijeshcr2017-11-30 18:27:20 +0530
committerBrijeshcr2017-11-30 18:27:20 +0530
commitc257cd7a7e766fb89332cca4fb367904767362ed (patch)
tree8f455c21cddfd7856cb53c9436319b2c68e4ab50 /help/en_US/qp_kaiser.xml
parentcc5c7ee42c6cb2ab94dd0e0f6985778657ab47f5 (diff)
downloadFOSSEE-Signal-Processing-Toolbox-c257cd7a7e766fb89332cca4fb367904767362ed.tar.gz
FOSSEE-Signal-Processing-Toolbox-c257cd7a7e766fb89332cca4fb367904767362ed.tar.bz2
FOSSEE-Signal-Processing-Toolbox-c257cd7a7e766fb89332cca4fb367904767362ed.zip
Help files and functions
Diffstat (limited to 'help/en_US/qp_kaiser.xml')
-rw-r--r--help/en_US/qp_kaiser.xml64
1 files changed, 64 insertions, 0 deletions
diff --git a/help/en_US/qp_kaiser.xml b/help/en_US/qp_kaiser.xml
new file mode 100644
index 0000000..005f11a
--- /dev/null
+++ b/help/en_US/qp_kaiser.xml
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from qp_kaiser.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="qp_kaiser" 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>qp_kaiser</refname>
+ <refpurpose>Computes a finite impulse response (FIR) filter for use with a quasi-perfect reconstruction polyphase-network filter bank.</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ qp_kaiser (nb, at, linear)
+ qp_kaiser (nb, at)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>nb:</term>
+ <listitem><para> Number of bands</para></listitem></varlistentry>
+ <varlistentry><term>at:</term>
+ <listitem><para> Attenuation</para></listitem></varlistentry>
+ <varlistentry><term>linear:</term>
+ <listitem><para> When not zero, minimum-phase calculation is omitted.</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This is an Octave function.
+This version utilizes a Kaiser window to shape the frequency response of the designed filter. Tha number nb of bands and the desired attenuation at in the stop-band are given as parameters.
+ </para>
+ <para>
+The Kaiser window is multiplied by the ideal impulse response h(n)=a.sinc(a.n) and converted to its minimum-phase version by means of a Hilbert transform.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+qp_kaiser (5, 5, 1)
+ans =
+
+0.11591 0.25606 0.25606 0.25606 0.11591
+ ]]></programlisting>
+</refsection>
+</refentry>