Help files, modified Raspberry Pi code conversion

1 files changed, 95 insertions, 0 deletions

diff --git a/2.3-1/help/en_US/CV_GaussianBlur.xml b/2.3-1/help/en_US/CV_GaussianBlur.xml
new file mode 100644
index 00000000..88a8f33c
--- /dev/null
+++ b/2.3-1/help/en_US/CV_GaussianBlur.xml
@@ -0,0 +1,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>