summaryrefslogtreecommitdiff
path: root/2.3-1/help/en_US/CV_GaussianBlur.xml
blob: 88a8f33c4668f8d956a8b19998fb56de23f7c21c (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
<?xml version="1.0" encoding="UTF-8"?>

<!--
 *
 * This help file was generated from CV_GaussianBlur.sci using help_from_sci().
 *
 -->

<refentry version="5.0-subset Scilab" xml:id="CV_GaussianBlur" 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>CV_GaussianBlur</refname>
    <refpurpose>function to blur image using gaussian filter</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   cvtimg = CV_GaussianBlur(srcimg,ksize_width,ksize_height,sigma_x,sigma_y,border_type)
   
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>srcimg :</term>
      <listitem><para> Source image.</para></listitem></varlistentry>
   <varlistentry><term>ksize_width, ksize_height :</term>
      <listitem><para> blurring kernel size. must be odd.</para></listitem></varlistentry>
   <varlistentry><term>sigmaX :</term>
      <listitem><para> Gaussian kernel standard deviation in X direction.</para></listitem></varlistentry>
   <varlistentry><term>sigmaY :</term>
      <listitem><para> Gaussian kernel standard deviation in Y direction;</para></listitem></varlistentry>
   <varlistentry><term>border_type :</term>
      <listitem><para> border mode used to extrapolate pixels outside of the image.</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This function can be used for blurring image using gaussian filter. Image can be of any depth and have any no of channels.
   </para>
   <para>
For sigmaX and sigmaY : if sigmaY is zero, it is set to be equal to sigmaX, if both sigmas are zeros, they are computed from ksize.width and ksize.height , respectively.
   </para>
   <para>
border_type can be :
<itemizedlist>
<listitem>BORDER_REPLICATE:         aaaaaa|abcdefgh|hhhhhhh</listitem>
<listitem>BORDER_REFLECT:           fedcba|abcdefgh|hgfedcb</listitem>
<listitem>BORDER_REFLECT_101:       gfedcb|abcdefgh|gfedcba</listitem>
<listitem>BORDER_WRAP:              cdefgh|abcdefgh|abcdefg</listitem>
<listitem>BORDER_CONSTANT:        iiiiii|abcdefgh|iiiiiii</listitem>
</itemizedlist>
   </para>
   <para>
This is curretly dummy function. It provides no functionality but is required
for providing support for generating C code for OpenCV
   </para>
   <para>
</para>
</refsection>

<refsection>
   <title>Examples</title>
   <programlisting role="example"><![CDATA[
img = CV_LoadImage('~/test.jpg',0)
dst = CV_GaussianBlur(img,3,3,0,0,"BORDER_CONSTANT")
   ]]></programlisting>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="CV_LoadImage">CV_Blur, CV_CvtColor</link></member>
   </simplelist>
</refsection>

<refsection>
   <title>Authors</title>
   <simplelist type="vert">
   <member>Siddhesh Wani</member>
   </simplelist>
</refsection>
</refentry>