summaryrefslogtreecommitdiff
path: root/help/en_US/movingrms.xml
blob: 5498eb981f542007e1024720dfaacaad21d33b61 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?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>Find moving RMS value of signal in x</refpurpose>
    <para> </para>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   [rmsx,w]=movingrms(x,width,risetime)
   [rmsx,w]=movingrms(x,width,risetime,Fs)
   </synopsis>
    <para> </para>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>x:</term>
      <listitem><para> (Real or complex valued vector or matrix) Input signal samples</para></listitem></varlistentry>
   <varlistentry><term>width:</term>
      <listitem><para> Real or complex scalar value</para></listitem></varlistentry>
   <varlistentry><term>risetime:</term>
      <listitem><para> Real or complex scalar value</para></listitem></varlistentry>
   <varlistentry><term>Fs:</term>
      <listitem><para> (Real or complex scalar value) Smapling frequency</para></listitem></varlistentry>
   </variablelist>
    <para> </para>
</refsection>

<refsection>
   <title>Description</title>
   <para>
In this function 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>
    <para> </para>
</refsection>

<refsection>
   <title>Example : 1</title>
   <programlisting role="example"><![CDATA[
[a,b]=movingrms ([4.4 94 1;-2 5*%i 5],1,-2) // moving rms with default value of Fs = 1
   ]]></programlisting>

<title>Example : 2</title>
   <programlisting role="example"><![CDATA[
[a,b]=movingrms ([4.4 94 1;-2 5*%i 5],1,-2,2)// moving rms with value of Fs = 2

   ]]></programlisting>
</refsection>

</refentry>