namespacecimg__library_1_1cimg.html

this a image processing program

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a rounded number. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;typename t&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacecimg__library_1_1cimg.html#9bd2a1e3ffff4538c4f53856e8b28ded">dialog</a> (const char *title, const char *msg, const char *button1_txt, const char *button2_txt, const char *button3_txt, const char *button4_txt, const char *button5_txt, const char *button6_txt, const <a class="el" href="structcimg__library_1_1_c_img.html">CImg</a>&lt; t &gt; &amp;logo, const bool centering=false)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Display a dialog box, where a user can click standard buttons.  <a href="#9bd2a1e3ffff4538c4f53856e8b28ded"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="952eac791b596a61bba0a133a3bb439f"></a><!-- doxytag: member="cimg_library::cimg::PI" ref="952eac791b596a61bba0a133a3bb439f" args="" -->
const double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecimg__library_1_1cimg.html#952eac791b596a61bba0a133a3bb439f">PI</a> = 3.14159265358979323846</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Definition of the mathematical constant PI. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Namespace that encompasses <em>low-level</em> functions and variables of the CImg Library. 
<p>
Most of the functions and variables within this namespace are used by the library for low-level processing. Nevertheless, documented variables and functions of this namespace may be used safely in your own source code.<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>Never write <code>using namespace <a class="el" href="namespacecimg__library_1_1cimg.html">cimg_library::cimg</a>;</code> in your source code, since a lot of functions of the <code>cimg::</code> namespace have prototypes similar to standard C functions defined in the global namespace <code>::</code>. </dd></dl>

<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="c1b66fe77173de9e5e8542b2823d6071"></a><!-- doxytag: member="cimg_library::cimg::info" ref="c1b66fe77173de9e5e8542b2823d6071" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void info           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Print informations about CImg environement variables. 
<p>
Printing is done on the standart error output. 
</div>
</div><p>
<a class="anchor" name="66b97c48fa2e598dd3818152cca7e4f0"></a><!-- doxytag: member="cimg_library::cimg::imagemagick_path" ref="66b97c48fa2e598dd3818152cca7e4f0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* cimg_library::cimg::imagemagick_path           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return path of the ImageMagick's <code>convert</code> tool. 
<p>
If you have installed the <a href="http://www.imagemagick.org">ImageMagick package</a> in a standard directory, this function should return the correct path of the <code>convert</code> tool used by the CImg Library to load and save compressed image formats. Conversely, if the <code>convert</code> executable is not auto-detected by the function, you can define the macro <code>cimg_imagemagick_path</code> with the correct path of the <code>convert</code> executable, before including <code>CImg.h</code> in your program : <div class="fragment"><pre class="fragment"><span class="preprocessor">       #define cimg_imagemagick_path "/users/thatsme/local/bin/convert"</span>
<span class="preprocessor"></span><span class="preprocessor">       #include "CImg.h"</span>

       <span class="keywordtype">int</span> main() {
         CImg&lt;&gt; img(<span class="stringliteral">"my_image.jpg"</span>);     <span class="comment">// Read a JPEG image file.</span>
         <span class="keywordflow">return</span> 0;
       }
</pre></div><p>
Note that non compressed image formats can be read without installing ImageMagick.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="namespacecimg__library_1_1cimg.html#411c598d6a44291415a1e2299d2c39b1">temporary_path()</a>, get_load_imagemagick(), load_imagemagick(), save_imagemagick(). </dd></dl>

</div>
</div><p>
<a class="anchor" name="427f31124296fa11e951bb2536e4e88b"></a><!-- doxytag: member="cimg_library::cimg::graphicsmagick_path" ref="427f31124296fa11e951bb2536e4e88b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* cimg_library::cimg::graphicsmagick_path           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return path of the GraphicsMagick's <code>gm</code> tool. 
<p>
If you have installed the <a href="http://www.graphicsmagick.org">GraphicsMagick package</a> in a standard directory, this function should return the correct path of the <code>gm</code> tool used by the CImg Library to load and save compressed image formats. Conversely, if the <code>gm</code> executable is not auto-detected by the function, you can define the macro <code>cimg_graphicsmagick_path</code> with the correct path of the <code>gm</code> executable, before including <code>CImg.h</code> in your program : <div class="fragment"><pre class="fragment"><span class="preprocessor">       #define cimg_graphicsmagick_path "/users/thatsme/local/bin/gm"</span>
<span class="preprocessor"></span><span class="preprocessor">       #include "CImg.h"</span>

       <span class="keywordtype">int</span> main() {
         CImg&lt;&gt; img(<span class="stringliteral">"my_image.jpg"</span>);     <span class="comment">// Read a JPEG image file.</span>
         <span class="keywordflow">return</span> 0;
       }
</pre></div><p>
Note that non compressed image formats can be read without installing ImageMagick.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="namespacecimg__library_1_1cimg.html#411c598d6a44291415a1e2299d2c39b1">temporary_path()</a>, get_load_imagemagick(), load_imagemagick(), save_imagemagick(). </dd></dl>

</div>
</div><p>
<a class="anchor" name="9ab62b36cd320543e0b0ab830252cb10"></a><!-- doxytag: member="cimg_library::cimg::medcon_path" ref="9ab62b36cd320543e0b0ab830252cb10" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* cimg_library::cimg::medcon_path           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return path of the <code>XMedcon</code> tool. 
<p>
If you have installed the <a href="http://xmedcon.sourceforge.net/">XMedcon package</a> in a standard directory, this function should return the correct path of the <code>medcon</code> tool used by the CIg Library to load DICOM image formats. Conversely, if the <code>medcon</code> executable is not auto-detected by the function, you can define the macro <code>cimg_medcon_path</code> with the correct path of the <code>medcon</code> executable, before including <code>CImg.h</code> in your program : <div class="fragment"><pre class="fragment"><span class="preprocessor">       #define cimg_medcon_path "/users/thatsme/local/bin/medcon"</span>
<span class="preprocessor"></span><span class="preprocessor">       #include "CImg.h"</span>

       <span class="keywordtype">int</span> main() {
         CImg&lt;&gt; img(<span class="stringliteral">"my_image.dcm"</span>);    <span class="comment">// Read a DICOM image file.</span>
         <span class="keywordflow">return</span> 0;
       }
</pre></div><p>
Note that <code>medcon</code> is only needed if you want to read DICOM image formats.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="namespacecimg__library_1_1cimg.html#411c598d6a44291415a1e2299d2c39b1">temporary_path()</a>, get_load_dicom(), load_dicom(). </dd></dl>

</div>
</div><p>
<a class="anchor" name="411c598d6a44291415a1e2299d2c39b1"></a><!-- doxytag: member="cimg_library::cimg::temporary_path" ref="411c598d6a44291415a1e2299d2c39b1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* cimg_library::cimg::temporary_path           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return path to store temporary files. 
<p>
If you are running on a standard Unix or Windows system, this function should return a correct path where temporary files can be stored. If such a path is not auto-detected by this function, you can define the macro <code>cimg_temporary_path</code> with a correct path, before including <code>CImg.h</code> in your program : <div class="fragment"><pre class="fragment"><span class="preprocessor">       #define cimg_temporary_path "/users/thatsme/tmp"</span>
<span class="preprocessor"></span><span class="preprocessor">       #include "CImg.h"</span>

       <span class="keywordtype">int</span> main() {
         CImg&lt;&gt; img(<span class="stringliteral">"my_image.jpg"</span>);   <span class="comment">// Read a JPEG image file (using the defined temporay path).</span>
         <span class="keywordflow">return</span> 0;
       }
</pre></div><p>
A temporary path is necessary to load and save compressed image formats, using <code>convert</code> or <code>medcon</code>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="namespacecimg__library_1_1cimg.html#66b97c48fa2e598dd3818152cca7e4f0">imagemagick_path()</a>, get_load_imagemagick(), load_imagemagick(), save_imagemagick(), get_load_dicom(), load_dicom(). </dd></dl>

</div>
</div><p>
<a class="anchor" name="3ac7655e49556a90715f3532af221334"></a><!-- doxytag: member="cimg_library::cimg::sleep" ref="3ac7655e49556a90715f3532af221334" args="(const unsigned int milliseconds)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cimg_library::cimg::sleep           </td>
          <td>(</td>
          <td class="paramtype">const unsigned int&nbsp;</td>
          <td class="paramname"> <em>milliseconds</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sleep for a certain numbers of milliseconds. 
<p>
This function frees the CPU ressources during the sleeping time. It may be used to temporize your program properly, without wasting CPU time. <dl class="see" compact><dt><b>See also:</b></dt><dd>wait(), <a class="el" href="namespacecimg__library_1_1cimg.html#f883131bbc64e996d212114cc2b2b21a">time()</a>. </dd></dl>

</div>
</div><p>
<a class="anchor" name="3c8917c0f12139bff6de6e3e45fc5b77"></a><!-- doxytag: member="cimg_library::cimg::wait" ref="3c8917c0f12139bff6de6e3e45fc5b77" args="(const unsigned int milliseconds)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int cimg_library::cimg::wait           </td>
          <td>(</td>
          <td class="paramtype">const unsigned int&nbsp;</td>
          <td class="paramname"> <em>milliseconds</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>