Pdf External()
Total Page:16
File Type:pdf, Size:1020Kb
The CImg Library 2.9.9 Generated by Doxygen 1.8.17 i 1 Main Page 1 2 CImg Library Overview 3 2.1 Library structure............................................. 3 2.2 CImg version of "Hello world"....................................... 4 2.3 How to compile ? ............................................ 4 2.4 What's next ? .............................................. 5 3 FAQ 7 3.1 FAQ Summary.............................................. 7 3.2 1. General information and availability ................................. 7 3.2.1 1.1. What is the CImg Library ?................................. 7 3.2.2 1.2. What platforms are supported ? .............................. 8 3.2.3 1.3. How is CImg distributed ? ................................. 8 3.2.4 1.4. What kind of people are concerned by CImg ?....................... 8 3.2.5 1.5. What are the specificities of the CeCILL license ?..................... 8 3.2.6 1.6. Who is behind CImg ? ................................... 9 3.3 2. C++ related questions ........................................ 9 3.3.1 2.1 What is the level of C++ knowledge needed to use CImg ?................. 9 3.3.2 2.2 How to use CImg in my own C++ program ?........................ 9 3.3.3 2.3 Why is CImg entirely contained in a single header file ? .................. 9 3.4 3. Other resources ........................................... 10 3.4.1 3.1 Translations......................................... 10 4 Setting Environment Variables 11 5 How to use CImg library with Visual C++ 2005 Express Edition ? 13 5.1 How to use CImg library with Visual C++ 2005 Express Edition ? ................... 13 6 Tutorial : Getting Started. 15 7 Image Loops. 17 7.1 Loops over the pixel buffer........................................ 17 7.2 Loops over image dimensions...................................... 18 7.3 Loops over interior regions and borders. ................................ 18 7.4 Loops using neighborhoods. ...................................... 19 7.4.1 Neighborhood-based loops for 2D images ........................... 19 7.4.2 Neighborhood-based loops for 3D images ........................... 20 7.4.3 Defining neighborhoods..................................... 20 7.4.4 Using alternate variable names................................. 20 7.4.5 Example codes ......................................... 21 8 Using Display Windows. 23 9 How pixel data are stored with CImg? 25 Generated by Doxygen ii 10 Files IO in CImg. 27 11 Retrieving Command Line Arguments. 29 11.1 The cimg_usage() macro ....................................... 29 11.2 The cimg_help() macro ........................................ 29 11.3 The cimg_option() macro ....................................... 29 11.4 Example of use............................................. 30 11.5 How to learn more about command line options ?........................... 31 12 Module Index 33 12.1 Modules ................................................ 33 13 Namespace Index 35 13.1 Namespace List ............................................ 35 14 Hierarchical Index 37 14.1 Class Hierarchy ............................................ 37 15 Class Index 39 15.1 Class List................................................ 39 16 Module Documentation 41 16.1 CImg Library Overview......................................... 41 16.2 FAQ : Frequently Asked Questions................................... 42 16.3 Setting Environment Variables..................................... 43 16.4 How to use CImg library with Visual C++ 2005 Express Edition ?. .................. 44 16.5 Tutorial : Getting Started. ....................................... 45 16.6 Using Image Loops. .......................................... 46 16.7 Using Display Windows......................................... 47 16.8 How pixel data are stored with CImg. ................................. 48 16.9 Files IO in CImg............................................. 49 16.10 Retrieving Command Line Arguments................................. 50 17 Namespace Documentation 51 17.1 cimg_library Namespace Reference.................................. 51 17.1.1 Detailed Description...................................... 51 17.2 cimg_library::cimg Namespace Reference............................... 52 17.2.1 Detailed Description...................................... 60 17.2.2 Function Documentation.................................... 60 17.2.2.1 output() ....................................... 60 17.2.2.2 info()......................................... 61 17.2.2.3 exception_mode() [1/2] .............................. 61 17.2.2.4 exception_mode() [2/2] .............................. 61 17.2.2.5 openmp_mode()................................... 62 17.2.2.6 eval()......................................... 62 Generated by Doxygen iii 17.2.2.7 warn()........................................ 63 17.2.2.8 system()....................................... 63 17.2.2.9 endianness()..................................... 64 17.2.2.10 invert_endianness() [1/2] ............................. 64 17.2.2.11 invert_endianness() [2/2] ............................. 64 17.2.2.12 time()........................................ 66 17.2.2.13 tic()......................................... 66 17.2.2.14 toc() ........................................ 66 17.2.2.15 sleep() ....................................... 66 17.2.2.16 wait()........................................ 67 17.2.2.17 mod()........................................ 67 17.2.2.18 minmod()...................................... 68 17.2.2.19 round()....................................... 68 17.2.2.20 atof()........................................ 68 17.2.2.21 strncasecmp() ................................... 69 17.2.2.22 strcasecmp().................................... 69 17.2.2.23 strellipsize() [1/2] ................................. 70 17.2.2.24 strellipsize() [2/2] ................................. 70 17.2.2.25 strpare() ...................................... 71 17.2.2.26 strwindows_reserved()............................... 71 17.2.2.27 strunescape() ................................... 71 17.2.2.28 fopen()....................................... 72 17.2.2.29 fclose()....................................... 72 17.2.2.30 is_directory().................................... 73 17.2.2.31 is_file()....................................... 73 17.2.2.32 fsize()........................................ 73 17.2.2.33 fdate() [1/2] .................................... 73 17.2.2.34 fdate() [2/2] .................................... 75 17.2.2.35 date() [1/2] .................................... 75 17.2.2.36 date() [2/2] .................................... 76 17.2.2.37 curl_path()..................................... 76 17.2.2.38 dcraw_path().................................... 77 17.2.2.39 ffmpeg_path() ................................... 77 17.2.2.40 graphicsmagick_path()............................... 77 17.2.2.41 gunzip_path().................................... 78 17.2.2.42 gzip_path()..................................... 78 17.2.2.43 imagemagick_path()................................ 79 17.2.2.44 medcon_path()................................... 79 17.2.2.45 temporary_path().................................. 79 17.2.2.46 wget_path()..................................... 80 17.2.2.47 split_filename()................................... 80 17.2.2.48 fread() ....................................... 80 Generated by Doxygen iv 17.2.2.49 fwrite() ....................................... 81 17.2.2.50 fempty() ...................................... 81 17.2.2.51 ftype() ....................................... 82 17.2.2.52 load_network()................................... 82 17.2.2.53 files()........................................ 83 17.2.2.54 dialog()....................................... 83 18 Class Documentation 85 18.1 CImg< T > Struct Template Reference................................ 85 18.1.1 Detailed Description...................................... 143 18.1.2 Member Typedef Documentation ............................... 144 18.1.2.1 iterator........................................ 145 18.1.2.2 value_type...................................... 145 18.1.3 Constructor & Destructor Documentation ........................... 145 18.1.3.1 ∼CImg()....................................... 145 18.1.3.2 CImg() [1/13] .................................... 146 18.1.3.3 CImg() [2/13] .................................... 146 18.1.3.4 CImg() [3/13] .................................... 147 18.1.3.5 CImg() [4/13] .................................... 148 18.1.3.6 CImg() [5/13] .................................... 149 18.1.3.7 CImg() [6/13] .................................... 149 18.1.3.8 CImg() [7/13] .................................... 151 18.1.3.9 CImg() [8/13] .................................... 152 18.1.3.10 CImg() [9/13] ................................... 153 18.1.3.11 CImg() [10/13] .................................. 153 18.1.3.12 CImg() [11/13] .................................. 154 18.1.3.13 CImg() [12/13] .................................. 154 18.1.3.14 CImg() [13/13] .................................. 155 18.1.4 Member Function Documentation............................... 155 18.1.4.1 assign() [1/13] ................................... 155 18.1.4.2 assign() [2/13] ................................... 156 18.1.4.3 assign() [3/13] ................................... 156 18.1.4.4 assign() [4/13] ................................... 156 18.1.4.5 assign() [5/13] ................................... 156 18.1.4.6 assign() [6/13] ..................................