Mon, 03 Aug 2009 23:41:04 +0100
added dep/*.d and obj/*.o to hgignore
1 --------------------------------------------------------------------------------
2 --------------------------------------------------------------------------------
3 ____ _ _ ____
4 (_ _)( )_( )( ___)
5 )( ) _ ( )__)
6 (__) (_) (_)(____)
7 ___ ____ __ __ ___ __ ____ ____ ____ __ ____ _ _
8 / __)(_ _)( \/ )/ __) ( ) (_ _)( _ \( _ \ /__\ ( _ \( \/ )
9 ( (__ _)(_ ) (( (_-. )(__ _)(_ ) _ < ) / /(__)\ ) / \ /
10 \___)(____)(_/\/\_)\___/ (____)(____)(____/(_)\_)(__)(__)(_)\_) (__)
13 C++ Template Image Processing Library
15 ( http://cimg.sourceforge.net )
17 v.1.3.0
19 --------------------------------------------------------------------------------
21 # Summary
22 #---------
24 The CImg Library is an open-source C++ toolkit for image processing.
25 It consists in a single header file 'CImg.h' providing a minimal set of C++
26 classes and methods that can be used in your own sources, to load/save,
27 process and display images. Very portable (Unix/X11,Windows, MacOS X, FreeBSD, .. ),
28 efficient, easy to use, it's a pleasant library for developping image processing
29 algorithms in C++.
31 # Authors and contributors :
32 #----------------------------
34 - David Tschumperle (project manager) ( http://www.greyc.ensicaen.fr/~dtschump/ )
36 - Haz-Edine Assemlal
37 - Vincent Barra
38 - Romain Blei
39 - Yohan Bentolila
40 - Jerome Boulanger
41 - Frederic Devernay
42 - Francois-Xavier Dupe
43 - Eric Fausett
44 - Jean-Marie Favreau
45 - Sebastien Fourey
46 - Alexandre Fournier
47 - Vincent Garcia
48 - Jinwei Gu
49 - Jean-Daniel Guyot
50 - Matt Hanson
51 - Sebastien Hanel
52 - Christoph Hormann
53 - Werner Jainek
54 - Daniel Kondermann
55 - Pierre Kornprobst
56 - Orges Leka
57 - Francois Lauze
58 - Xie Long
59 - Thomas Martin
60 - Cesar Martinez
61 - Jean Martinot
62 - Nikita Melnichenko
63 - Baptiste Mougel
64 - Renaud Peteri
65 - Martin Petricek
66 - Paolo Prete
67 - Adrien Reboisson
68 - Klaus Schneider
69 - Konstantin Spirin
70 - David G. Starkweather
71 - Rainer Steffens
72 - Grzegorz Szwoch
73 - Thierry Thomas
74 - Yu-En-Yun
75 - Vo Duc Khanh
76 - Phillip Wood
77 - Bug Zhao
78 - Haibo Zheng
80 # Institution
81 #-------------
83 GREYC Image / CNRS UMR 6072 / FRANCE
85 The CImg Library project started in 2000, at the INRIA-Sophia
86 Antipolis/France ( http://www-sop.inria.fr/ ), in the ROBOTVIS / ODYSSEE Team.
87 Since October 2004, it is maintained and developed in the Image team of
88 the GREYC Lab (CNRS, UMR 6072), in Caen/France.
89 Team web page : http://www.greyc.ensicaen.fr/EquipeImage/
91 # Licenses
92 #----------
94 The source code of the CImg Library is distributed under
95 two distinct licenses :
97 - The main library file 'CImg.h' is *dual-licensed* :
98 It can be either distributed under the CeCILL-C or CeCILL license.
99 (see files 'Licence_CeCILL-C_V1-en.txt' and 'Licence_CeCILL_V2-en.txt').
100 Both are Free-Software licenses :
102 * CeCILL-C is adapted to the distribution of
103 library components, and is close in its terms to the well known GNU LGPL license
104 (the 'CImg.h' file can thus be used in closed-source products under certain
105 conditions, please read carefully the license file).
107 * CeCILL is close to (and even compatible with) the GNU GPL license.
109 - Most of the other files are distributed under the CeCiLL license
110 (file 'Licence_CeCILL_V2-en.txt'). See the file header to see what license applies.
112 These two CeCiLL licenses ( http://www.cecill.info/index.en.html ) have been
113 created under the supervision of the three biggest research institutions on
114 computer sciences in France :
116 - CNRS ( http://www.cnrs.fr/ )
117 - CEA ( http://www.cea.fr/ )
118 - INRIA ( http://www.inria.fr/ )
120 You have to RESPECT these licenses. More particularly, please carefully read
121 the license terms before using the CImg library in commercial products.
123 # Package structure :
124 #--------------------
126 The main package directory CImg/ is organized as follows :
128 - README.txt : This file.
129 - CHANGES.txt : A list of changes between consecutive CImg versions.
130 - Licence_CeCILL-C_V1-en.txt : A copy of the CeCiLL-C license file.
131 - Licence_CeCILL_V2-en.txt : A copy of the CeCiLL license.
132 - CImg.h : The single header file that constitutes the library itself.
133 - examples/ : A directory containing lot of example programs performing
134 various things, based on the CImg library.
135 - html/ : A directory containing a copy of the CImg web page in html
136 format. The reference documentation is generated
137 automatically with the tool 'doxygen' (http://www.doxygen.org).
138 - resources/ : A directory containing some resources files for compiling
139 CImg examples or packages with various C++ compilers and OS.
140 - plugins/ : A directory containing CImg plug-ins files that can be used to
141 add specific extra functionalities to the CImg library.
143 # Getting started
144 #-----------------
146 If you are new to CImg, you should first try to compile the different examples
147 provided in the 'examples/' directory, to see what CImg is capable of
148 (as CImg is a template library, no compilation is mandatory of course).
149 Look at the 'resources/' directory to ease this see how to compile these examples
150 on different plateforms.
152 Then, you can look at the documentation 'html/reference/' to learn more about CImg
153 functions and classes. Finally, you can participate to the 'Forum' or 'Chat' sections
154 of the CImg web page and ask for help if needed.
156 # Current list of available CImg plug-ins
157 #-----------------------------------------
159 --------------------------------------------------------------------------------
160 - CImg IPL ('plugins/cimgIPL.h') (November 2008).
162 This plug-in allows the conversion between CImg and IplImage structures
163 (used in openCV).
165 by Haibo Zheng (haibo.zheng - at - gmail.com)
167 --------------------------------------------------------------------------------
168 - Draw gradient ('plugins/draw_gradient.h') (November 2008).
170 This plug-in can be used to draw color gradient in images.
172 by Jerome Boulanger (http://www.irisa.fr/vista/Equipe/People/Jerome.Boulanger.html),
174 --------------------------------------------------------------------------------
175 - Add file format ('plugins/add_fileformat.h') (September 2007).
177 This plug-in shows how to easily add support for your own file format in
178 CImg. This can be interesting, since the additional format will be recognized
179 in functions 'CImg<T>::save()' and 'CImg<T>::load()' functions.
181 by David Tschumperle (http://www.greyc.ensicaen.fr/~dtschump/).
182 IMAGE Team / GREYC (CNRS UMR 6072), Caen / FRANCE.
183 Home page of the team : http://www.greyc.ensicaen.fr/EquipeImage/
185 --------------------------------------------------------------------------------
186 - JPEG Buffer ('plugins/jpeg_buffer.h') (July 2007).
188 This plug-in provides functions to read/write images stored in jpeg format
189 directly in memory buffers. Interesting when dealing for instance with
190 images coming from webcams and stored in memory.
192 by Paolo Prete.
194 --------------------------------------------------------------------------------
195 - Integral Line ('plugins/integral_line.h') (March 2007).
197 Implementation of functions that retrieve integral lines from vector fields
198 using different types of interpolation.
200 by David Tschumperle (http://www.greyc.ensicaen.fr/~dtschump/).
201 IMAGE Team / GREYC (CNRS UMR 6072), Caen / FRANCE
202 Home page of the team : http://www.greyc.ensicaen.fr/EquipeImage/
204 --------------------------------------------------------------------------------
205 - GREYCstoration ('plugins/greycstoration.h') (May 2006).
207 Implementation of the GREYCstoration algorithm for image denoising.
208 This version is adapted for an easy integration in third parties
209 software, since it is non-blocking and returns a progression indice
210 that can be used in progress bars.
212 by David Tschumperle (http://www.greyc.ensicaen.fr/~dtschump/).
213 IMAGE Team / GREYC (CNRS UMR 6072), Caen / FRANCE
214 Home page of the team : http://www.greyc.ensicaen.fr/EquipeImage/
216 --------------------------------------------------------------------------------
217 - NL Means and Noise Analysis ('plugins/nlmeans.h' and
218 'plugins/noise_analysis.h') (May 2006).
220 Implementation of the Non-Local Means algorithm as described in [1] and [2].
221 The variance of the noise can be automatically estimated using the method
222 inspired from [3].
224 [1] Buades, A.; Coll, B.; Morel, J.-M.: A non-local algorithm for image
225 denoising. IEEE Computer Society Conference on Computer Vision and Pattern
226 Recognition, 2005. CVPR 2005. Vol 2, 20-25 June 2005 Page(s):60 - 65
228 [2] Buades, A. Coll, B. and Morel, J.: A review of image denoising algorithms,
229 with a new one. Multiscale Modeling and Simulation: A SIAM
230 Interdisciplinary Journal 4 (2004) 490-530
232 [3] Gasser, T. Sroka,L. Jennen Steinmetz,C. Residual variance and residual
233 pattern nonlinear regression. Biometrika 73 (1986) 625-659
235 by Jerome Boulanger (http://www.irisa.fr/vista/Equipe/People/Jerome.Boulanger.html),
236 Charles Kervrann and Patrick Bouthemy thanks to ACI IMPBio (MODYNCELL5D Project).
237 VISTA / IRISA-INRIA, Rennes / FRANCE
238 Home page of the team : http://www.irisa.fr/vista/
239 MIA / INRA, Unite de Jouy-en-Josas / FRANCE.
241 --------------------------------------------------------------------------------
242 - Plug in for Matlab mex files ('plugins/cimgmatlab.h') (May 2006).
244 Implement a CImg<T> constructor from a matlab array, a CImg<T> assignment
245 operator from a matlab array and a method that exports a CImg<T> object to
246 a Matlab array.
247 For a bit more, http://www.itu.dk/people/francois/cimgmatlab.html
249 by Francois Lauze (http://www.itu.dk/people/francois/index.html)
250 The IT University of Copenhagen, Image Group.
252 --------------------------------------------------------------------------------
254 # End of file
255 #------------