root/doc/html/group__image.html @ 353

Revision 353, 34.7 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: Image Functions and Classes</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59</div>
60<div class="contents">
61<h1>Image Functions and Classes<br>
62<small>
63[<a class="el" href="group__srccode.html">Source Coding Module</a>]</small>
64</h1><table border="0" cellpadding="0" cellspacing="0">
65<tr><td></td></tr>
66<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g22fec1fa9d791759c2c187fc3a9ecc08">itpp::pnm_type</a> (const std::string &amp;filename)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Determines the type of a PNM file, based on magic numbers. The returned value is a character between '1' and '6'. If an error occured, the returned value is the character '0'.  <a href="#g22fec1fa9d791759c2c187fc3a9ecc08"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gb9ebea2b2e8d082dd74a2db32c7818c5">itpp::pnm_info</a> (const std::string &amp;filename, char &amp;pnm_type, int &amp;width, int &amp;height, int &amp;max_val, std::string &amp;comments)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve some information about an pnm file.  <a href="#gb9ebea2b2e8d082dd74a2db32c7818c5"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g65dab488c977c8b53d58db35ee94ece6">itpp::pgm_read</a> (const std::string &amp;filename, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;m, std::string &amp;comments)</td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the entire graymap into the matrix <em>m</em> or return false if the function failed.  <a href="#g65dab488c977c8b53d58db35ee94ece6"></a><br></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g8adf3a6915adc7566a62c169583b2522">itpp::pgm_read</a> (const std::string &amp;filename, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;m, int r1, int r2, int c1, int c2)</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a part of the graymap into the matrix <em>m</em>.  <a href="#g8adf3a6915adc7566a62c169583b2522"></a><br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g20e0ba96ec2cc682950fe640fdc4d2f5">itpp::pgm_read</a> (const std::string &amp;filename)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a pgm file of name filename and return the corresponding matrix of integers. Return a void matrix if an error ocurred.  <a href="#g20e0ba96ec2cc682950fe640fdc4d2f5"></a><br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g9389ba285569485b8a23c1ec5fb829fd">itpp::pgm_write</a> (const std::string &amp;filename, const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;m, const std::string &amp;comments=&quot;Generated by IT++ (http://itpp.sourceforge.net)&quot;)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an image file from the matrix of integer.  <a href="#g9389ba285569485b8a23c1ec5fb829fd"></a><br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gd58303e8848711edb7bf14aa2eaa1397">itpp::ppm_read</a> (const std::string &amp;filename, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;r, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;g, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;b, std::string &amp;comments)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the color image file in the format ppm. The image is retrieved as a set of three matrices, each of whom is a plan of RGB component.  <a href="#gd58303e8848711edb7bf14aa2eaa1397"></a><br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#gbb3c2601f3127e60d60b0dc0c224b19b">itpp::ppm_read</a> (const std::string &amp;filename, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;r, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;g, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;b)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the color image file in the PPM format.  <a href="#gbb3c2601f3127e60d60b0dc0c224b19b"></a><br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1e74677f86754640c72b49669c6480ea"></a><!-- doxytag: member="image::ppm_read" ref="g1e74677f86754640c72b49669c6480ea" args="(const std::string &amp;filename, imat &amp;r, imat &amp;g, imat &amp;b, int r1, int r2, int c1, int c2)" -->
92bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g1e74677f86754640c72b49669c6480ea">itpp::ppm_read</a> (const std::string &amp;filename, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;r, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;g, <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;b, int r1, int r2, int c1, int c2)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a part of the pixmap into the matrix <em>m</em>. The parameters <em>r1</em>, <em>r2</em>, <em>c1</em> and <em>c2</em> are the rows and columns (inclusive) of the subimage. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g9141ce9dacd0149ec89fa1977e13a206">itpp::ppm_write</a> (const std::string &amp;filename, const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;r, const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;g, const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;b, const std::string &amp;comments=&quot;Generated by IT++ (http://itpp.sourceforge.net)&quot;, int max_val=255)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write the matrix <em>m</em> as a pixmap.  <a href="#g9141ce9dacd0149ec89fa1977e13a206"></a><br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#g8ac0e04623245c7edc308b76708b8f7b">itpp::img_double2int</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;m, int max_val=255, double double_min=0, double double_max=1)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prepare a matrix of double to be writted as an image.  <a href="#g8ac0e04623245c7edc308b76708b8f7b"></a><br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__image.html#ga9d05f853b61b2d90323355b40362ed1">itpp::img_int2double</a> (const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;m, int max_val=255, double double_min=0, double double_max=1)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a matrix of double which is a scaled version of the input matrix <em>m</em> of integers.  <a href="#ga9d05f853b61b2d90323355b40362ed1"></a><br></td></tr>
104</table>
105<hr><a name="_details"></a><h2>Detailed Description</h2>
106The PNM graphics format is actually a family of formats consisting of PBM (black and white, not implemented yet), PGM (gray) and PPM (RGB color). This interface proposes input/output functions for images in the raw formats (type 'P4', 'P5' and 'P6').<p>
107There are several utilities available for manipulating PNM images. Search the net for the netpbm package. <hr><h2>Function Documentation</h2>
108<a class="anchor" name="g8ac0e04623245c7edc308b76708b8f7b"></a><!-- doxytag: member="itpp::img_double2int" ref="g8ac0e04623245c7edc308b76708b8f7b" args="(const mat &amp;m, int max_val=255, double double_min=0, double double_max=1)" -->
109<div class="memitem">
110<div class="memproto">
111      <table class="memname">
112        <tr>
113          <td class="memname"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> itpp::img_double2int           </td>
114          <td>(</td>
115          <td class="paramtype">const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;&nbsp;</td>
116          <td class="paramname"> <em>m</em>, </td>
117        </tr>
118        <tr>
119          <td class="paramkey"></td>
120          <td></td>
121          <td class="paramtype">int&nbsp;</td>
122          <td class="paramname"> <em>max_val</em> = <code>255</code>, </td>
123        </tr>
124        <tr>
125          <td class="paramkey"></td>
126          <td></td>
127          <td class="paramtype">double&nbsp;</td>
128          <td class="paramname"> <em>double_min</em> = <code>0</code>, </td>
129        </tr>
130        <tr>
131          <td class="paramkey"></td>
132          <td></td>
133          <td class="paramtype">double&nbsp;</td>
134          <td class="paramname"> <em>double_max</em> = <code>1</code></td><td>&nbsp;</td>
135        </tr>
136        <tr>
137          <td></td>
138          <td>)</td>
139          <td></td><td></td><td></td>
140        </tr>
141      </table>
142</div>
143<div class="memdoc">
144
145<p>
146Prepare a matrix of double to be writted as an image.
147<p>
148<dl compact><dt><b>Parameters:</b></dt><dd>
149  <table border="0" cellspacing="2" cellpadding="0">
150    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>The matrix of real. The components are assumed to be between double_min and double_max, and will be scaled by factor <em>max_val</em> / (<em>double_max</em> - <em>double_min</em> ) in the output matrix. </td></tr>
151    <tr><td valign="top"></td><td valign="top"><em>max_val</em>&nbsp;</td><td>The maximum value for the output matrix. This value is usually set to 255. </td></tr>
152    <tr><td valign="top"></td><td valign="top"><em>double_min</em>&nbsp;</td><td>The value corresponding to the integer value 0. Note that all the values smaller that this quantity will be <em>double_min</em>. </td></tr>
153    <tr><td valign="top"></td><td valign="top"><em>double_max</em>&nbsp;</td><td>The value corresponding to the integer value max_val. Similarly to <em>double_min</em>, values greater than <em>double_max</em> will be set to double_max </td></tr>
154  </table>
155</dl>
156
157</div>
158</div><p>
159<a class="anchor" name="ga9d05f853b61b2d90323355b40362ed1"></a><!-- doxytag: member="itpp::img_int2double" ref="ga9d05f853b61b2d90323355b40362ed1" args="(const imat &amp;m, int max_val=255, double double_min=0, double double_max=1)" -->
160<div class="memitem">
161<div class="memproto">
162      <table class="memname">
163        <tr>
164          <td class="memname"><a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> itpp::img_int2double           </td>
165          <td>(</td>
166          <td class="paramtype">const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
167          <td class="paramname"> <em>m</em>, </td>
168        </tr>
169        <tr>
170          <td class="paramkey"></td>
171          <td></td>
172          <td class="paramtype">int&nbsp;</td>
173          <td class="paramname"> <em>max_val</em> = <code>255</code>, </td>
174        </tr>
175        <tr>
176          <td class="paramkey"></td>
177          <td></td>
178          <td class="paramtype">double&nbsp;</td>
179          <td class="paramname"> <em>double_min</em> = <code>0</code>, </td>
180        </tr>
181        <tr>
182          <td class="paramkey"></td>
183          <td></td>
184          <td class="paramtype">double&nbsp;</td>
185          <td class="paramname"> <em>double_max</em> = <code>1</code></td><td>&nbsp;</td>
186        </tr>
187        <tr>
188          <td></td>
189          <td>)</td>
190          <td></td><td></td><td></td>
191        </tr>
192      </table>
193</div>
194<div class="memdoc">
195
196<p>
197Return a matrix of double which is a scaled version of the input matrix <em>m</em> of integers.
198<p>
199<dl compact><dt><b>Parameters:</b></dt><dd>
200  <table border="0" cellspacing="2" cellpadding="0">
201    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>The matrix of real. The components are assumed to be between 0 and 1, and will be scaled by factor max_val in the output matrix. </td></tr>
202    <tr><td valign="top"></td><td valign="top"><em>max_val</em>&nbsp;</td><td>The maximum value for the output matrix. This value is usually set to 255. </td></tr>
203    <tr><td valign="top"></td><td valign="top"><em>double_min</em>&nbsp;</td><td>The value on which the integer value 0 will be mapped </td></tr>
204    <tr><td valign="top"></td><td valign="top"><em>double_max</em>&nbsp;</td><td>The value on which the integer value <em>max_val</em> will be mapped </td></tr>
205  </table>
206</dl>
207
208</div>
209</div><p>
210<a class="anchor" name="g20e0ba96ec2cc682950fe640fdc4d2f5"></a><!-- doxytag: member="itpp::pgm_read" ref="g20e0ba96ec2cc682950fe640fdc4d2f5" args="(const std::string &amp;filename)" -->
211<div class="memitem">
212<div class="memproto">
213      <table class="memname">
214        <tr>
215          <td class="memname"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> itpp::pgm_read           </td>
216          <td>(</td>
217          <td class="paramtype">const std::string &amp;&nbsp;</td>
218          <td class="paramname"> <em>filename</em>          </td>
219          <td>&nbsp;)&nbsp;</td>
220          <td></td>
221        </tr>
222      </table>
223</div>
224<div class="memdoc">
225
226<p>
227Read a pgm file of name filename and return the corresponding matrix of integers. Return a void matrix if an error ocurred.
228<p>
229<dl compact><dt><b>Parameters:</b></dt><dd>
230  <table border="0" cellspacing="2" cellpadding="0">
231    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file from which the image is retrieved </td></tr>
232  </table>
233</dl>
234
235</div>
236</div><p>
237<a class="anchor" name="g8adf3a6915adc7566a62c169583b2522"></a><!-- doxytag: member="itpp::pgm_read" ref="g8adf3a6915adc7566a62c169583b2522" args="(const std::string &amp;filename, imat &amp;m, int r1, int r2, int c1, int c2)" -->
238<div class="memitem">
239<div class="memproto">
240      <table class="memname">
241        <tr>
242          <td class="memname">bool itpp::pgm_read           </td>
243          <td>(</td>
244          <td class="paramtype">const std::string &amp;&nbsp;</td>
245          <td class="paramname"> <em>filename</em>, </td>
246        </tr>
247        <tr>
248          <td class="paramkey"></td>
249          <td></td>
250          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
251          <td class="paramname"> <em>m</em>, </td>
252        </tr>
253        <tr>
254          <td class="paramkey"></td>
255          <td></td>
256          <td class="paramtype">int&nbsp;</td>
257          <td class="paramname"> <em>r1</em>, </td>
258        </tr>
259        <tr>
260          <td class="paramkey"></td>
261          <td></td>
262          <td class="paramtype">int&nbsp;</td>
263          <td class="paramname"> <em>r2</em>, </td>
264        </tr>
265        <tr>
266          <td class="paramkey"></td>
267          <td></td>
268          <td class="paramtype">int&nbsp;</td>
269          <td class="paramname"> <em>c1</em>, </td>
270        </tr>
271        <tr>
272          <td class="paramkey"></td>
273          <td></td>
274          <td class="paramtype">int&nbsp;</td>
275          <td class="paramname"> <em>c2</em></td><td>&nbsp;</td>
276        </tr>
277        <tr>
278          <td></td>
279          <td>)</td>
280          <td></td><td></td><td></td>
281        </tr>
282      </table>
283</div>
284<div class="memdoc">
285
286<p>
287Read a part of the graymap into the matrix <em>m</em>.
288<p>
289<dl compact><dt><b>Parameters:</b></dt><dd>
290  <table border="0" cellspacing="2" cellpadding="0">
291    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file from which the image is retrieved </td></tr>
292    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>The matrix in which the image will be stored </td></tr>
293    <tr><td valign="top"></td><td valign="top"><em>r1</em>&nbsp;</td><td>first row to be included in the matrix </td></tr>
294    <tr><td valign="top"></td><td valign="top"><em>r2</em>&nbsp;</td><td>last row to be included in the matrix </td></tr>
295    <tr><td valign="top"></td><td valign="top"><em>c1</em>&nbsp;</td><td>first column to be included in the matrix </td></tr>
296    <tr><td valign="top"></td><td valign="top"><em>c2</em>&nbsp;</td><td>last column to be included in the matrix </td></tr>
297  </table>
298</dl>
299
300</div>
301</div><p>
302<a class="anchor" name="g65dab488c977c8b53d58db35ee94ece6"></a><!-- doxytag: member="itpp::pgm_read" ref="g65dab488c977c8b53d58db35ee94ece6" args="(const std::string &amp;filename, imat &amp;m, std::string &amp;comments)" -->
303<div class="memitem">
304<div class="memproto">
305      <table class="memname">
306        <tr>
307          <td class="memname">bool itpp::pgm_read           </td>
308          <td>(</td>
309          <td class="paramtype">const std::string &amp;&nbsp;</td>
310          <td class="paramname"> <em>filename</em>, </td>
311        </tr>
312        <tr>
313          <td class="paramkey"></td>
314          <td></td>
315          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
316          <td class="paramname"> <em>m</em>, </td>
317        </tr>
318        <tr>
319          <td class="paramkey"></td>
320          <td></td>
321          <td class="paramtype">std::string &amp;&nbsp;</td>
322          <td class="paramname"> <em>comments</em></td><td>&nbsp;</td>
323        </tr>
324        <tr>
325          <td></td>
326          <td>)</td>
327          <td></td><td></td><td></td>
328        </tr>
329      </table>
330</div>
331<div class="memdoc">
332
333<p>
334Read the entire graymap into the matrix <em>m</em> or return false if the function failed.
335<p>
336<dl compact><dt><b>Parameters:</b></dt><dd>
337  <table border="0" cellspacing="2" cellpadding="0">
338    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file from which the image is retrieved </td></tr>
339    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>The matrix in which the image will be stored </td></tr>
340    <tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td>This std::string variable is used to retrieve the comments of the file </td></tr>
341  </table>
342</dl>
343
344</div>
345</div><p>
346<a class="anchor" name="g9389ba285569485b8a23c1ec5fb829fd"></a><!-- doxytag: member="itpp::pgm_write" ref="g9389ba285569485b8a23c1ec5fb829fd" args="(const std::string &amp;filename, const imat &amp;m, const std::string &amp;comments=&quot;Generated by IT++ (http://itpp.sourceforge.net)&quot;)" -->
347<div class="memitem">
348<div class="memproto">
349      <table class="memname">
350        <tr>
351          <td class="memname">bool itpp::pgm_write           </td>
352          <td>(</td>
353          <td class="paramtype">const std::string &amp;&nbsp;</td>
354          <td class="paramname"> <em>filename</em>, </td>
355        </tr>
356        <tr>
357          <td class="paramkey"></td>
358          <td></td>
359          <td class="paramtype">const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
360          <td class="paramname"> <em>m</em>, </td>
361        </tr>
362        <tr>
363          <td class="paramkey"></td>
364          <td></td>
365          <td class="paramtype">const std::string &amp;&nbsp;</td>
366          <td class="paramname"> <em>comments</em> = <code>&quot;Generated&nbsp;by&nbsp;IT++&nbsp;(http://itpp.sourceforge.net)&quot;</code></td><td>&nbsp;</td>
367        </tr>
368        <tr>
369          <td></td>
370          <td>)</td>
371          <td></td><td></td><td></td>
372        </tr>
373      </table>
374</div>
375<div class="memdoc">
376
377<p>
378Create an image file from the matrix of integer.
379<p>
380<dl compact><dt><b>Parameters:</b></dt><dd>
381  <table border="0" cellspacing="2" cellpadding="0">
382    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the image file to create </td></tr>
383    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>The matrix of integer representing the image </td></tr>
384    <tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td>Comments included in the file</td></tr>
385  </table>
386</dl>
387Coefficients greater than 255 and smaller than 0 are clipped.
388</div>
389</div><p>
390<a class="anchor" name="gb9ebea2b2e8d082dd74a2db32c7818c5"></a><!-- doxytag: member="itpp::pnm_info" ref="gb9ebea2b2e8d082dd74a2db32c7818c5" args="(const std::string &amp;filename, char &amp;pnm_type, int &amp;width, int &amp;height, int &amp;max_val, std::string &amp;comments)" -->
391<div class="memitem">
392<div class="memproto">
393      <table class="memname">
394        <tr>
395          <td class="memname">bool itpp::pnm_info           </td>
396          <td>(</td>
397          <td class="paramtype">const std::string &amp;&nbsp;</td>
398          <td class="paramname"> <em>filename</em>, </td>
399        </tr>
400        <tr>
401          <td class="paramkey"></td>
402          <td></td>
403          <td class="paramtype">char &amp;&nbsp;</td>
404          <td class="paramname"> <em>pnm_type</em>, </td>
405        </tr>
406        <tr>
407          <td class="paramkey"></td>
408          <td></td>
409          <td class="paramtype">int &amp;&nbsp;</td>
410          <td class="paramname"> <em>width</em>, </td>
411        </tr>
412        <tr>
413          <td class="paramkey"></td>
414          <td></td>
415          <td class="paramtype">int &amp;&nbsp;</td>
416          <td class="paramname"> <em>height</em>, </td>
417        </tr>
418        <tr>
419          <td class="paramkey"></td>
420          <td></td>
421          <td class="paramtype">int &amp;&nbsp;</td>
422          <td class="paramname"> <em>max_val</em>, </td>
423        </tr>
424        <tr>
425          <td class="paramkey"></td>
426          <td></td>
427          <td class="paramtype">std::string &amp;&nbsp;</td>
428          <td class="paramname"> <em>comments</em></td><td>&nbsp;</td>
429        </tr>
430        <tr>
431          <td></td>
432          <td>)</td>
433          <td></td><td></td><td></td>
434        </tr>
435      </table>
436</div>
437<div class="memdoc">
438
439<p>
440Retrieve some information about an pnm file.
441<p>
442<dl compact><dt><b>Parameters:</b></dt><dd>
443  <table border="0" cellspacing="2" cellpadding="0">
444    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file from which the image is retrieved </td></tr>
445    <tr><td valign="top"></td><td valign="top"><em>pnm_type</em>&nbsp;</td><td>The type of the pnm file (5: pgm file, 6: ppm file) </td></tr>
446    <tr><td valign="top"></td><td valign="top"><em>width</em>&nbsp;</td><td>The image width </td></tr>
447    <tr><td valign="top"></td><td valign="top"><em>height</em>&nbsp;</td><td>The image height </td></tr>
448    <tr><td valign="top"></td><td valign="top"><em>max_val</em>&nbsp;</td><td>The greatest possible value </td></tr>
449    <tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td>The comments in the file </td></tr>
450  </table>
451</dl>
452
453</div>
454</div><p>
455<a class="anchor" name="g22fec1fa9d791759c2c187fc3a9ecc08"></a><!-- doxytag: member="itpp::pnm_type" ref="g22fec1fa9d791759c2c187fc3a9ecc08" args="(const std::string &amp;filename)" -->
456<div class="memitem">
457<div class="memproto">
458      <table class="memname">
459        <tr>
460          <td class="memname">char itpp::pnm_type           </td>
461          <td>(</td>
462          <td class="paramtype">const std::string &amp;&nbsp;</td>
463          <td class="paramname"> <em>filename</em>          </td>
464          <td>&nbsp;)&nbsp;</td>
465          <td></td>
466        </tr>
467      </table>
468</div>
469<div class="memdoc">
470
471<p>
472Determines the type of a PNM file, based on magic numbers. The returned value is a character between '1' and '6'. If an error occured, the returned value is the character '0'.
473<p>
474<dl compact><dt><b>Parameters:</b></dt><dd>
475  <table border="0" cellspacing="2" cellpadding="0">
476    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file from which the image is retrieved </td></tr>
477  </table>
478</dl>
479
480</div>
481</div><p>
482<a class="anchor" name="gbb3c2601f3127e60d60b0dc0c224b19b"></a><!-- doxytag: member="itpp::ppm_read" ref="gbb3c2601f3127e60d60b0dc0c224b19b" args="(const std::string &amp;filename, imat &amp;r, imat &amp;g, imat &amp;b)" -->
483<div class="memitem">
484<div class="memproto">
485      <table class="memname">
486        <tr>
487          <td class="memname">bool itpp::ppm_read           </td>
488          <td>(</td>
489          <td class="paramtype">const std::string &amp;&nbsp;</td>
490          <td class="paramname"> <em>filename</em>, </td>
491        </tr>
492        <tr>
493          <td class="paramkey"></td>
494          <td></td>
495          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
496          <td class="paramname"> <em>r</em>, </td>
497        </tr>
498        <tr>
499          <td class="paramkey"></td>
500          <td></td>
501          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
502          <td class="paramname"> <em>g</em>, </td>
503        </tr>
504        <tr>
505          <td class="paramkey"></td>
506          <td></td>
507          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
508          <td class="paramname"> <em>b</em></td><td>&nbsp;</td>
509        </tr>
510        <tr>
511          <td></td>
512          <td>)</td>
513          <td></td><td></td><td></td>
514        </tr>
515      </table>
516</div>
517<div class="memdoc">
518
519<p>
520Read the color image file in the PPM format.
521<p>
522<dl compact><dt><b>Parameters:</b></dt><dd>
523  <table border="0" cellspacing="2" cellpadding="0">
524    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file to be read </td></tr>
525    <tr><td valign="top"></td><td valign="top"><em>r</em>&nbsp;</td><td>the red component of the image </td></tr>
526    <tr><td valign="top"></td><td valign="top"><em>g</em>&nbsp;</td><td>the green component of the image </td></tr>
527    <tr><td valign="top"></td><td valign="top"><em>b</em>&nbsp;</td><td>the blue component of the image </td></tr>
528  </table>
529</dl>
530
531</div>
532</div><p>
533<a class="anchor" name="gd58303e8848711edb7bf14aa2eaa1397"></a><!-- doxytag: member="itpp::ppm_read" ref="gd58303e8848711edb7bf14aa2eaa1397" args="(const std::string &amp;filename, imat &amp;r, imat &amp;g, imat &amp;b, std::string &amp;comments)" -->
534<div class="memitem">
535<div class="memproto">
536      <table class="memname">
537        <tr>
538          <td class="memname">bool itpp::ppm_read           </td>
539          <td>(</td>
540          <td class="paramtype">const std::string &amp;&nbsp;</td>
541          <td class="paramname"> <em>filename</em>, </td>
542        </tr>
543        <tr>
544          <td class="paramkey"></td>
545          <td></td>
546          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
547          <td class="paramname"> <em>r</em>, </td>
548        </tr>
549        <tr>
550          <td class="paramkey"></td>
551          <td></td>
552          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
553          <td class="paramname"> <em>g</em>, </td>
554        </tr>
555        <tr>
556          <td class="paramkey"></td>
557          <td></td>
558          <td class="paramtype"><a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
559          <td class="paramname"> <em>b</em>, </td>
560        </tr>
561        <tr>
562          <td class="paramkey"></td>
563          <td></td>
564          <td class="paramtype">std::string &amp;&nbsp;</td>
565          <td class="paramname"> <em>comments</em></td><td>&nbsp;</td>
566        </tr>
567        <tr>
568          <td></td>
569          <td>)</td>
570          <td></td><td></td><td></td>
571        </tr>
572      </table>
573</div>
574<div class="memdoc">
575
576<p>
577Read the color image file in the format ppm. The image is retrieved as a set of three matrices, each of whom is a plan of RGB component.
578<p>
579<dl compact><dt><b>Parameters:</b></dt><dd>
580  <table border="0" cellspacing="2" cellpadding="0">
581    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file to be read </td></tr>
582    <tr><td valign="top"></td><td valign="top"><em>r</em>&nbsp;</td><td>the red component of the image </td></tr>
583    <tr><td valign="top"></td><td valign="top"><em>g</em>&nbsp;</td><td>the green component of the image </td></tr>
584    <tr><td valign="top"></td><td valign="top"><em>b</em>&nbsp;</td><td>the blue component of the image </td></tr>
585    <tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td>a string variable to retrieve the comments contained in the file header. </td></tr>
586  </table>
587</dl>
588
589</div>
590</div><p>
591<a class="anchor" name="g9141ce9dacd0149ec89fa1977e13a206"></a><!-- doxytag: member="itpp::ppm_write" ref="g9141ce9dacd0149ec89fa1977e13a206" args="(const std::string &amp;filename, const imat &amp;r, const imat &amp;g, const imat &amp;b, const std::string &amp;comments=&quot;Generated by IT++ (http://itpp.sourceforge.net)&quot;, int max_val=255)" -->
592<div class="memitem">
593<div class="memproto">
594      <table class="memname">
595        <tr>
596          <td class="memname">bool itpp::ppm_write           </td>
597          <td>(</td>
598          <td class="paramtype">const std::string &amp;&nbsp;</td>
599          <td class="paramname"> <em>filename</em>, </td>
600        </tr>
601        <tr>
602          <td class="paramkey"></td>
603          <td></td>
604          <td class="paramtype">const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
605          <td class="paramname"> <em>r</em>, </td>
606        </tr>
607        <tr>
608          <td class="paramkey"></td>
609          <td></td>
610          <td class="paramtype">const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
611          <td class="paramname"> <em>g</em>, </td>
612        </tr>
613        <tr>
614          <td class="paramkey"></td>
615          <td></td>
616          <td class="paramtype">const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;&nbsp;</td>
617          <td class="paramname"> <em>b</em>, </td>
618        </tr>
619        <tr>
620          <td class="paramkey"></td>
621          <td></td>
622          <td class="paramtype">const std::string &amp;&nbsp;</td>
623          <td class="paramname"> <em>comments</em> = <code>&quot;Generated&nbsp;by&nbsp;IT++&nbsp;(http://itpp.sourceforge.net)&quot;</code>, </td>
624        </tr>
625        <tr>
626          <td class="paramkey"></td>
627          <td></td>
628          <td class="paramtype">int&nbsp;</td>
629          <td class="paramname"> <em>max_val</em> = <code>255</code></td><td>&nbsp;</td>
630        </tr>
631        <tr>
632          <td></td>
633          <td>)</td>
634          <td></td><td></td><td></td>
635        </tr>
636      </table>
637</div>
638<div class="memdoc">
639
640<p>
641Write the matrix <em>m</em> as a pixmap.
642<p>
643<dl compact><dt><b>Parameters:</b></dt><dd>
644  <table border="0" cellspacing="2" cellpadding="0">
645    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The name of the file to create </td></tr>
646    <tr><td valign="top"></td><td valign="top"><em>r</em>&nbsp;</td><td>the red component of the image </td></tr>
647    <tr><td valign="top"></td><td valign="top"><em>g</em>&nbsp;</td><td>the green component of the image </td></tr>
648    <tr><td valign="top"></td><td valign="top"><em>b</em>&nbsp;</td><td>the blue component of the image </td></tr>
649    <tr><td valign="top"></td><td valign="top"><em>comments</em>&nbsp;</td><td>a comment that will be inserted in the image file </td></tr>
650    <tr><td valign="top"></td><td valign="top"><em>max_val</em>&nbsp;</td><td>The maximum value of a component. This quantity should be lower than 255 (raw type). </td></tr>
651  </table>
652</dl>
653
654</div>
655</div><p>
656</div>
657<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:14 2009 for mixpp by&nbsp;
658<a href="http://www.doxygen.org/index.html">
659<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
660</body>
661</html>
Note: See TracBrowser for help on using the browser.