diff options
Diffstat (limited to '2.3-1/help/en_US/CV_LoadImage.xml')
-rw-r--r-- | 2.3-1/help/en_US/CV_LoadImage.xml | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/2.3-1/help/en_US/CV_LoadImage.xml b/2.3-1/help/en_US/CV_LoadImage.xml new file mode 100644 index 00000000..70f55c82 --- /dev/null +++ b/2.3-1/help/en_US/CV_LoadImage.xml @@ -0,0 +1,83 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + * + * This help file was generated from CV_LoadImage.sci using help_from_sci(). + * + --> + +<refentry version="5.0-subset Scilab" xml:id="CV_LoadImage" 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_LoadImage</refname> + <refpurpose>function to load an image object from given filename</refpurpose> + </refnamediv> + + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + CV_LoadImage(filename,loadtype) + + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>filename:</term> + <listitem><para> name of file to be opened</para></listitem></varlistentry> + <varlistentry><term>loadtype:</term> + <listitem><para> desired load method</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +This function can be used for loading a previously stored image + </para> + <para> +loadtype can take the following values: +<itemizedlist> +<listitem><para> less than 0 -> image is loaded as is (with alpha channel)</para></listitem> +<listitem><para> 0 -> image is loaded as greyscale</para></listitem> +<listitem><para> greater than 0 -> 3 channel color image is loaded</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[ +CV_LoadImage('~/test.jpg',0) + ]]></programlisting> +</refsection> + +<refsection> + <title>See also</title> + <simplelist type="inline"> + <member><link linkend="CV_CreateImage">CV_CreateImage</link></member> + </simplelist> +</refsection> + +<refsection> + <title>Authors</title> + <simplelist type="vert"> + <member>Siddhesh Wani</member> + </simplelist> +</refsection> +</refentry> |