The C++ Template Image Processing Library.    

[Introduction]- [News]- [Download]- [Screenshots]- [Tutorial]- [Forums]- [Reference]- [SourceForge Repository ]

Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members

CImgl Struct Template Reference

This class represents list of images CImg<T>. More...

List of all members.

Constructors - Destructor - Copy

 CImgl (const unsigned int n=0, const unsigned int width=0, const unsigned int height=1, const unsigned int depth=1, const unsigned int dim=1)
 Create a list of n new images, each having size (width,height,depth,dim).
template<typename t>
 CImgl (const CImgl< t > &list)
 Copy constructor.
 CImgl (const char *filename)
 Create a list by loading a file.
 CImgl (const CImg< T > &img)
 Create a list from a single image img.
 CImgl (const CImg< T > &img1, const CImg< T > &img2)
 Create a list from two images img1 and img2 (images are copied).
 CImgl (const CImg< T > &img1, const CImg< T > &img2, const CImg< T > &img3)
 Create a list from three images img1,img2 and img3 (images are copied).
 CImgl (const CImg< T > &img1, const CImg< T > &img2, const CImg< T > &img3, const CImg< T > &img4)
 Create a list from four images img1,img2,img3 and img4 (images are copied).
template<typename t>
CImgloperator= (const CImgl< t > &list)
 Copy a list into another one.
 ~CImgl ()
 Destructor.
CImglempty ()
 Empty list.
const char * pixel_type ()
 Return a string describing the type of the image pixels in the list (template parameter T).

Arithmetics operators

template<typename t>
CImgloperator+= (const CImgl< t > &list)
 Add each image of the current list with the corresponding image in the list list.
template<typename t>
CImgloperator-= (const CImgl< t > &list)
 Subtract each image of the current list with the corresponding image in the list list.
CImgloperator+= (const T &val)
 Add each image of the current list with a value val.
CImgloperator-= (const T &val)
 Substract each image of the current list with a value val.
CImgloperator *= (const double val)
 Multiply each image of the current list by a value val.
CImgloperator/= (const double val)
 Divide each image of the current list by a value val.
CImgl operator+ (const T &val) const
 Return a new image list corresponding to the addition of each image of the current list with a value val.
CImgl operator * (const double val) const
 Return a new image list corresponding to the multiplication of each image of the current list by a value val.
CImgl operator- (const T &val) const
 Return a new image list corresponding to the substraction of each image of the current list with a value val.
CImgl operator/ (const double val) const
 Return a new image list corresponding to the division of each image of the current list by a value val.
CImgl operator+ (const CImgl &list) const
 Return a new image list corresponding to the addition of each image of the current list with the corresponding image in the list list.
CImgl operator- (const CImgl &list) const
 Return a new image list corresponding to the substraction of each image of the current list with the corresponding image in the list list.
CImgl operator+ (const T &val, const CImgl &list)
 Return a new image list corresponding to the addition of each image of the current list with a value val;.
CImgl operator * (const double val, const CImgl &list)
 Return a new image list corresponding to the scalar multiplication of each image of the current list by a value val.

List operations

CImg< T > & operator[] (const unsigned int pos) const
 Return a reference to the i-th element of the image list.
CImg< T > & operator() (const unsigned int pos) const
 Equivalent to CImgl<T>::operator[].
CImglinsert (const CImg< T > &img, const unsigned int pos)
 Insert a copy of the image img into the current image list, at position pos.
CImglinsert (const CImg< T > &img)
 Append a copy of the image img at the current image list.
CImglinsert (const CImgl< T > &list, const unsigned int pos)
 Insert a copy of the image list list into the current image list, starting from position pos.
CImglinsert (const CImgl< T > &list)
 Append a copy of the image list list at the current image list.
CImglremove (const unsigned int pos)
 Remove the image at position pos from the image list.
CImglremove ()
 Remove the last image from the image list.

IO and display functions

const CImglprint (const char *title=NULL, const int print_flag=1) const
 Print informations about the list on the standart error stream.
const CImglsave_raw (const char *filename) const
 Save an image list into a file (.raw format).
const CImglsave (const char *filename) const
 Save an image list into a file. The file format will be dynamically determined by the filename extension. Use the '.raw' format to save the list into a single file, else images are numbered and saved independently.
CImg< T > get_append (const char axe='x', const char align='c') const
 Append images of a list into a single image (which is returned), by concatenating them along the specified axe axe,.
CImgDisplaynew_display (const char *title="", const int normalize=1, const unsigned int attributes=3, const char axe='x', const char align='c') const
 Open and return a new window display, with a title bar title, showing the images of the list.
Parameter normalize set the way the images are normalized before being displayed (0=no normalization, 1=always normalized, 2=first-time normalized).
Parameter attributes set how system events are catched by the window (0=no events, 1+=window closed, 2+=mouse and keys down 3+=keys up). If the 3rd bit of attributes is set, the display is done in fullscreen mode.
Parameters axe (can be 'x','y','z' or 'v') and align (can be 'p','c' or 'n') specify the way the multiple images of the list are concatenated and centered.
const CImgldisplay (CImgDisplay &disp, const char axe='x', const char align='c') const
 Display an image list into an existing display disp.
Parameters axe (can be 'x','y','z' or 'v') and align (can be 'p','c' or 'n') specify the way the multiple images of the list are concatenated and centered.
const CImgldisplay (CImgDisplay *disp, const char axe='x', const char align='c') const
 Display an image list into an existing display *disp.
Parameters axe (can be 'x','y','z' or 'v') and align (can be 'p','c' or 'n') specify the way the multiple images of the list are concatenated and centered.
const CImgldisplay (const char *title, const char axe='x', const char align='c', const int min_size=128, const int max_size=1024) const
 Display an image list into a new window with specified title title.
Parameters axe (can be 'x','y','z' or 'v') and align (can be 'p','c' or 'n') specify the way the multiple images of the list are concatenated and centered.
const CImgldisplay (const char axe='x', const char align='c', const int min_size=128, const int max_size=1024) const
 Display an image list into a new window.
Parameters axe (can be 'x','y','z' or 'v') and align (can be 'p','c' or 'n') specify the way the multiple images of the list are concatenated and centered.
const CImglwait (const unsigned int milliseconds) const
 Same as cimg::wait().
CImgl load_raw (const char *filename)
 Load an image list from a file (.raw format).
CImgl load (const char *filename)
 Load an image list from a file. The file should be a '.raw' format, else only one image will be loaded into the list.

Public Attributes

unsigned int size
 This variable represents the number of images in the image list.
CImg< T > * data
 Pointer to the first image of the image list.


Detailed Description

template<typename T>
struct cimg_library::CImgl< T >

This class represents list of images CImg<T>.

Definition at line 8300 of file CImg.h.


Member Data Documentation

unsigned int size
 

This variable represents the number of images in the image list.

Note:
if size==0, the image list is empty.

Definition at line 8305 of file CImg.h.

CImg<T>* data
 

Pointer to the first image of the image list.

Note:
the images are stored continuously in memory.

If the list is empty, data=NULL.

Definition at line 8312 of file CImg.h.


Generated on Thu Dec 2 11:26:18 2004 for The CImg Library by  doxygen 1.3.9.1