summaryrefslogtreecommitdiff
path: root/help/en_US/ncauer.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/ncauer.xml')
-rw-r--r--help/en_US/ncauer.xml71
1 files changed, 71 insertions, 0 deletions
diff --git a/help/en_US/ncauer.xml b/help/en_US/ncauer.xml
new file mode 100644
index 0000000..a9395af
--- /dev/null
+++ b/help/en_US/ncauer.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from ncauer.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="ncauer" 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>ncauer</refname>
+ <refpurpose>Analog prototype for Cauer filter.</refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ [Zz, Zp, Zg] = ncauer(Rp, Rs, n)
+ [Zz, Zp] = ncauer(Rp, Rs, n)
+ Zz = ncauer(Rp, Rs, n)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>n:</term>
+ <listitem><para> Filter Order</para></listitem></varlistentry>
+ <varlistentry><term>Rp:</term>
+ <listitem><para> Peak-to-peak passband ripple</para></listitem></varlistentry>
+ <varlistentry><term>Rs:</term>
+ <listitem><para> Stopband attenuation</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This is an Octave function.
+It designs an analog prototype for Cauer filter of nth order, with a Peak-to-peak passband ripple of Rp and a stopband attenuation of Rs.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+n = 5;
+Rp = 5;
+Rs = 5;
+[Zz, Zp, Zg] = ncauer(Rp, Rs, n)
+Zz =
+
+0.0000 + 2.5546i 0.0000 + 1.6835i -0.0000 - 2.5546i -0.0000 - 1.6835i
+
+Zp =
+
+-0.10199 + 0.64039i -0.03168 + 0.96777i -0.10199 - 0.64039i -0.03168 - 0.96777i -0.14368 + 0.00000i
+
+Zg = 0.0030628
+ ]]></programlisting>
+</refsection>
+</refentry>