File: imread.xml

package info (click to toggle)
sivp 0.4.3-3
  • links: PTS, VCS
  • area: contrib
  • in suites: lenny
  • size: 4,400 kB
  • ctags: 94
  • sloc: sh: 8,731; xml: 3,173; ansic: 2,069; makefile: 102; tcl: 72
file content (89 lines) | stat: -rw-r--r-- 3,030 bytes parent folder | download
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
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE MAN SYSTEM "mansivp.dtd">
<MAN>
<LANGUAGE>eng</LANGUAGE>
<TITLE>imread</TITLE>
<TYPE>SIVP Toolbox</TYPE>
<DATE>July, 2005</DATE>
<SHORT_DESCRIPTION name="imread">Reads image file</SHORT_DESCRIPTION>
<CALLING_SEQUENCE>
   <CALLING_SEQUENCE_ITEM>im = imread(filename)</CALLING_SEQUENCE_ITEM>
</CALLING_SEQUENCE>
<PARAM>
<PARAM_INDENT>
   <PARAM_ITEM>
   <PARAM_NAME>filename</PARAM_NAME>
   <PARAM_DESCRIPTION>
   A string, the image filename to be read. The extension determines the type of the image.
   </PARAM_DESCRIPTION>
   </PARAM_ITEM>
   <PARAM_ITEM>
   <PARAM_NAME>im</PARAM_NAME>
   <PARAM_DESCRIPTION>
   All images will be converted to gray images or RGB images. For gray images, this is a MxN unsigned char matrix; For RGB images, this is a MxNx3 unsigned char matrix.
   </PARAM_DESCRIPTION>
   </PARAM_ITEM>
</PARAM_INDENT>
</PARAM>
<DESCRIPTION>
<P>
   <TT>imread</TT> reads many types of image files into Scilab. The format of the  file is inferred from the extension in the filename parameter. Currently the following file formats are supported:</P>
   <DESCRIPTION_INDENT>
     <DESCRIPTION_ITEM>
       * Windows bitmaps - BMP, DIB;
     </DESCRIPTION_ITEM>
     <DESCRIPTION_ITEM>
       * JPEG files - JPEG, JPG, JPE;
     </DESCRIPTION_ITEM>
     <DESCRIPTION_ITEM>
       * Portable Network Graphics - PNG;
     </DESCRIPTION_ITEM>
     <DESCRIPTION_ITEM>
       * Portable image format - PBM, PGM, PPM;
     </DESCRIPTION_ITEM>
     <DESCRIPTION_ITEM>
       * Sun rasters - SR, RAS;
     </DESCRIPTION_ITEM><DESCRIPTION_ITEM>
       * TIFF files - TIFF, TIF. 
     </DESCRIPTION_ITEM>
</DESCRIPTION_INDENT>

   <DESCRIPTION_INDENT>
   <DESCRIPTION_ITEM label="im = imread(filename)">
      reads image in filename into <TT>im</TT>
      matrix. If filename contains a truecolor image, <TT>im</TT> is a
   MxNx3 hypermatrix, so for example <TT>im(:,:,1)</TT> stands for  the
   red channel. For gray images, im is a MxNx1 unsigned char matrix.
   </DESCRIPTION_ITEM>
   </DESCRIPTION_INDENT>
</DESCRIPTION>
<EXAMPLE><![CDATA[

    im = imread(SCI + '/contrib/sivp/images/lena.png');
    imshow(im);

]]></EXAMPLE>
<!-- ================================= -->
<SECTION label="Bugs and Shortcomings">
<P>
Images with a palette are not supported.
All kinds of images are converted to gray images or RGB images.
</P>
</SECTION>
<!-- ================================= -->

<AUTHORS>
   <AUTHORS_ITEM name="Shiqi"> Shiqi Yu &lt;shiqi.yu[at]gmail.com&gt; </AUTHORS_ITEM>
</AUTHORS>
<!-- ================================= -->
<SECTION label="Availability">
The latest version of SIVP can be found at
<P><A href="http://sivp.sourceforge.net">http://sivp.sourceforge.net</A></P>
</SECTION>
<!-- ================================= -->
   <SEE_ALSO>
      <SEE_ALSO_ITEM> <LINK>imwrite</LINK> </SEE_ALSO_ITEM>
      <SEE_ALSO_ITEM> <LINK>imshow</LINK> </SEE_ALSO_ITEM>
      <SEE_ALSO_ITEM> <LINK>imfinfo</LINK> </SEE_ALSO_ITEM>
   </SEE_ALSO>
</MAN>