File: imwrite.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 (84 lines) | stat: -rw-r--r-- 2,941 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
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE MAN SYSTEM "mansivp.dtd">
<MAN>
<LANGUAGE>eng</LANGUAGE>
<TITLE>imwrite</TITLE>
<TYPE>SIVP Toolbox</TYPE>
<DATE>Oct, 2006</DATE>
<SHORT_DESCRIPTION name="imwrite">Write image to file</SHORT_DESCRIPTION>
<CALLING_SEQUENCE>
   <CALLING_SEQUENCE_ITEM>ret=imwrite(im, filename)</CALLING_SEQUENCE_ITEM>
</CALLING_SEQUENCE>
<PARAM>
<PARAM_INDENT>
   <PARAM_ITEM>
   <PARAM_NAME>im</PARAM_NAME>
   <PARAM_DESCRIPTION>
	<TT>im</TT> can be an M-by-N (greyscale image) or M-by-N-by-3 (color image) matrix. 
If <TT>im</TT> is not of class uint8,  <TT>imwrite</TT> will convert the datatype before writing using <TT>im2uint8(im)</TT>.
   </PARAM_DESCRIPTION>
   </PARAM_ITEM>
   <PARAM_ITEM>
   <PARAM_NAME>filename</PARAM_NAME>
   <PARAM_DESCRIPTION>
   A string that specifies the name of the output file.
   </PARAM_DESCRIPTION>
   </PARAM_ITEM>
   <PARAM_ITEM>
   <PARAM_NAME>ret</PARAM_NAME>
   <PARAM_DESCRIPTION>
   Return value. If the image is successfully writed into a file, <TT>ret</TT> will be 1.
   </PARAM_DESCRIPTION>
   </PARAM_ITEM>
</PARAM_INDENT>
</PARAM>
<DESCRIPTION>
<P>
   <TT>imwrite</TT> writes a matrix into a image file. The format of the  file is inferred from the extension in the <TT>filename</TT> parameter. Currently the following file formats are supported:</P>
   <DESCRIPTION_INDENT><DESCRIPTION_ITEM>
    * Windows bitmaps - BMP, DIB;
   </DESCRIPTION_ITEM></DESCRIPTION_INDENT>
   <DESCRIPTION_INDENT><DESCRIPTION_ITEM>
    * JPEG files - JPEG, JPG, JPE;
   </DESCRIPTION_ITEM></DESCRIPTION_INDENT>
   <DESCRIPTION_INDENT><DESCRIPTION_ITEM>
    * Portable Network Graphics - PNG;
   </DESCRIPTION_ITEM></DESCRIPTION_INDENT>
   <DESCRIPTION_INDENT><DESCRIPTION_ITEM>
    * Portable image format - PBM, PGM, PPM;
   </DESCRIPTION_ITEM></DESCRIPTION_INDENT>
   <DESCRIPTION_INDENT><DESCRIPTION_ITEM>
    * Sun rasters - SR, RAS;
   </DESCRIPTION_ITEM></DESCRIPTION_INDENT>
   <DESCRIPTION_INDENT><DESCRIPTION_ITEM>
    * TIFF files - TIFF, TIF. 
   </DESCRIPTION_ITEM></DESCRIPTION_INDENT>

</DESCRIPTION>
<EXAMPLE><![CDATA[
    im=rand(200,300);
    ret = imwrite(im, 'rand.png');
]]></EXAMPLE>
<!-- ================================= -->

<AUTHORS>
   <AUTHORS_ITEM name="Shiqi"> Shiqi Yu &lt;shiqi.yu[at]gmail.com&gt; </AUTHORS_ITEM>
</AUTHORS>
<!-- ================================= -->
<SECTION label="Bugs and Shortcomings">
<P>
Images with a palette are not supported.
</P>
</SECTION>
<!-- ================================= -->
<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>imread</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>