root/doc/html/pnm_8h.html @ 353

Revision 353, 12.3 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: pnm.h File Reference</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 class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>pnm.h File Reference</h1>Definitions of PNM graphics format I/O function. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;<a class="el" href="mat_8h-source.html">itpp/base/mat.h</a>&gt;</code><br>
71
72<p>
73<a href="pnm_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
74<tr><td></td></tr>
75<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
76<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>
77
78<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="group__image.html#g22fec1fa9d791759c2c187fc3a9ecc08"></a><br></td></tr>
79<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>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve some information about an pnm file.  <a href="group__image.html#gb9ebea2b2e8d082dd74a2db32c7818c5"></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#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>
83
84<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="group__image.html#g65dab488c977c8b53d58db35ee94ece6"></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#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>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read a part of the graymap into the matrix <em>m</em>.  <a href="group__image.html#g8adf3a6915adc7566a62c169583b2522"></a><br></td></tr>
88<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>
89
90<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="group__image.html#g20e0ba96ec2cc682950fe640fdc4d2f5"></a><br></td></tr>
91<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>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an image file from the matrix of integer.  <a href="group__image.html#g9389ba285569485b8a23c1ec5fb829fd"></a><br></td></tr>
94<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>
95
96<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="group__image.html#gd58303e8848711edb7bf14aa2eaa1397"></a><br></td></tr>
97<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>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Read the color image file in the PPM format.  <a href="group__image.html#gbb3c2601f3127e60d60b0dc0c224b19b"></a><br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1e74677f86754640c72b49669c6480ea"></a><!-- doxytag: member="pnm.h::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)" -->
101bool&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>
102
103<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>
104<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>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write the matrix <em>m</em> as a pixmap.  <a href="group__image.html#g9141ce9dacd0149ec89fa1977e13a206"></a><br></td></tr>
107<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>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prepare a matrix of double to be writted as an image.  <a href="group__image.html#g8ac0e04623245c7edc308b76708b8f7b"></a><br></td></tr>
110<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>
111
112<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="group__image.html#ga9d05f853b61b2d90323355b40362ed1"></a><br></td></tr>
113</table>
114<hr><a name="_details"></a><h2>Detailed Description</h2>
115Definitions of PNM graphics format I/O function.
116<p>
117<dl class="author" compact><dt><b>Author:</b></dt><dd></dd></dl>
118-------------------------------------------------------------------------<p>
119Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
120This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
121IT++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<p>
122IT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
123You should have received a copy of the GNU General Public License along with IT++. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.<p>
124------------------------------------------------------------------------- </div>
125<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:14 2009 for mixpp by&nbsp;
126<a href="http://www.doxygen.org/index.html">
127<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
128</body>
129</html>
Note: See TracBrowser for help on using the browser.