summaryrefslogtreecommitdiff
path: root/help/en_US/scilab_en_US_help/medfilt1.html
blob: 75973c31b7aaa4f53ec85b0ba271dcc88a2266fa (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<html><head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>medfilt1</title>
    <style type="text/css" media="all">
      @import url("scilab_code.css");
      @import url("xml_code.css");
      @import url("c_code.css");
      @import url("style.css");
    </style>
  </head>
  <body>
    <div class="manualnavbar">
    <table width="100%"><tr>
      <td width="30%">
    	<span class="previous"><a href="marcumq.html">&lt;&lt; marcumq</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="mexihat.html">mexihat &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>



    <span class="path"><a href="index.html">FOSSEE Signal Processing Toolbox</a> &gt;&gt; <a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a> &gt; medfilt1</span>

    <br /><br />
    <div class="refnamediv"><h1 class="refname">medfilt1</h1>
    <p class="refpurpose">1D median filtering</p></div>


<div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3>
   <div class="synopsis"><pre></pre></div></div>

<div class="refsection"><h3 class="title">Description</h3>
   <p class="para">y = medfilt1(x)
Applies a 3rd order 1-dimensional median filter to input x along the
first non-zero dimension. The function appropriately pads the signal
with zeros at the endings. For a segment, a median is calculated as
the middle value (average of two middle values) for odd number
number (even number) of data points.
y = medfilt1(x,n)
Applies a nth order 1-dimensional median filter.
y = medfilt1(x,n,dim)
Applies the median filter along the n-th dimension
y = medfilt1(__, nanflag, padding)
nanflag specifies how NaN values are treated. padding specifies the
type of filtering to be performed at the signal edges.</p>
   <p class="para"></p></div>

<div class="refsection"><h3 class="title">Parameters</h3>
   <dl><dt><span class="term">x:</span>
      <dd><p class="para">int | double</p></dd></dt>
   <dt><span class="term">n:</span>
      <dd><p class="para">positive integer scalar</p></dd></dt>
   <dt><span class="term">dim:</span>
      <dd><p class="para">positive integer scalar</p></dd></dt>
   <dt><span class="term">nanflag:</span>
      <dd><p class="para">&#0039;includenan&#0039; (default) | &#0039;omitnan&#0039;</p></dd></dt>
   <dt><span class="term">* includenan:</span>
      <dd><p class="para">Filtering such that the median of any segment</p></dd></dt>
   <dt><span class="term">* omitnan:</span>
      <dd><p class="para">Filtering with NaNs omitted in each segment. If a segment</p></dd></dt>
   <dt><span class="term">y:</span>
      <dd><p class="para">int | double</p></dd></dt></dl></div>

<div class="refsection"><h3 class="title">Examples</h3>
   <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabnumber">1</span><span class="scilabopenclose">)</span> <span class="scilabid">Noise</span> <span class="scilabid">supression</span> <span class="scilabid">using</span> <a class="scilabmacro" href="scilab://median">median</a> <span class="scilabstring">filtering</span>
<span class="scilabid">fs</span> <span class="scilaboperator">=</span> <span class="scilabnumber">1e3</span><span class="scilabdefault">;</span>
<span class="scilabid">t</span> <span class="scilaboperator">=</span>  <span class="scilabnumber">1</span><span class="scilabspecial">:</span><span class="scilabnumber">1</span><span class="scilaboperator">/</span><span class="scilabid">fs</span><span class="scilabspecial">:</span><span class="scilabnumber">1</span><span class="scilabdefault">;</span>
<span class="scilabid">s</span> <span class="scilaboperator">=</span> <a class="scilabcommand" href="scilab://sin">sin</a><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilaboperator">*</span><span class="scilabconstants">%pi</span><span class="scilaboperator">*</span><span class="scilabnumber">2</span><span class="scilaboperator">*</span><span class="scilabid">t</span><span class="scilabopenclose">)</span><span class="scilaboperator">+</span> <a class="scilabcommand" href="scilab://cos">cos</a><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilaboperator">*</span><span class="scilabconstants">%pi</span><span class="scilaboperator">*</span><span class="scilabnumber">5</span><span class="scilaboperator">*</span><span class="scilabid">t</span><span class="scilabopenclose">)</span><span class="scilabdefault">;</span>
<span class="scilabcomment">// Adding noise</span>
<span class="scilabid">x</span> <span class="scilaboperator">=</span> <span class="scilabid">s</span> <span class="scilaboperator">+</span> <span class="scilabnumber">0.1</span><span class="scilaboperator">*</span><span class="scilabid">randn</span><span class="scilabopenclose">(</span><a class="scilabcommand" href="scilab://size">size</a><span class="scilabopenclose">(</span><span class="scilabid">s</span><span class="scilabopenclose">)</span><span class="scilabopenclose">)</span><span class="scilabdefault">;</span>
<span class="scilabid">y</span> <span class="scilaboperator">=</span> <span class="scilabid">medfilt1</span><span class="scilabopenclose">(</span><span class="scilabid">x</span><span class="scilabopenclose">)</span><span class="scilabdefault">;</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div>

<div class="refsection"><h3 class="title">See also</h3>
   <ul class="itemizedlist"><li class="member"><a href="scilab://filter" class="link">| hampel | median | sgolayfilt</a></li></ul></div>

<div class="refsection"><h3 class="title">Authors</h3>
   <ul class="itemizedlist"><li class="member">Ayush Baid</li></ul></div>
    <br />

    <div class="manualnavbar">
    <table width="100%">
    <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
<tr>
      <td width="30%">
    	<span class="previous"><a href="marcumq.html">&lt;&lt; marcumq</a></span>

      </td>
      <td width="40%" class="center">
      	<span class="top"><a href="section_cc2bc01c47967d47fcf3507a91d572ba.html">FOSSEE Signal Processing Toolbox</a></span>

      </td>
      <td width="30%" class="next">
      	<span class="next"><a href="mexihat.html">mexihat &gt;&gt;</a></span>

      </td>
    </tr></table>
      <hr />
    </div>
  </body>
</html>