diff options
| author | shamikam | 2017-11-07 15:59:48 +0530 |
|---|---|---|
| committer | shamikam | 2017-11-07 15:59:48 +0530 |
| commit | c0c0582462720ed597b00e116506570577614e89 (patch) | |
| tree | 31dedd23698e5357b19c810b7d7a8464100ef44a /help/en_US/movingrms.xml | |
| download | FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.gz FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.tar.bz2 FOSSEE-Signal-Processing-Toolbox-c0c0582462720ed597b00e116506570577614e89.zip | |
initial commit
Diffstat (limited to 'help/en_US/movingrms.xml')
| -rw-r--r-- | help/en_US/movingrms.xml | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/help/en_US/movingrms.xml b/help/en_US/movingrms.xml new file mode 100644 index 0000000..c40672d --- /dev/null +++ b/help/en_US/movingrms.xml @@ -0,0 +1,68 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from movingrms.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="movingrms" 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>movingrms</refname> + <refpurpose></refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + [rmsx,w]=movingrms(x,w,rc,Fs=1) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> Real or complex valued vector or matrix</para></listitem></varlistentry> + <varlistentry><term>w:</term> + <listitem><para> Real or complex scalar value</para></listitem></varlistentry> + <varlistentry><term>rc:</term> + <listitem><para> Real or complex scalar value</para></listitem></varlistentry> + <varlistentry><term>Fs:</term> + <listitem><para> Real or complex scalar value</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This is an Octave function. +The signal is convoluted against a sigmoid window of width w and risetime rc with the units of these parameters relative to the value of the sampling frequency given in Fs (Default value=1). +</para> +</refsection> + +<refsection> + <title>Examples</title> + <programlisting role="example"><![CDATA[ +1. [a,b]=movingrms ([4.4 94 1;-2 5i 5],1,-2) +a = 0.91237 17.71929 0.96254 +0.91237 17.71929 0.96254 +b = 0.18877 +0.18877 +2. [a,b]=movingrms ([4.4 94 1;-2 5i 5],1,-2,2) +a = 4.8332 93.8669 5.0990 +4.8332 93.8669 5.0990 +b = 1 +1 + ]]></programlisting> +</refsection> +</refentry> |