Wed, 05 Aug 2009 17:10:56 +0100
add README
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <!--#include file="header.html" -->
5 <table align="center" border="0" cellpadding="20" cellspacing="0" width="100%"><tbody><tr><td>
6 <font face="Arial,Helvetica" size="-1">
8 <img src="img/item_intro.gif" alt="Introduction">
9 <p>
10 The CImg Library is an <b>open source C++ toolkit for image processing</b> designed with these properties in mind :
12 <table border="0" width="100%" cellspacing="16">
13 <tr><td><img src="img/item_usefulness.jpg" alt="Usefulness"></td>
14 <td><hr noshade="noshade" size="1" width="100%"></hr>
15 CImg defines simple <i>classes</i> and <i>methods</i>
16 aimed at manipulating generic images in your own C++ code : Load/save various file formats, access pixel values,
17 display, resize/rotate/mirror/filter, draw primitives (text, faces, curves, 3D objects, ...), compute statistics,
18 manage user interactions, and so on...
19 </td></tr>
20 <tr><td><img src="img/item_genericity.jpg" alt="Genericity"></td>
21 <td><hr noshade="noshade" size="1" width="100%"></hr>
22 Provided image classes can represent datasets up to
23 <i>4-dimension wide</i> (from 1D scalar signals to 3D hyperspectral volumes), with template pixel types.
24 Image <i>collections</i> and <i>sequences</i> are also supported.
25 </td></tr>
26 <tr><td><img src="img/item_portability.jpg" alt="Portability"></td>
27 <td><hr noshade="noshade" size="1" width="100%"></hr>
28 CImg is <i>self-contained</i> and thus <i>highly portable</i>. It fully works on
29 <i>different operating systems</i> (Unix, Windows, MacOS X, *BSD) with <i>various C++ compilers</i>
30 (Visual C++, GNU g++, Intel icc, Borland bcc, ...).
31 </td></tr>
32 <tr><td><img src="img/item_simplicity.jpg" alt="Simplicity"></td>
33 <td><hr noshade="noshade" size="1" width="100%"></hr>
34 CImg is <i>lightweight</i>. It is made of a single header file
35 <i><a href="http://cimg.cvs.sourceforge.net/cimg/CImg/CImg.h?view=markup"><b>CImg.h</b></a></i>
36 that must be included in your C++ source. It defines only <i>four</i> different classes.
37 It can be compiled using a minimal set of standard C++ and system libraries.
38 <i>No need for exotic or complex dependencies</i>.
39 </td></tr>
40 <tr><td><img src="img/item_extensibility.jpg" alt="Extensibility"></td>
41 <td><hr noshade="noshade" size="1" width="100%"></hr>
42 Although not required, CImg can use functionalities of external tools/libraries such as
43 <a href="http://www.imagemagick.org/">ImageMagick</a>,
44 <a href="http://www.graphicsmagick.org/">GraphicsMagick</a>,
45 <a href="http://xmedcon.sourceforge.net/">XMedCon</a>,
46 <a href="http://ffmpeg.mplayerhq.hu/">FFMPEG</a>,
47 <a href="http://www.libpng.org/pub/png/libpng.html">libpng</a>,
48 <a href="http://www.ijg.org/">libjpeg</a>,
49 <a href="http://www.libtiff.org/">libtiff</a>,
50 <a href="http://www.imagemagick.org/Magick++/">Magick++</a>,
51 <a href="http://www.netlib.org/lapack/">Lapack</a>,
52 <a href="http://libboard.sourceforge.net/">Board</a>
53 or
54 <a href="http://www.fftw.org/">FFTW3</a>.
55 Moreover, a simple <i>plug-in</i> mechanism allows any user to directly enhance the library
56 capabilities according to his needs.
57 </td></tr>
58 <tr><td><img src="img/item_freedom.jpg" alt="Freedom"></td>
59 <td><hr noshade="noshade" size="1" width="100%"></hr>
60 CImg is a <i>free, open-source library</i> distributed under the
61 <a href="http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt"><i>CeCILL-C</i></a> (close to the GNU LGPL)
62 or
63 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt"><i>CeCILL</i></a> (compatible with the GNU GPL)
64 licenses</i></a>. It can be used in commercial applications.
65 </td></tr>
66 </table>
67 </p>
69 <blockquote>
70 <b>CImg</b> stands for <b><i>"Cool Image"</i></b> : It is <b>easy to use</b> and <b>efficient</b>.
71 It's a very pleasant toolbox to code image processing stuffs in C++, and potentially covers a wide range of image processing applications.
72 In the distributed package, a <a href="screenshots.shtml">lot of examples</a> are provided to help the developper in its first steps.<br/>
73 </blockquote>
75 <br/><img src="img/item_authors.jpg" alt="Authors">
76 <blockquote>
77 <a href="http://www.greyc.ensicaen.fr/~dtschump/">David Tschumperlé</a> (project leader), with the help of
78 various contributors :
79 <i>
80 Haz-Edine Assemlal,
81 Vincent Barra,
82 Romain Blei,
83 Yohan Bentolila,
84 Jerome Boulanger,
85 Frederic Devernay,
86 François-Xavier Dupé,
87 Eric Fausett,
88 Jean-Marie Favreau,
89 Sebastien Fourey,
90 Alexandre Fournier,
91 Vincent Garcia,
92 Jinwei Gu,
93 Jean-Daniel Guyot,
94 Matt Hanson,
95 Sebastien Hanel,
96 Christoph Hormann,
97 Werner Jainek,
98 Daniel Kondermann,
99 Pierre Kornprobst,
100 Orges Leka,
101 Francois Lauze,
102 Xie Long,
103 Thomas Martin,
104 Cesar Martinez,
105 Jean Martinot,
106 Nikita Melnichenko,
107 Baptiste Mougel,
108 Renaud Peteri,
109 Martin Petricek,
110 Paolo Prete,
111 Adrien Reboisson,
112 Klaus Schneider,
113 Konstantin Spirin,
114 Rainer Steffens,
115 David G. Starkweather,
116 Grzegorz Szwoch,
117 Thierry Thomas,
118 Yu-En-Yun,
119 Vo Duc Khanh,
120 Phillip Wood,
121 Bug Zhao,
122 Haibo Zheng.
123 </i>
124 </blockquote>
126 <br/><img src="img/item_licenses.jpg" alt="Licenses">
127 <blockquote>
128 The CImg Library is an open-source product distributed under <b>two distinct licenses</b> :
129 the library core itself is dual-licensed and
130 can be governed either by the
131 <a href="http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.txt"><b>CeCILL-C</b> License</a> (LGPL-like),
132 or the
133 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt"><b>CeCILL</b> License</a> (GPL-compatible).
134 Most of the other package files are distributed under the
135 <a href="http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt"><b>CeCILL</b> License</a>.
136 Both are <b>open source licenses</b>, the CeCILL-C being less restrictive than the CeCILL one.
137 The CImg Library source code has been registered to the <a href="http://app.legalis.net/paris/">APP</a>
138 (French Agency for the Protection of Programs) by the <a href="http://www.inria.fr/index.en.html">INRIA</a>,
139 under registration number <i>IDDN.FR.001.040004.000.S.P.2004.000.21000.</i>
140 </blockquote>
142 <br/><img src="img/item_learnmore.jpg" alt="Learn More">
143 <ul>
144 <li>The <a href="screenshots.shtml">Screenshots</a> section illustrates some of the different source code examples provided in
145 the CImg package.</li>
146 <li>The <a href="reference/group__cimg__tutorial.html">Tutorial</a> section shows the basic use of CImg classes
147 and functions with a small first code.</li>
148 <li>You can look at the quite complete <a href="CImg_slides.pdf">CImg Library presentation slides</a> (.pdf format) which gives
149 more insights on the different library concepts.</li>
150 <li>Online web statistics on the CImg website activity are available
151 <a href="http://my.statcounter.com/project/standard/stats.php?project_id=895001&guest=1">here</a> and
152 <a href="http://sourceforge.net/project/stats/?group_id=96492&ugn=cimg">here</a>.</li>
153 </ul>
155 <br/><img src="img/item_quickhistory.jpg" alt="Quick History">
156 <blockquote>
157 The development of the CImg Library began at the end of 1999, when I started my PhD thesis
158 in the <a href="http://www-sop.inria.fr/odyssee"><img border="0" height="16" alt="" src="img/logoODYSSEE.jpg"></img> Lab</a>
159 at the <a href="http://www-sop.inria.fr/"><img border="0" height="16" alt="" src="img/logoINRIA.gif"></img> Sophia Antipolis</a>.
160 It was designed to help me and my colleagues developing various image processing algorithms,
161 for datasets as simple as 2D scalar images, or as complex as 3D volumes of diffusion tensors. I also used it for
162 courses on image processing I teached at the university. That's why the CImg library
163 has been always intended to be <i>compact</i>, <i>easy to use</i>, <i>multi-platform</i> and <i>generic</i>.
164 It provides a lot of basic functions that one would like to see in an image
165 processing framework for C++ programming.
166 I am now a permanent researcher of the <a href="http://www.cnrs.fr"><img border="0" alt="" height="32" src="img/logoCNRS.gif"></img>
167 institution</a>,
168 working in the <a href="http://www.greyc.ensicaen.fr/EquipeImage"><img border="0" alt="" height="32" src="img/logoIMAGE.gif"></img>
169 group</a> at the <a href="http://www.greyc.ensicaen.fr"><img border="0" alt="" height="32" src="img/logoGREYC.gif"></img>
170 GREYC lab</a> in Caen/France.
171 I am still using, maintaining and updating the CImg Library, and will probably do it for the next couple of years.
172 </blockquote>
174 <br/><img src="img/item_howtohelp.jpg" alt="How to Help ?">
175 <blockquote>
176 The CImg Library is an open source C++ library which is mainly developped during
177 free time. If you enjoy using CImg, you may contribute to the project
178 in different ways. This will motivate me to continue the work.
179 <ul>
180 <li>You can help CImg to be more widely known, by displaying a
181 <a href="CImg_flyer.pdf">CImg Flyer</a> at work, in your lab or school
182 (available in <a href="CImg_flyer.pdf">.PDF</a> or <a href="img/CImg_flyer.jpg">.JPEG</a> formats).
183 <li>You can report bugs, propose patches or new functionalities, using the CImg
184 <a href="http://sourceforge.net/forum/?group_id=96492">forums</a> or
185 <a href="http://sourceforge.net/tracker/?group_id=96492">trackers</a>.</li>
186 <li>You can write
187 <a href="reference/group__cimg__tutorial.html">tutorials</a>
188 or parts of the <a href="reference/index.html">documentation</a>.</li>
189 <li>If you just want to say you've been happy with the library, you can send me a postcard from your place, to the following address : <br/>
190 <i>David Tschumperlé, GREYC (UMR CNRS 6072), Equipe IMAGE, 6 Bd du Maréchal Juin, 14050 Caen Cedex, FRANCE.</i><br/><br/>
191 10 postcards received yet (I still have empty space on my wall ! :) ), from :<br/><br/>
192 <ul>
193 <li><a href="img/postcard1.jpg" onclick="NewWindow(this.href,'name','420','320','yes');return false;">
194 Comissao Nacional de Energia Nuclear, Rio de Janeiro, Brazil.</a></li>
195 <li><a href="img/postcard2.jpg" onclick="NewWindow(this.href,'name','420','320','yes');return false;">
196 Universidad Nacional del Litoral, Santa Fe, Argentina.</a></li>
197 <li><a href="img/postcard3.jpg" onclick="NewWindow(this.href,'name','420','320','yes');return false;">
198 Waikiki's only true resort, Honolulu/Hawaii.</a></li>
199 <li><a href="img/postcard4.jpg" onclick="NewWindow(this.href,'name','420','320','yes');return false;">
200 Royal Pavilion, Brighton/UK.</a></li>
201 <li><a href="img/postcard5.jpg" onclick="NewWindow(this.href,'name','320','420','yes');return false;">
202 Cambridge, UK.</a></li>
203 <li><a href="img/postcard6.jpg" onclick="NewWindow(this.href,'name','420','320','yes');return false;">
204 National Tai-Chung Institute of Technology, Taiwan.</a></li>
205 <li><a href="img/postcard7.jpg" onclick="NewWindow(this.href,'name','420','320','yes');return false;">
206 Fuzzy Logic Laboratorium Linz-Hagenberg, Linz, Austria.</a></li>
207 <li><a href="img/postcard8.jpg" onclick="NewWindow(this.href,'name','500','450','yes');return false;">
208 Corte/Corsica.</a></li>
209 <li><a href="img/postcard9.jpg" onclick="NewWindow(this.href,'name','400','600','yes');return false;">
210 Microsoft Research, Beijing/China.</a></li>
211 <li><a href="img/postcard10.jpg" onclick="NewWindow(this.href,'name','700','500','yes');return false;">
212 Palermo/Italia.</a></li>
213 </ul><br/>
214 <li>If you are rich, you can also <a href="http://sourceforge.net/donate/index.php?group_id=96492">
215 <img src="img/project-support.jpg" alt=""></img></a></li>
216 </ul>
217 </blockquote>
219 <br/><img src="img/item_copyrights.jpg" alt="Copyrights">
220 <blockquote>
221 <font size="-2">
222 Copyrights (C) From october 2004, David Tschumperlé - GREYC UMR CNRS 6072, Image group.<br/>
223 Copyrights (C) January->September 2004, David Tschumperlé.<br/>
224 Copyrights (C) 2000->2003, David Tschumperlé - INRIA Sophia-Antipolis. Odyssée group.<br/>
225 </font>
226 </blockquote>
228 </font></td></tr></tbody></table>
230 <!--#include file="footer.html" -->