summaryrefslogtreecommitdiff
path: root/help/en_US/filtfilt.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/filtfilt.xml')
-rw-r--r--help/en_US/filtfilt.xml58
1 files changed, 58 insertions, 0 deletions
diff --git a/help/en_US/filtfilt.xml b/help/en_US/filtfilt.xml
new file mode 100644
index 0000000..baf8dfe
--- /dev/null
+++ b/help/en_US/filtfilt.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from filtfilt.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="filtfilt" 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>filtfilt</refname>
+ <refpurpose></refpurpose>
+ </refnamediv>
+
+
+<refsynopsisdiv>
+ <title>Calling Sequence</title>
+ <synopsis>
+ [y]=filtfilt(b,a,x)
+ </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>b:</term>
+ <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry>
+ <varlistentry><term>a:</term>
+ <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry>
+ <varlistentry><term>x:</term>
+ <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+This is an Octave function
+In theory, it forwards and reverse filters the signal and corrects phase distortion upto an extent by a one-pass filter but squares the magnitude response in the process. Practically though, the correction isn't perfect and magnitude response, particularly the stop band is distorted.
+</para>
+</refsection>
+
+<refsection>
+ <title>Examples</title>
+ <programlisting role="example"><![CDATA[
+1. [a,b]=filtfilt (1,2i,[i -4 0])
+a = [0.00000 - 0.25000i 1.00000 + 0.00000i 0.00000 + 0.00000i]
+ ]]></programlisting>
+</refsection>
+</refentry>