summaryrefslogtreecommitdiff
path: root/help/en_US/besself.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/besself.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/besself.xml')
-rw-r--r--help/en_US/besself.xml38
1 files changed, 19 insertions, 19 deletions
diff --git a/help/en_US/besself.xml b/help/en_US/besself.xml
index b792eaf..f7456d9 100644
--- a/help/en_US/besself.xml
+++ b/help/en_US/besself.xml
@@ -17,18 +17,19 @@
<refnamediv>
<refname>besself</refname>
- <refpurpose>This function generates a Bessel filter.</refpurpose>
+ <refpurpose>Bessel filter design.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
- [a, b] = besself(n, w)
- [a, b] = besself (n, w, "high")
- [a, b, c] = besself (…)
- [a, b, c, d] = besself (…)
- […] = besself (…, "z")
+[b, a] = besself(n, Wc)
+[b, a] = besself (n, Wc, "high")
+[b, a] = besself (n, [Wl, Wh])
+[b, a] = besself (n, [Wl, Wh], "stop")
+[z, p, g] = besself (…)
+[…] = besself (…, "z")
</synopsis>
</refsynopsisdiv>
@@ -36,31 +37,30 @@
<title>Parameters</title>
<variablelist>
<varlistentry><term>n:</term>
- <listitem><para> positive integer value</para></listitem></varlistentry>
- <varlistentry><term>w:</term>
- <listitem><para> positive real value</para></listitem></varlistentry>
+ <listitem><para> positive integer value (order of filter)</para></listitem></varlistentry>
+ <varlistentry><term>W:</term>
+ <listitem><para> positive real value</para><para> 1).Analog 3dB cutoff frequency/frequencies for analog filter, in the range [0, Inf] {rad/sec}</para><para> 2).Normalised digital 3dB cutoff frequency/frequencies for digital filter, in the range [0, 1] {dimensionless}</para></listitem></varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
-This is an Octave function.
-This function generates a Bessel filter. The default is a Laplace space (s) filter.
-The third parameter takes in high or low, the default value being low. The cutoff is pi*Wc radians.
-[z,p,g] = besself(...) returns filter as zero-pole-gain rather than coefficients of the numerator and denominator polynomials.
-[...] = besself(...,’z’) returns a discrete space (Z) filter. w must be less than 1.
-[a,b,c,d] = besself(...) returns state-space matrices.
+This function generates a Bessel filter. The default is a Laplace space (s) or analog filter.</para>
+<para>If second argument is scalar the third parameter takes in high or low, the default value being low. The cutoff is Wc rad/sec.</para>
+<para>If second argument is vector of length 2 ie [Wl Wh] then third parameter may be pass or stop default is pass for bandpass and band reject filter respectively</para>
+<para>[z,p,g] = besself(...) returns filter as zero-pole-gain rather than coefficients of the numerator and denominator polynomials.</para>
+<para>[...] = besself(...,’z’) returns a discrete space (Z) filter. Wc must be less than 1 {dimensionless}.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
-[a,b]=besself(2,3,"low")
-a = 9.0000
-b =
-1.0000 5.1962 9.0000
+n = 2;
+wc = 0.3;
+[b, a]=besself(n, wc, "high", "z")
+
]]></programlisting>
</refsection>
</refentry>