summaryrefslogtreecommitdiff
path: root/help/en_US/ellipap.xml
diff options
context:
space:
mode:
authorSunil Shetye2018-07-25 16:27:51 +0530
committerSunil Shetye2018-07-26 23:50:17 +0530
commit9ca7882cee16ad48b18df989e8300c697010e55a (patch)
tree59e0c6116b835ae3e5e3208bc9609ed2828069ed /help/en_US/ellipap.xml
parent6bbb00d0f0128381ee95194cf7d008fb6504de7d (diff)
downloadFOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.tar.gz
FOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.tar.bz2
FOSSEE-Signal-Processing-Toolbox-9ca7882cee16ad48b18df989e8300c697010e55a.zip
code changes by Sonu Sharma during FOSSEE Fellowship 2018
Diffstat (limited to 'help/en_US/ellipap.xml')
-rw-r--r--help/en_US/ellipap.xml40
1 files changed, 23 insertions, 17 deletions
diff --git a/help/en_US/ellipap.xml b/help/en_US/ellipap.xml
index 597a4c1..b0cc2fb 100644
--- a/help/en_US/ellipap.xml
+++ b/help/en_US/ellipap.xml
@@ -17,7 +17,7 @@
<refnamediv>
<refname>ellipap</refname>
- <refpurpose>Designs a lowpass analog elliptic filter.</refpurpose>
+ <refpurpose>Produces a lowpass analog elliptic prototype filter.</refpurpose>
</refnamediv>
@@ -25,8 +25,6 @@
<title>Calling Sequence</title>
<synopsis>
[z, p, g] = ellipap (n, Rp, Rs)
- [z, p] = ellipap (n, Rp, Rs)
- z = ellipap (n, Rp, Rs)
</synopsis>
</refsynopsisdiv>
@@ -36,33 +34,41 @@
<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>
+ <listitem><para> Peak-to-peak passband ripple in dB</para></listitem></varlistentry>
<varlistentry><term>Rs:</term>
- <listitem><para> Stopband attenuation</para></listitem></varlistentry>
+ <listitem><para> Stopband attenuation in dB</para></listitem></varlistentry>
+ <varlistentry><term>z:</term>
+ <listitem><para> Zeros</para></listitem></varlistentry>
+ <varlistentry><term>p:</term>
+ <listitem><para> Poles</para></listitem></varlistentry>
+ <varlistentry><term>g:</term>
+ <listitem><para> Gain</para></listitem></varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
-This is an Octave function.
-It designs a lowpass analog elliptic filter of nth order, with a Peak-to-peak passband ripple of Rp and a stopband attenuation of Rs.
+It gives a lowpass analog elliptic prototype filter of nth order, with a Peak-to-peak passband ripple of Rp dB and a stopband attenuation of Rs dB.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
-[z, p, g] = ellipap (5, 10, 10)
-z =
-
-0.0000 + 2.5546i 0.0000 + 1.6835i -0.0000 - 2.5546i -0.0000 - 1.6835i
-
-p =
-
--0.05243 + 0.63524i -0.01633 + 0.96289i -0.05243 - 0.63524i -0.01633 - 0.96289i -0.07369 + 0.00000i
-
-g = 0.0015012
+n = 4;
+Rp = 3;
+Rs = 10;
+[z, p, g] = ellipap (n, Rp, Rs)
]]></programlisting>
</refsection>
+
+ <refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Sonu Sharma, RGIT Mumbai</member>
+ <member>FOSSEE, IIT Bombay</member>
+ </simplelist>
+ </refsection>
+
</refentry>