summaryrefslogtreecommitdiff
path: root/help/en_US/CV_Dilate.xml
blob: d01b3ab7ee0c02484dfac1337e10b48e068fa571 (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
<?xml version="1.0" encoding="UTF-8"?>

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

<refentry version="5.0-subset Scilab" xml:id="CV_Dilate" 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_Dilate</refname>
    <refpurpose>dilates an image by using a specific structuring element.</refpurpose>
  </refnamediv>


<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   cvtimg = CV_Dilate(srcimg,dilation_type,dilation_size,[iterations,border_type,border_value])
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Parameters</title>
   <variablelist>
   <varlistentry><term>src :</term>
      <listitem><para> input image; the number of channels can be arbitrary, but the depth should be one of CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.</para></listitem></varlistentry>
   <varlistentry><term>dilation_type :</term>
      <listitem><para> can be one of MORPH_RECT, MORPH_CROSS,MORPH_ELLIPSE</para></listitem></varlistentry>
   <varlistentry><term>dilation_size :</term>
      <listitem><para> size of kernel to be used for erosion. Must be odd</para></listitem></varlistentry>
   <varlistentry><term>iterations :</term>
      <listitem><para> number of times erosion is applied.</para></listitem></varlistentry>
   <varlistentry><term>border_type :</term>
      <listitem><para> pixel extrapolation method.</para></listitem></varlistentry>
   <varlistentry><term>border_value :</term>
      <listitem><para> border value in case of a constant border</para></listitem></varlistentry>
   </variablelist>
</refsection>

<refsection>
   <title>Description</title>
   <para>
This function can be used for eroding an image. Kernel used for erosion is decided by type and size. Size must always be odd. Anchor pint of kernel is always center of kernel. Input arguements 'iterations(1), border_type(BORDER_CONSTANT) and border_value' are optionals. Whwn not specified, default values as as mentioned in brackets.
   </para>
   <para>
border_type can be :
<itemizedlist>
<listitem><para> BORDER_REPLICATE:         aaaaaa|abcdefgh|hhhhhhh </para></listitem>
<listitem><para> BORDER_REFLECT:           fedcba|abcdefgh|hgfedcb </para></listitem>
<listitem><para> BORDER_REFLECT_101:       gfedcb|abcdefgh|gfedcba </para></listitem>
<listitem><para> BORDER_WRAP:              cdefgh|abcdefgh|abcdefg </para></listitem>
<listitem><para> BORDER_CONSTANT:    iiiiii|abcdefgh|iiiiiii </para></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_Erode(img,"MORPH_RECT",3,1,"BORDER_CONSTANT",0);
   ]]></programlisting>
</refsection>

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

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