cimg_library::CImgList< T > Struct Template Reference

Class representing list of images CImg<T>. More...

#include <cimg.h>

List of all members.

Constructors - Destructor - Copy

 CImgList ()
 Default constructor.
 ~CImgList ()
 Destructor.
CImgList< T > & assign ()
 In-place version of the default constructor and default destructor.
CImgList< T > & clear ()
 Equivalent to assign() (STL-compliant name).
template<typename t >
 CImgList (const CImgList< t > &list)
 Copy constructor.
 CImgList (const CImgList< T > &list)
template<typename t >
 CImgList (const CImgList< t > &list, const bool shared)
 Copy constructor that create a shared object.
 CImgList (const CImgList< T > &list, const bool shared)
template<typename t >
CImgList< T > & assign (const CImgList< t > &list, const int shared=0)
 In-place version of the copy constructor.
 CImgList (const unsigned int n)
 Construct an image list containing n empty images.
CImgList< T > & assign (const unsigned int n)
 In-place version of the previous constructor.
 CImgList (const unsigned int n, const unsigned int width, const unsigned int height=1, const unsigned int depth=1, const unsigned int dim=1)
 Construct an image list containing n images with specified size.
CImgList< T > & assign (const unsigned int n, const unsigned int width, const unsigned int height=1, const unsigned int depth=1, const unsigned int dim=1)
 In-place version of the previous constructor.
 CImgList (const unsigned int n, const unsigned int width, const unsigned int height, const unsigned int depth, const unsigned int dim, const T val)
 Construct an image list containing n images with specified size, filled with val.
CImgList< T > & assign (const unsigned int n, const unsigned int width, const unsigned int height, const unsigned int depth, const unsigned int dim, const T val)
 In-place version of the previous constructor.
 CImgList (const unsigned int n, const unsigned int width, const unsigned int height, const unsigned int depth, const unsigned int dim, const int val0, const int val1,...)
 Construct an image list containing n images with specified size and specified pixel values (int version).
CImgList< T > & assign (const unsigned int n, const unsigned int width, const unsigned int height, const unsigned int depth, const unsigned int dim, const int val0, const int val1,...)
 In-place version of the previous constructor.
 CImgList (const unsigned int n, const unsigned int width, const unsigned int height, const unsigned int depth, const unsigned int dim, const double val0, const double val1,...)
 Construct an image list containing n images with specified size and specified pixel values (double version).
CImgList< T > & assign (const unsigned int n, const unsigned int width, const unsigned int height, const unsigned int depth, const unsigned int dim, const double val0, const double val1,...)
 In-place version of the previous constructor.
template<typename t >
 CImgList (const unsigned int n, const CImg< t > &img, const bool shared=false)
 Construct a list containing n copies of the image img.
template<typename t >
CImgList< T > & assign (const unsigned int n, const CImg< t > &img, const bool shared=false)
 In-place version of the previous constructor.
template<typename t >
 CImgList (const CImg< t > &img, const bool shared=false)
 Construct an image list from one image.
template<typename t >
CImgList< T > & assign (const CImg< t > &img, const bool shared=false)
 In-place version of the previous constructor.
template<typename t1 , typename t2 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const bool shared=false)
 Construct an image list from two images.
template<typename t1 , typename t2 >
CImgList< T > & assign (const CImg< t1 > &img1, const CImg< t2 > &img2, const bool shared=false)
 In-place version of the previous constructor.
template<typename t1 , typename t2 , typename t3 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const bool shared=false)
 Construct an image list from three images.
template<typename t1 , typename t2 , typename t3 >
CImgList< T > & assign (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const bool shared=false)
 In-place version of the previous constructor.
template<typename t1 , typename t2 , typename t3 , typename t4 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const bool shared=false)
 Construct an image list from four images.
template<typename t1 , typename t2 , typename t3 , typename t4 >
CImgList< T > & assign (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const bool shared=false)
 In-place version of the previous constructor.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const bool shared=false)
 Construct an image list from five images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 >
CImgList< T > & assign (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const bool shared=false)
 In-place version of the previous constructor.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const bool shared=false)
 Construct an image list from six images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 >
CImgList< T > & assign (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const bool shared=false)
 In-place version of the previous constructor.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const CImg< t7 > &img7, const bool shared=false)
 Construct an image list from seven images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 >
CImgList< T > & assign (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const CImg< t7 > &img7, const bool shared=false)
 In-place version of the previous constructor.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 , typename t8 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const CImg< t7 > &img7, const CImg< t8 > &img8, const bool shared=false)
 Construct an image list from eight images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 , typename t8 >
CImgList< T > & assign (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const CImg< t7 > &img7, const CImg< t8 > &img8, const bool shared=false)
 In-place version of the previous constructor.
 CImgList (const char *const filename)
 Construct an image list from a filename.
CImgList< T > & assign (const char *const filename)
 In-place version of the previous constructor.
CImgList< T > & swap (CImgList< T > &list)
CImgList< T > & assign_to (CImgList< T > &list)
template<typename t >
CImgList< T > & assign_to (CImgList< t > &list)
bool is_empty () const
 Return true if list is empty.
 operator bool () const
bool contains (const int k) const
 Return true if the list contains an image with indice k.
bool contains (const int k, const int x, const int y=0, const int z=0, const int v=0) const
 Return true if the k-th image of the list contains the pixel (x,y,z,v).
template<typename t >
bool contains (const T &pixel, t &l, t &x, t &y, t &z, t &v) const
 Return true if one of the image list contains the pixel.
template<typename t >
bool contains (const T &pixel, t &l, t &x, t &y, t &z) const
 Return true if one of the image list contains the pixel.
template<typename t >
bool contains (const T &pixel, t &l, t &x, t &y) const
 Return true if one of the image list contains the pixel.
template<typename t >
bool contains (const T &pixel, t &l, t &x) const
 Return true if one of the image list contains the pixel.
template<typename t >
bool contains (const T &pixel, t &l) const
 Return true if one of the image list contains the pixel.
template<typename t >
bool contains (const T &pixel) const
 Return true if one of the image list contains the pixel.
static const char * pixel_type ()
 Return a string describing the type of the image pixels in the list (template parameter T).

Input-Output and Display

const CImgList< T > & print (const char *title=0, const int print_flag=1) const
 Print informations about the list on the standard output.
const CImgList< T > & print (const int print_flag) const
 Display informations about the list on the standard output.
CImgList< T > & load (const char *const filename)
 In-place version of the previous function.
CImgList< T > & load_cimg (std::FILE *const file, const char *const filename=0)
 In-place version of the previous function.
CImgList< T > & load_cimg (const char *const filename)
 In-place version of the previous function.
CImgList< T > & load_cimg (std::FILE *const file, const unsigned int n0, const unsigned int n1, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int v1)
 In-place version of the previous function.
CImgList< T > & load_cimg (const char *const filename, const unsigned int n0, const unsigned int n1, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int v1)
 In-place version of the previous function.
CImgList< T > & load_cimg (std::FILE *const file, const char *const filename, const unsigned int n0, const unsigned int n1, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int v1)
 In-place version of the previous function.
CImgList< T > & load_parrec (const char *const filename)
 In-place version of the previous function.
CImgList< T > & load_yuv (std::FILE *const file, const char *const filename, const unsigned int sizex, const unsigned int sizey=1, const unsigned int first_frame=0, const int last_frame=-1, const bool yuv2rgb=false)
 In-place version of the previous function.
CImgList< T > & load_yuv (const char *const filename, const unsigned int sizex, const unsigned int sizey, const unsigned int first_frame=0, const int last_frame=-1, const bool yuv2rgb=false)
 In-place version of the previous function.
template<typename tf , typename tc >
CImgList< T > & load_off (std::FILE *const file, const char *const filename, CImgList< tf > &primitives, CImgList< tc > &colors, const bool invert_faces=false)
 In-place version of the previous function.
template<typename tf , typename tc >
CImgList< T > & load_off (const char *const filename, CImgList< tf > &primitives, CImgList< tc > &colors, const bool invert_faces=false)
 In-place version of the previous function.
const CImgList< T > & save (const char *const filename, const int number=-1) const
 Save an image list into a file.
const CImgList< T > & save_yuv (std::FILE *const file, const char *const filename=0, const bool rgb2yuv=true) const
 Save an image sequence into a YUV file.
const CImgList< T > & save_yuv (const char *const filename=0, const bool rgb2yuv=true) const
 Save an image sequence into a YUV file.
const CImgList< T > & save_cimg (std::FILE *const file, const char *const filename=0) const
 Save an image list into a .cimg file.
const CImgList< T > & save_cimg (const char *const filename) const
 Save an image list into a CImg file (RAW binary file + simple header).
const CImgList< T > & save_cimg (std::FILE *const file, const char *const filename, const unsigned int n0, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0) const
const CImgList< T > & save_cimg (std::FILE *const file, const unsigned int n0, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0) const
 Insert the instance image into into an existing .cimg file, at specified coordinates.
const CImgList< T > & save_cimg (const char *const filename, const unsigned int n0, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0) const
 Insert the instance image into into an existing .cimg file, at specified coordinates.
template<typename tf , typename tc >
const CImgList< T > & save_off (std::FILE *const file, const char *const filename, const CImgList< tf > &primitives, const CImgList< tc > &colors, const bool invert_faces=false) const
 Save an image list into a OFF file.
template<typename tf , typename tc >
const CImgList< T > & save_off (const char *const filename, const CImgList< tf > &primitives, const CImgList< tc > &colors, const bool invert_faces=false) const
 Save an image list into a OFF file.
CImgList< T > get_split (const char axe='x') const
CImgList< T > & split (const char axe='x')
 In-place version of the previous function.
CImg< T > get_append (const char axe='x', const char align='c') const
 Return a single image which is the concatenation of all images of the current CImgList instance.
CImgList< T > get_crop_font () const
CImgList< T > & crop_font ()
 In-place version of the previous function.
CImgList< T > & font (const unsigned int *const font, const unsigned int w, const unsigned int h, const unsigned int paddingx, const unsigned int paddingy, const bool variable_size=true)
 In-place version of the previous function.
CImgList< T > & font (const unsigned int font_width, const bool variable_size=true)
 In-place version of the previous function.
const CImgList< T > & display (CImgDisplay &disp, const char axe='x', const char align='c') const
 Display the current CImgList instance in an existing CImgDisplay window (by reference).
const CImgList< T > & display (const char *title, const char axe='x', const char align='c', const int min_size=128, const int max_size=1024, const int print_flag=1) const
 Display the current CImgList instance in a new display window.
const CImgList< T > & display (const char axe='x', const char align='c', const int min_size=128, const int max_size=1024, const int print_flag=1) const
 Display the current CImgList instance in a new display window.
static CImgList< T > get_load (const char *const filename)
 Load an image list from a file.
static CImgList< T > get_load_cimg (std::FILE *const file, const char *const filename=0)
 Load an image list from a .cimg file.
static CImgList< T > get_load_cimg (const char *const filename)
 Load an image list from a .cimg file.
static CImgList< T > get_load_cimg (std::FILE *const file, const unsigned int n0, const unsigned int n1, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int v1)
 Load a sub-image list from a .cimg file.
static CImgList< T > get_load_cimg (const char *const filename, const unsigned int n0, const unsigned int n1, const unsigned int x0, const unsigned int y0, const unsigned int z0, const unsigned int v0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int v1)
 Load a sub-image list from a .cimg file.
static CImgList< T > get_load_parrec (const char *const filename)
 Load an image list from a PAR/REC (Philips) file.
static CImgList< T > get_load_yuv (std::FILE *const file, const char *const filename, const unsigned int sizex, const unsigned int sizey=1, const unsigned int first_frame=0, const int last_frame=-1, const bool yuv2rgb=false)
 Load an image sequence from a YUV file.
static CImgList< T > get_load_yuv (const char *const filename, const unsigned int sizex, const unsigned int sizey=1, const unsigned int first_frame=0, const int last_frame=-1, const bool yuv2rgb=false)
 Load an image sequence from a YUV file.
template<typename tf , typename tc >
static CImgList< T > get_load_off (std::FILE *const file, const char *const filename, CImgList< tf > &primitives, CImgList< tc > &colors, const bool invert_faces=false)
 Load a 3D object from a .OFF file (GeomView 3D object files).
template<typename tf , typename tc >
static CImgList< T > get_load_off (const char *const filename, CImgList< tf > &primitives, CImgList< tc > &colors, const bool invert_faces=false)
 Load a 3D object from a .OFF file (GeomView 3D object files).
static void save_empty_cimg (std::FILE *const file, const char *const filename, const unsigned int nb, const unsigned int dx, const unsigned int dy=1, const unsigned int dz=1, const unsigned int dv=1)
static void save_empty_cimg (std::FILE *const file, const unsigned int nb, const unsigned int dx, const unsigned int dy=1, const unsigned int dz=1, const unsigned int dv=1)
 Create an empty .cimg file with specified dimensions.
static void save_empty_cimg (const char *const filename, const unsigned int nb, const unsigned int dx, const unsigned int dy=1, const unsigned int dz=1, const unsigned int dv=1)
 Create an empty .cimg file with specified dimensions.
static CImgList< T > get_font (const unsigned int *const font, const unsigned int w, const unsigned int h, const unsigned int paddingx, const unsigned int paddingy, const bool variable_size=true)
static CImgList< T > get_font (const unsigned int font_width, const bool variable_size=true)
 Return a CImg pre-defined font with desired size.

Public Types

typedef CImg< T > * iterator
 Define a CImgList<T>::iterator.
typedef const CImg< T > * const_iterator
 Define a CImgList<T>::const_iterator.
typedef T value_type
 Get value type.

Public Member Functions

Arithmetics Operators
template<typename t >
CImgList< T > & operator= (const CImgList< t > &list)
 Assignment operator.
CImgList< T > & operator= (const CImgList< T > &list)
template<typename t >
CImgList< T > & operator= (const CImg< t > &img)
 Assignment operator.
CImgList< T > & operator= (const T val)
 Assignment operator.
CImgList< T > operator+ () const
 Operator+.
template<typename t >
CImgList< T > & operator+= (const t val)
 Operator+=.
template<typename t >
CImgList< T > & operator+= (const CImgList< t > &list)
 Operator+=.
CImgList< T > & operator++ ()
 Operator++ (prefix).
CImgList< T > operator++ (int)
 Operator++ (postfix).
CImgList< T > operator- () const
 Operator-.
template<typename t >
CImgList< T > & operator-= (const t val)
 Operator-=.
template<typename t >
CImgList< T > & operator-= (const CImgList< t > &list)
 Operator-=.
CImgList< T > & operator-- ()
 Operator-- (prefix).
CImgList< T > operator-- (int)
 Operator-- (postfix).
template<typename t >
CImgList< T > & operator*= (const t val)
 Operator*=.
template<typename t >
CImgList< T > & operator*= (const CImgList< t > &list)
 Operator*=.
template<typename t >
CImgList< T > & operator/= (const t val)
 Operator/=.
template<typename t >
CImgList< T > & operator/= (const CImgList< t > &list)
 Operator/=.
const T & max () const
 Return a reference to the maximum pixel value of the instance image.
T & max ()
 Return a reference to the maximum pixel value of the instance image.
const T & min () const
 Return a reference to the minimum pixel value of the instance image.
T & min ()
 Return a reference to the minimum pixel value of the instance image.
template<typename t >
const T & minmax (t &max_val) const
 Return a reference to the minimum pixel value of the instance image.
template<typename t >
T & minmax (t &max_val)
 Return a reference to the minimum pixel value of the instance image.
template<typename t >
const T & maxmin (t &min_val) const
 Return a reference to the minimum pixel value of the instance image.
template<typename t >
T & maxmin (t &min_val)
 Return a reference to the minimum pixel value of the instance image.
double mean () const
 Return the mean pixel value of the instance image.
double variance ()
 Return the variance of the image.
List Manipulation
CImg< T > & operator[] (const unsigned int pos)
 Return a reference to the i-th element of the image list.
const CImg< T > & operator[] (const unsigned int pos) const
CImg< T > & operator() (const unsigned int pos)
 Equivalent to CImgList<T>::operator[].
const CImg< T > & operator() (const unsigned int pos) const
T & operator() (const unsigned int pos, const unsigned int x, const unsigned int y=0, const unsigned int z=0, const unsigned int v=0)
 Return a reference to (x,y,z,v) pixel of the pos-th image of the list.
const T & operator() (const unsigned int pos, const unsigned int x, const unsigned int y=0, const unsigned int z=0, const unsigned int v=0) const
CImg< T > & at (const unsigned int pos)
 Equivalent to CImgList<T>::operator[], with boundary checking.
const CImg< T > & at (const unsigned int pos) const
CImg< T > & back ()
 Returns a reference to last element.
const CImg< T > & back () const
CImg< T > & front ()
 Returns a reference to the first element.
const CImg< T > & front () const
iterator begin ()
 Returns an iterator to the beginning of the vector.
const_iterator begin () const
iterator end ()
 Returns an iterator just past the last element.
const_iterator end () const
template<typename t >
CImgList< typename
cimg::superset< T, t >::type > 
get_insert (const CImg< t > &img, const unsigned int pos=~0U, const bool shared=false) const
 Insert a copy of the image img into the current image list, at position pos.
template<typename t >
CImgList< T > & insert (const CImg< t > &img, const unsigned int pos, const bool shared)
 In-place version of the previous function.
CImgList< T > & insert (const CImg< T > &img, const unsigned int pos, const bool shared)
template<typename t >
CImgList< T > & insert (const CImg< t > &img, const unsigned int pos)
template<typename t >
CImgList< T > & insert (const CImg< t > &img)
 In-place version of the previous function.
template<typename t >
CImgList< typename
cimg::superset< T, t >::type > 
get_insert (const unsigned int n, const CImg< t > &img, const unsigned int pos=~0U, const bool shared=false) const
 Insert n copies of the image img into the current image list, at position pos.
template<typename t >
CImgList< T > & insert (const unsigned int n, const CImg< t > &img, const unsigned int pos=~0U, const bool shared=false)
 In-place version of the previous function.
template<typename t >
CImgList< typename
cimg::superset< T, t >::type > 
get_insert (const CImgList< t > &list, const unsigned int pos=~0U, int shared=0) const
 Insert a copy of the image list list into the current image list, starting from position pos.
template<typename t >
CImgList< T > & insert (const CImgList< t > &list, const unsigned int pos=~0U, const int shared=0)
 In-place version of the previous function.
template<typename t >
CImgList< typename
cimg::superset< T, t >::type > 
get_insert (const unsigned int n, const CImgList< t > &list, const unsigned int pos=~0U, const int shared=0) const
 Insert n copies of the list list at position pos of the current list.
template<typename t >
CImgList< T > & insert (const unsigned int n, const CImgList< t > &list, const unsigned int pos=~0U, const int shared=0)
 In-place version of the previous function.
CImgList< T > get_remove (const unsigned int pos1, const unsigned int pos2) const
 Remove the images at positions pos1 to pos2 from the image list.
CImgList< T > & remove (const unsigned int pos1, const unsigned int pos2)
 In-place version of the previous function.
CImgList< T > get_remove (const unsigned int pos) const
 Remove the image at position pos from the image list.
CImgList< T > & remove (const unsigned int pos)
 In-place version of the previous function.
CImgList< T > get_remove () const
 Remove the last image from the image list.
CImgList< T > & remove ()
 In-place version of the previous function.
CImgList< T > get_reverse () const
 Reverse list order.
CImgList< T > & reverse ()
 In-place version of the previous function.
CImgList< T > get_crop (const unsigned int i0, const unsigned int i1, const bool shared=false) const
 Get a sub-list.
CImgList< T > & crop (const unsigned int i0, const unsigned int i1, const bool shared=false)
 In-place version of the previous function.
CImgList< T > get_crop (const unsigned int i0, const unsigned int i1, const int x0, const int y0, const int z0, const int v0, const int x1, const int y1, const int z1, const int v1) const
 Get sub-images of a sublist.
CImgList< T > & crop (const unsigned int i0, const unsigned int i1, const int x0, const int y0, const int z0, const int v0, const int x1, const int y1, const int z1, const int v1)
 In-place version of the previous function.
CImgList< T > get_crop (const unsigned int i0, const unsigned int i1, const int x0, const int y0, const int z0, const int x1, const int y1, const int z1) const
 Get sub-images of a sublist.
CImgList< T > & crop (const unsigned int i0, const unsigned int i1, const int x0, const int y0, const int z0, const int x1, const int y1, const int z1)
 In-place version of the previous function.
CImgList< T > get_crop (const unsigned int i0, const unsigned int i1, const int x0, const int y0, const int x1, const int y1) const
 Get sub-images of a sublist.
CImgList< T > & crop (const unsigned int i0, const unsigned int i1, const int x0, const int y0, const int x1, const int y1)
 In-place version of the previous function.
CImgList< T > get_crop (const unsigned int i0, const unsigned int i1, const int x0, const int x1) const
 Get sub-images of a sublist.
CImgList< T > & crop (const unsigned int i0, const unsigned int i1, const int x0, const int x1)
 In-place version of the previous function.
template<typename t >
CImgList< T > & operator<< (const CImg< t > &img)
 Insert a copy of the image img at the end of the current image list.
template<typename t >
CImgList< T > & operator<< (const CImgList< t > &list)
 Insert a copy of the image list list at the end of the current image list.
template<typename t >
CImgList< T > & operator>> (CImg< t > &img) const
 Return a copy of the current image list, where the image img has been inserted at the end.
template<typename t >
CImgList< T > & operator>> (CImgList< t > &list) const
 Insert a copy of the current image list at the beginning of the image list list.
const CImgList< T > & operator>> (CImgDisplay &disp) const
 Display an image list into a CImgDisplay.
template<typename t >
CImgList< T > & push_back (const CImg< t > &img)
 Insert image img at the end of the list.
template<typename t >
CImgList< T > & push_front (const CImg< t > &img)
 Insert image img at the front of the list.
template<typename t >
CImgList< T > & push_back (const CImgList< t > &list)
 Insert list list at the end of the current list.
template<typename t >
CImgList< T > & push_front (const CImgList< t > &list)
 Insert list list at the front of the current list.
CImgList< T > & pop_back ()
 Remove last element of the list;.
CImgList< T > & pop_front ()
 Remove first element of the list;.
CImgList< T > & erase (const iterator iter)
 Remove the element pointed by iterator iter;.
Fourier Transforms
CImgList< typename
cimg::superset< T, float >
::type > 
get_FFT (const char axe, const bool inverse=false) const
 Compute the Fast Fourier Transform (along the specified axis).
CImgList< T > & FFT (const char axe, const bool inverse=false)
 In-place version of the previous function.
CImgList< typename
cimg::superset< T, float >
::type > 
get_FFT (const bool inverse=false) const
 Compute the Fast Fourier Transform of a complex image.
CImgList< T > & FFT (const bool inverse=false)
 In-place version of the previous function.

Public Attributes

unsigned int size
 Size of the list (number of elements inside).
unsigned int allocsize
 Allocation size of the list.
CImg< T > * data
 Pointer to the first list element.


Detailed Description

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

Class representing list of images CImg<T>.

Definition at line 25616 of file cimg.h.


Member Typedef Documentation

template<typename T >
typedef const CImg<T>* cimg_library::CImgList< T >::const_iterator

Define a CImgList<T>::const_iterator.

Definition at line 25631 of file cimg.h.

template<typename T >
typedef CImg<T>* cimg_library::CImgList< T >::iterator

Define a CImgList<T>::iterator.

Definition at line 25628 of file cimg.h.

template<typename T >
typedef T cimg_library::CImgList< T >::value_type

Get value type.

Definition at line 25634 of file cimg.h.


Constructor & Destructor Documentation

template<typename T >
cimg_library::CImgList< T >::CImgList (  )  [inline]

Default constructor.

Definition at line 25678 of file cimg.h.

template<typename T >
cimg_library::CImgList< T >::~CImgList (  )  [inline]

Destructor.

Definition at line 25682 of file cimg.h.

template<typename T >
template<typename t >
cimg_library::CImgList< T >::CImgList ( const CImgList< t > &  list  )  [inline]

Copy constructor.

Definition at line 25700 of file cimg.h.

template<typename T >
cimg_library::CImgList< T >::CImgList ( const CImgList< T > &  list  )  [inline]

Definition at line 25705 of file cimg.h.

References cimglist_for, and cimg_library::CImgList< T >::size.

template<typename T >
template<typename t >
cimg_library::CImgList< T >::CImgList ( const CImgList< t > &  list,
const bool  shared 
) [inline]

Copy constructor that create a shared object.

Definition at line 25712 of file cimg.h.

template<typename T >
cimg_library::CImgList< T >::CImgList ( const CImgList< T > &  list,
const bool  shared 
) [inline]

Definition at line 25717 of file cimg.h.

template<typename T >
cimg_library::CImgList< T >::CImgList ( const unsigned int  n  )  [inline, explicit]

Construct an image list containing n empty images.

Definition at line 25731 of file cimg.h.

References cimg_library::cimg::nearest_pow2().

template<typename T >
cimg_library::CImgList< T >::CImgList ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height = 1,
const unsigned int  depth = 1,
const unsigned int  dim = 1 
) [inline]

Construct an image list containing n images with specified size.

Definition at line 25749 of file cimg.h.

template<typename T >
cimg_library::CImgList< T >::CImgList ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height,
const unsigned int  depth,
const unsigned int  dim,
const T  val 
) [inline]

Construct an image list containing n images with specified size, filled with val.

Definition at line 25765 of file cimg.h.

template<typename T >
cimg_library::CImgList< T >::CImgList ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height,
const unsigned int  depth,
const unsigned int  dim,
const int  val0,
const int  val1,
  ... 
) [inline]

Construct an image list containing n images with specified size and specified pixel values (int version).

Definition at line 25780 of file cimg.h.

References _CImgList_stdarg.

template<typename T >
cimg_library::CImgList< T >::CImgList ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height,
const unsigned int  depth,
const unsigned int  dim,
const double  val0,
const double  val1,
  ... 
) [inline]

Construct an image list containing n images with specified size and specified pixel values (double version).

Definition at line 25805 of file cimg.h.

References _CImgList_stdarg.

template<typename T >
template<typename t >
cimg_library::CImgList< T >::CImgList ( const unsigned int  n,
const CImg< t > &  img,
const bool  shared = false 
) [inline]

Construct a list containing n copies of the image img.

Definition at line 25819 of file cimg.h.

template<typename T >
template<typename t >
cimg_library::CImgList< T >::CImgList ( const CImg< t > &  img,
const bool  shared = false 
) [inline, explicit]

Construct an image list from one image.

Definition at line 25832 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 >
cimg_library::CImgList< T >::CImgList ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const bool  shared = false 
) [inline]

Construct an image list from two images.

Definition at line 25843 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 >
cimg_library::CImgList< T >::CImgList ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const bool  shared = false 
) [inline]

Construct an image list from three images.

Definition at line 25856 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 >
cimg_library::CImgList< T >::CImgList ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const bool  shared = false 
) [inline]

Construct an image list from four images.

Definition at line 25870 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 >
cimg_library::CImgList< T >::CImgList ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const bool  shared = false 
) [inline]

Construct an image list from five images.

Definition at line 25885 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 >
cimg_library::CImgList< T >::CImgList ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const CImg< t6 > &  img6,
const bool  shared = false 
) [inline]

Construct an image list from six images.

Definition at line 25902 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 >
cimg_library::CImgList< T >::CImgList ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const CImg< t6 > &  img6,
const CImg< t7 > &  img7,
const bool  shared = false 
) [inline]

Construct an image list from seven images.

Definition at line 25920 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 , typename t8 >
cimg_library::CImgList< T >::CImgList ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const CImg< t6 > &  img6,
const CImg< t7 > &  img7,
const CImg< t8 > &  img8,
const bool  shared = false 
) [inline]

Construct an image list from eight images.

Definition at line 25938 of file cimg.h.

template<typename T >
cimg_library::CImgList< T >::CImgList ( const char *const   filename  )  [inline]

Construct an image list from a filename.

Definition at line 25955 of file cimg.h.


Member Function Documentation

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign ( const char *const   filename  )  [inline]

In-place version of the previous constructor.

Definition at line 25961 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 , typename t8 >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const CImg< t6 > &  img6,
const CImg< t7 > &  img7,
const CImg< t8 > &  img8,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25946 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const CImg< t6 > &  img6,
const CImg< t7 > &  img7,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25928 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const CImg< t6 > &  img6,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25910 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const CImg< t5 > &  img5,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25892 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 , typename t4 >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const CImg< t4 > &  img4,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25877 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 , typename t3 >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const CImg< t3 > &  img3,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25862 of file cimg.h.

template<typename T >
template<typename t1 , typename t2 >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t1 > &  img1,
const CImg< t2 > &  img2,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25849 of file cimg.h.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImg< t > &  img,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25838 of file cimg.h.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::assign ( const unsigned int  n,
const CImg< t > &  img,
const bool  shared = false 
) [inline]

In-place version of the previous constructor.

Definition at line 25825 of file cimg.h.

References cimglist_for.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height,
const unsigned int  depth,
const unsigned int  dim,
const double  val0,
const double  val1,
  ... 
) [inline]

In-place version of the previous constructor.

Definition at line 25812 of file cimg.h.

References _CImgList_stdarg.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height,
const unsigned int  depth,
const unsigned int  dim,
const int  val0,
const int  val1,
  ... 
) [inline]

In-place version of the previous constructor.

Definition at line 25798 of file cimg.h.

References _CImgList_stdarg.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height,
const unsigned int  depth,
const unsigned int  dim,
const T  val 
) [inline]

In-place version of the previous constructor.

Definition at line 25772 of file cimg.h.

References cimglist_for.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign ( const unsigned int  n,
const unsigned int  width,
const unsigned int  height = 1,
const unsigned int  depth = 1,
const unsigned int  dim = 1 
) [inline]

In-place version of the previous constructor.

Definition at line 25756 of file cimg.h.

References cimglist_for.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign ( const unsigned int  n  )  [inline]

In-place version of the previous constructor.

Definition at line 25737 of file cimg.h.

References cimg_library::cimg::nearest_pow2().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImgList< t > &  list,
const int  shared = 0 
) [inline]

In-place version of the copy constructor.

Definition at line 25723 of file cimg.h.

References cimglist_for, and cimg_library::CImgList< T >::size.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign (  )  [inline]

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::assign_to ( CImgList< t > &  list  )  [inline]

Definition at line 25980 of file cimg.h.

References cimg_library::CImgList< T >::assign().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::assign_to ( CImgList< T > &  list  )  [inline]

template<typename T >
const CImg<T>& cimg_library::CImgList< T >::at ( const unsigned int  pos  )  const [inline]

Definition at line 26379 of file cimg.h.

template<typename T >
CImg<T>& cimg_library::CImgList< T >::at ( const unsigned int  pos  )  [inline]

Equivalent to CImgList<T>::operator[], with boundary checking.

Definition at line 26372 of file cimg.h.

template<typename T >
const CImg<T>& cimg_library::CImgList< T >::back (  )  const [inline]

Definition at line 26391 of file cimg.h.

template<typename T >
CImg<T>& cimg_library::CImgList< T >::back (  )  [inline]

Returns a reference to last element.

Definition at line 26387 of file cimg.h.

template<typename T >
const_iterator cimg_library::CImgList< T >::begin (  )  const [inline]

Definition at line 26409 of file cimg.h.

template<typename T >
iterator cimg_library::CImgList< T >::begin (  )  [inline]

Returns an iterator to the beginning of the vector.

Definition at line 26405 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::clear (  )  [inline]

Equivalent to assign() (STL-compliant name).

Definition at line 25695 of file cimg.h.

template<typename T >
template<typename t >
bool cimg_library::CImgList< T >::contains ( const T &  pixel  )  const [inline]

Return true if one of the image list contains the pixel.

Definition at line 26040 of file cimg.h.

template<typename T >
template<typename t >
bool cimg_library::CImgList< T >::contains ( const T &  pixel,
t &  l 
) const [inline]

Return true if one of the image list contains the pixel.

Definition at line 26034 of file cimg.h.

template<typename T >
template<typename t >
bool cimg_library::CImgList< T >::contains ( const T &  pixel,
t &  l,
t &  x 
) const [inline]

Return true if one of the image list contains the pixel.

Definition at line 26028 of file cimg.h.

template<typename T >
template<typename t >
bool cimg_library::CImgList< T >::contains ( const T &  pixel,
t &  l,
t &  x,
t &  y 
) const [inline]

Return true if one of the image list contains the pixel.

Definition at line 26022 of file cimg.h.

template<typename T >
template<typename t >
bool cimg_library::CImgList< T >::contains ( const T &  pixel,
t &  l,
t &  x,
t &  y,
t &  z 
) const [inline]

Return true if one of the image list contains the pixel.

Definition at line 26016 of file cimg.h.

template<typename T >
template<typename t >
bool cimg_library::CImgList< T >::contains ( const T &  pixel,
t &  l,
t &  x,
t &  y,
t &  z,
t &  v 
) const [inline]

Return true if one of the image list contains the pixel.

Definition at line 26009 of file cimg.h.

References cimglist_for.

template<typename T >
bool cimg_library::CImgList< T >::contains ( const int  k,
const int  x,
const int  y = 0,
const int  z = 0,
const int  v = 0 
) const [inline]

Return true if the k-th image of the list contains the pixel (x,y,z,v).

Definition at line 26004 of file cimg.h.

template<typename T >
bool cimg_library::CImgList< T >::contains ( const int  k  )  const [inline]

Return true if the list contains an image with indice k.

Definition at line 25999 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  x1 
) [inline]

In-place version of the previous function.

Definition at line 26711 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  y0,
const int  x1,
const int  y1 
) [inline]

In-place version of the previous function.

Definition at line 26693 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  y0,
const int  z0,
const int  x1,
const int  y1,
const int  z1 
) [inline]

In-place version of the previous function.

Definition at line 26674 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  y0,
const int  z0,
const int  v0,
const int  x1,
const int  y1,
const int  z1,
const int  v1 
) [inline]

In-place version of the previous function.

Definition at line 26655 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::crop ( const unsigned int  i0,
const unsigned int  i1,
const bool  shared = false 
) [inline]

In-place version of the previous function.

Definition at line 26638 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::crop_font (  )  [inline]

In-place version of the previous function.

Definition at line 28055 of file cimg.h.

Referenced by cimg_library::CImgList< T >::get_font().

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::display ( const char  axe = 'x',
const char  align = 'c',
const int  min_size = 128,
const int  max_size = 1024,
const int  print_flag = 1 
) const [inline]

Display the current CImgList instance in a new display window.

This function opens a new window and displays the list images of the current CImgList instance into it. Images of the list are concatenated in a single temporarly image for visualization purposes. The function returns when a key is pressed or the display window is closed by the user.

Parameters:
axe : specify the axe for image concatenation. Can be 'x','y','z' or 'v'.
align : specify the alignment for image concatenation. Can be 'p' (top), 'c' (center) or 'n' (bottom).
min_size : specify the minimum size of the opening display window. Images having dimensions below this size will be upscaled.
max_size : specify the maximum size of the opening display window. Images having dimensions above this size will be downscaled.
Returns:
A reference to the current CImgList instance is returned.

Definition at line 28204 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::display ( const char *  title,
const char  axe = 'x',
const char  align = 'c',
const int  min_size = 128,
const int  max_size = 1024,
const int  print_flag = 1 
) const [inline]

Display the current CImgList instance in a new display window.

This function opens a new window with a specific title and displays the list images of the current CImgList instance into it. Images of the list are concatenated in a single temporarly image for visualization purposes. The function returns when a key is pressed or the display window is closed by the user.

Parameters:
title : specify the title of the opening display window.
axe : specify the axe for image concatenation. Can be 'x','y','z' or 'v'.
align : specify the alignment for image concatenation. Can be 'p' (top), 'c' (center) or 'n' (bottom).
min_size : specify the minimum size of the opening display window. Images having dimensions below this size will be upscaled.
max_size : specify the maximum size of the opening display window. Images having dimensions above this size will be downscaled.
Returns:
A reference to the current CImgList instance is returned.

Definition at line 28171 of file cimg.h.

References cimg_library::CImgDisplay::assign(), cimg_library::CImg< T >::depth, cimg_library::CImg< T >::get_coordinates(), cimg_library::CImg< T >::height, cimg_library::CImgDisplay::is_closed, cimg_library::CImgDisplay::key, cimg_library::max(), cimg_library::min(), and cimg_library::CImg< T >::width.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::display ( CImgDisplay disp,
const char  axe = 'x',
const char  align = 'c' 
) const [inline]

Display the current CImgList instance in an existing CImgDisplay window (by reference).

This function displays the list images of the current CImgList instance into an existing CImgDisplay window. Images of the list are concatenated in a single temporarly image for visualization purposes. The function returns immediately.

Parameters:
disp : reference to an existing CImgDisplay instance, where the current image list will be displayed.
axe : specify the axe for image concatenation. Can be 'x','y','z' or 'v'.
align : specify the alignment for image concatenation. Can be 'p' (top), 'c' (center) or 'n' (bottom).
Returns:
A reference to the current CImgList instance is returned.

Definition at line 28152 of file cimg.h.

template<typename T >
const_iterator cimg_library::CImgList< T >::end (  )  const [inline]

Definition at line 26418 of file cimg.h.

template<typename T >
iterator cimg_library::CImgList< T >::end (  )  [inline]

Returns an iterator just past the last element.

Definition at line 26414 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::erase ( const iterator  iter  )  [inline]

Remove the element pointed by iterator iter;.

Definition at line 26773 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::FFT ( const bool  inverse = false  )  [inline]

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::FFT ( const char  axe,
const bool  inverse = false 
) [inline]

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::font ( const unsigned int  font_width,
const bool  variable_size = true 
) [inline]

In-place version of the previous function.

Definition at line 28138 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::font ( const unsigned int *const   font,
const unsigned int  w,
const unsigned int  h,
const unsigned int  paddingx,
const unsigned int  paddingy,
const bool  variable_size = true 
) [inline]

In-place version of the previous function.

Definition at line 28078 of file cimg.h.

References cimg_library::CImgList< T >::assign_to().

template<typename T >
const CImg<T>& cimg_library::CImgList< T >::front (  )  const [inline]

Definition at line 26400 of file cimg.h.

template<typename T >
CImg<T>& cimg_library::CImgList< T >::front (  )  [inline]

Returns a reference to the first element.

Definition at line 26396 of file cimg.h.

template<typename T >
CImg<T> cimg_library::CImgList< T >::get_append ( const char  axe = 'x',
const char  align = 'c' 
) const [inline]

Return a single image which is the concatenation of all images of the current CImgList instance.

Parameters:
axe : specify the axe for image concatenation. Can be 'x','y','z' or 'v'.
align : specify the alignment for image concatenation. Can be 'p' (top), 'c' (center) or 'n' (bottom).
Returns:
A CImg<T> image corresponding to the concatenation is returned.

Definition at line 27862 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimglist_for, cimg_library::CImg< T >::depth, cimg_library::CImg< T >::dim, cimg_library::CImg< T >::draw_image(), cimg_library::CImg< T >::height, cimg_library::max(), cimg_library::cimg::uncase(), cimg_library::unroll(), and cimg_library::CImg< T >::width.

Referenced by cimg_library::append(), cimg_library::CImgDisplay::display(), cimg_library::CImg< T >::get_append(), cimg_library::CImg< T >::load_cimg(), and cimg_library::CImg< T >::load_parrec().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  x1 
) const [inline]

Get sub-images of a sublist.

Definition at line 26700 of file cimg.h.

References cimglist_for, and cimg_library::CImgList< T >::get_crop().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  y0,
const int  x1,
const int  y1 
) const [inline]

Get sub-images of a sublist.

Definition at line 26681 of file cimg.h.

References cimglist_for, and cimg_library::CImgList< T >::get_crop().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  y0,
const int  z0,
const int  x1,
const int  y1,
const int  z1 
) const [inline]

Get sub-images of a sublist.

Definition at line 26662 of file cimg.h.

References cimglist_for, and cimg_library::CImgList< T >::get_crop().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_crop ( const unsigned int  i0,
const unsigned int  i1,
const int  x0,
const int  y0,
const int  z0,
const int  v0,
const int  x1,
const int  y1,
const int  z1,
const int  v1 
) const [inline]

Get sub-images of a sublist.

Definition at line 26643 of file cimg.h.

References cimglist_for, and cimg_library::CImgList< T >::get_crop().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_crop ( const unsigned int  i0,
const unsigned int  i1,
const bool  shared = false 
) const [inline]

Get a sub-list.

Definition at line 26628 of file cimg.h.

References cimg_library::CImgList< T >::assign(), and cimglist_for.

Referenced by cimg_library::crop(), and cimg_library::CImgList< T >::get_crop().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_crop_font (  )  const [inline]

template<typename T >
CImgList<typename cimg::superset<T,float>::type> cimg_library::CImgList< T >::get_FFT ( const bool  inverse = false  )  const [inline]

Compute the Fast Fourier Transform of a complex image.

Definition at line 26983 of file cimg.h.

References lux::inverse().

template<typename T >
CImgList<typename cimg::superset<T,float>::type> cimg_library::CImgList< T >::get_FFT ( const char  axe,
const bool  inverse = false 
) const [inline]

Compute the Fast Fourier Transform (along the specified axis).

Definition at line 26785 of file cimg.h.

References lux::inverse().

Referenced by cimg_library::FFT().

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_font ( const unsigned int  font_width,
const bool  variable_size = true 
) [inline, static]

Return a CImg pre-defined font with desired size.

Parameters:
font_height = height of the desired font (can be 11,13,24,38 or 57)
fixed_size = tell if the font has a fixed or variable width.

Definition at line 28088 of file cimg.h.

References cimg_library::cimg::font10x13, cimg_library::cimg::font10x19, cimg_library::cimg::font12x24, cimg_library::cimg::font16x32, cimg_library::cimg::font19x38, cimg_library::cimg::font29x57, cimg_library::cimg::font7x11, and cimg_library::cimg::font8x17.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_font ( const unsigned int *const   font,
const unsigned int  w,
const unsigned int  h,
const unsigned int  paddingx,
const unsigned int  paddingy,
const bool  variable_size = true 
) [inline, static]

template<typename T >
template<typename t >
CImgList<typename cimg::superset<T,t>::type> cimg_library::CImgList< T >::get_insert ( const unsigned int  n,
const CImgList< t > &  list,
const unsigned int  pos = ~0U,
const int  shared = 0 
) const [inline]

Insert n copies of the list list at position pos of the current list.

Definition at line 26543 of file cimg.h.

template<typename T >
template<typename t >
CImgList<typename cimg::superset<T,t>::type> cimg_library::CImgList< T >::get_insert ( const CImgList< t > &  list,
const unsigned int  pos = ~0U,
int  shared = 0 
) const [inline]

Insert a copy of the image list list into the current image list, starting from position pos.

Definition at line 26526 of file cimg.h.

template<typename T >
template<typename t >
CImgList<typename cimg::superset<T,t>::type> cimg_library::CImgList< T >::get_insert ( const unsigned int  n,
const CImg< t > &  img,
const unsigned int  pos = ~0U,
const bool  shared = false 
) const [inline]

Insert n copies of the image img into the current image list, at position pos.

Definition at line 26511 of file cimg.h.

template<typename T >
template<typename t >
CImgList<typename cimg::superset<T,t>::type> cimg_library::CImgList< T >::get_insert ( const CImg< t > &  img,
const unsigned int  pos = ~0U,
const bool  shared = false 
) const [inline]

Insert a copy of the image img into the current image list, at position pos.

Definition at line 26424 of file cimg.h.

Referenced by cimg_library::insert().

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load ( const char *const   filename  )  [inline, static]

Load an image list from a file.

Definition at line 27090 of file cimg.h.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load_cimg ( const char *const   filename,
const unsigned int  n0,
const unsigned int  n1,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0,
const unsigned int  x1,
const unsigned int  y1,
const unsigned int  z1,
const unsigned int  v1 
) [inline, static]

Load a sub-image list from a .cimg file.

Definition at line 27235 of file cimg.h.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load_cimg ( std::FILE *const   file,
const unsigned int  n0,
const unsigned int  n1,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0,
const unsigned int  x1,
const unsigned int  y1,
const unsigned int  z1,
const unsigned int  v1 
) [inline, static]

Load a sub-image list from a .cimg file.

Definition at line 27219 of file cimg.h.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load_cimg ( const char *const   filename  )  [inline, static]

Load an image list from a .cimg file.

Definition at line 27209 of file cimg.h.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load_cimg ( std::FILE *const   file,
const char *const   filename = 0 
) [inline, static]

Load an image list from a .cimg file.

Definition at line 27133 of file cimg.h.

template<typename T >
template<typename tf , typename tc >
static CImgList<T> cimg_library::CImgList< T >::get_load_off ( const char *const   filename,
CImgList< tf > &  primitives,
CImgList< tc > &  colors,
const bool  invert_faces = false 
) [inline, static]

Load a 3D object from a .OFF file (GeomView 3D object files).

Definition at line 27555 of file cimg.h.

template<typename T >
template<typename tf , typename tc >
static CImgList<T> cimg_library::CImgList< T >::get_load_off ( std::FILE *const   file,
const char *const   filename,
CImgList< tf > &  primitives,
CImgList< tc > &  colors,
const bool  invert_faces = false 
) [inline, static]

Load a 3D object from a .OFF file (GeomView 3D object files).

Definition at line 27539 of file cimg.h.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load_parrec ( const char *const   filename  )  [inline, static]

Load an image list from a PAR/REC (Philips) file.

Definition at line 27355 of file cimg.h.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load_yuv ( const char *const   filename,
const unsigned int  sizex,
const unsigned int  sizey = 1,
const unsigned int  first_frame = 0,
const int  last_frame = -1,
const bool  yuv2rgb = false 
) [inline, static]

Load an image sequence from a YUV file.

Definition at line 27522 of file cimg.h.

template<typename T >
static CImgList<T> cimg_library::CImgList< T >::get_load_yuv ( std::FILE *const   file,
const char *const   filename,
const unsigned int  sizex,
const unsigned int  sizey = 1,
const unsigned int  first_frame = 0,
const int  last_frame = -1,
const bool  yuv2rgb = false 
) [inline, static]

Load an image sequence from a YUV file.

Definition at line 27448 of file cimg.h.

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_remove (  )  const [inline]

Remove the last image from the image list.

Definition at line 26605 of file cimg.h.

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_remove ( const unsigned int  pos  )  const [inline]

Remove the image at position pos from the image list.

Definition at line 26595 of file cimg.h.

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_remove ( const unsigned int  pos1,
const unsigned int  pos2 
) const [inline]

Remove the images at positions pos1 to pos2 from the image list.

Definition at line 26556 of file cimg.h.

Referenced by cimg_library::remove().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_reverse (  )  const [inline]

Reverse list order.

Definition at line 26617 of file cimg.h.

Referenced by cimg_library::reverse().

template<typename T >
CImgList<T> cimg_library::CImgList< T >::get_split ( const char  axe = 'x'  )  const [inline]

Definition at line 27845 of file cimg.h.

References cimglist_for, and cimg_library::CImgList< T >::insert().

Referenced by cimg_library::split().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::insert ( const unsigned int  n,
const CImgList< t > &  list,
const unsigned int  pos = ~0U,
const int  shared = 0 
) [inline]

In-place version of the previous function.

Definition at line 26549 of file cimg.h.

References cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::insert ( const CImgList< t > &  list,
const unsigned int  pos = ~0U,
const int  shared = 0 
) [inline]

In-place version of the previous function.

Definition at line 26532 of file cimg.h.

References cimglist_for, and cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::insert ( const unsigned int  n,
const CImg< t > &  img,
const unsigned int  pos = ~0U,
const bool  shared = false 
) [inline]

In-place version of the previous function.

Definition at line 26517 of file cimg.h.

References cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::insert ( const CImg< t > &  img  )  [inline]

In-place version of the previous function.

Definition at line 26505 of file cimg.h.

References cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::insert ( const CImg< t > &  img,
const unsigned int  pos 
) [inline]

Definition at line 26500 of file cimg.h.

References cimg_library::insert().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::insert ( const CImg< T > &  img,
const unsigned int  pos,
const bool  shared 
) [inline]

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::insert ( const CImg< t > &  img,
const unsigned int  pos,
const bool  shared 
) [inline]

template<typename T >
bool cimg_library::CImgList< T >::is_empty (  )  const [inline]

Return true if list is empty.

Definition at line 25990 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load ( const char *const   filename  )  [inline]

In-place version of the previous function.

Definition at line 27095 of file cimg.h.

References cimg_library::cimg::filename_split(), and cimg_library::cimg::strncasecmp().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_cimg ( std::FILE *const   file,
const char *const   filename,
const unsigned int  n0,
const unsigned int  n1,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0,
const unsigned int  x1,
const unsigned int  y1,
const unsigned int  z1,
const unsigned int  v1 
) [inline]

In-place version of the previous function.

Definition at line 27251 of file cimg.h.

References cimg_load_cimg_case2, cimg_library::cimg::endian(), cimg_library::cimg::fclose(), cimg_library::cimg::fopen(), N, and cimg_library::cimg::strncasecmp().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_cimg ( const char *const   filename,
const unsigned int  n0,
const unsigned int  n1,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0,
const unsigned int  x1,
const unsigned int  y1,
const unsigned int  z1,
const unsigned int  v1 
) [inline]

In-place version of the previous function.

Definition at line 27243 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_cimg ( std::FILE *const   file,
const unsigned int  n0,
const unsigned int  n1,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0,
const unsigned int  x1,
const unsigned int  y1,
const unsigned int  z1,
const unsigned int  v1 
) [inline]

In-place version of the previous function.

Definition at line 27227 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_cimg ( const char *const   filename  )  [inline]

In-place version of the previous function.

Definition at line 27214 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_cimg ( std::FILE *const   file,
const char *const   filename = 0 
) [inline]

template<typename T >
template<typename tf , typename tc >
CImgList<T>& cimg_library::CImgList< T >::load_off ( const char *const   filename,
CImgList< tf > &  primitives,
CImgList< tc > &  colors,
const bool  invert_faces = false 
) [inline]

In-place version of the previous function.

Definition at line 27563 of file cimg.h.

template<typename T >
template<typename tf , typename tc >
CImgList<T>& cimg_library::CImgList< T >::load_off ( std::FILE *const   file,
const char *const   filename,
CImgList< tf > &  primitives,
CImgList< tc > &  colors,
const bool  invert_faces = false 
) [inline]

In-place version of the previous function.

Definition at line 27547 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_parrec ( const char *const   filename  )  [inline]

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_yuv ( const char *const   filename,
const unsigned int  sizex,
const unsigned int  sizey,
const unsigned int  first_frame = 0,
const int  last_frame = -1,
const bool  yuv2rgb = false 
) [inline]

In-place version of the previous function.

Definition at line 27530 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::load_yuv ( std::FILE *const   file,
const char *const   filename,
const unsigned int  sizex,
const unsigned int  sizey = 1,
const unsigned int  first_frame = 0,
const int  last_frame = -1,
const bool  yuv2rgb = false 
) [inline]

template<typename T >
T& cimg_library::CImgList< T >::max (  )  [inline]

Return a reference to the maximum pixel value of the instance image.

Definition at line 26192 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
const T& cimg_library::CImgList< T >::max (  )  const [inline]

Return a reference to the maximum pixel value of the instance image.

Definition at line 26180 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
template<typename t >
T& cimg_library::CImgList< T >::maxmin ( t &  min_val  )  [inline]

Return a reference to the minimum pixel value of the instance image.

Definition at line 26279 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
template<typename t >
const T& cimg_library::CImgList< T >::maxmin ( t &  min_val  )  const [inline]

Return a reference to the minimum pixel value of the instance image.

Definition at line 26262 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
double cimg_library::CImgList< T >::mean (  )  const [inline]

Return the mean pixel value of the instance image.

Definition at line 26296 of file cimg.h.

References cimg_for, cimglist_for, and cimg_library::CImg< T >::size().

template<typename T >
T& cimg_library::CImgList< T >::min (  )  [inline]

Return a reference to the minimum pixel value of the instance image.

Definition at line 26216 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
const T& cimg_library::CImgList< T >::min (  )  const [inline]

Return a reference to the minimum pixel value of the instance image.

Definition at line 26204 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
template<typename t >
T& cimg_library::CImgList< T >::minmax ( t &  max_val  )  [inline]

Return a reference to the minimum pixel value of the instance image.

Definition at line 26245 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
template<typename t >
const T& cimg_library::CImgList< T >::minmax ( t &  max_val  )  const [inline]

Return a reference to the minimum pixel value of the instance image.

Definition at line 26228 of file cimg.h.

References cimg_for, and cimglist_for.

template<typename T >
cimg_library::CImgList< T >::operator bool (  )  const [inline]

Definition at line 25994 of file cimg.h.

template<typename T >
const T& cimg_library::CImgList< T >::operator() ( const unsigned int  pos,
const unsigned int  x,
const unsigned int  y = 0,
const unsigned int  z = 0,
const unsigned int  v = 0 
) const [inline]

Definition at line 26366 of file cimg.h.

template<typename T >
T& cimg_library::CImgList< T >::operator() ( const unsigned int  pos,
const unsigned int  x,
const unsigned int  y = 0,
const unsigned int  z = 0,
const unsigned int  v = 0 
) [inline]

Return a reference to (x,y,z,v) pixel of the pos-th image of the list.

Definition at line 26362 of file cimg.h.

template<typename T >
const CImg<T>& cimg_library::CImgList< T >::operator() ( const unsigned int  pos  )  const [inline]

Definition at line 26357 of file cimg.h.

template<typename T >
CImg<T>& cimg_library::CImgList< T >::operator() ( const unsigned int  pos  )  [inline]

Equivalent to CImgList<T>::operator[].

Definition at line 26353 of file cimg.h.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator*= ( const CImgList< t > &  list  )  [inline]

Operator*=.

Definition at line 26156 of file cimg.h.

References cimg_library::min(), N, and cimg_library::CImgList< T >::size.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator*= ( const t  val  )  [inline]

Operator*=.

Definition at line 26149 of file cimg.h.

References cimglist_for.

template<typename T >
CImgList<T> cimg_library::CImgList< T >::operator+ (  )  const [inline]

Operator+.

Definition at line 26074 of file cimg.h.

template<typename T >
CImgList<T> cimg_library::CImgList< T >::operator++ ( int   )  [inline]

Operator++ (postfix).

Definition at line 26102 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::operator++ (  )  [inline]

Operator++ (prefix).

Definition at line 26096 of file cimg.h.

References cimglist_for.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator+= ( const CImgList< t > &  list  )  [inline]

Operator+=.

Definition at line 26089 of file cimg.h.

References cimg_library::min(), and cimg_library::CImgList< T >::size.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator+= ( const t  val  )  [inline]

Operator+=.

Definition at line 26082 of file cimg.h.

References cimglist_for.

template<typename T >
CImgList<T> cimg_library::CImgList< T >::operator- (  )  const [inline]

Operator-.

Definition at line 26109 of file cimg.h.

References cimg_library::CImgList< T >::assign(), and cimglist_for.

template<typename T >
CImgList<T> cimg_library::CImgList< T >::operator-- ( int   )  [inline]

Operator-- (postfix).

Definition at line 26139 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::operator-- (  )  [inline]

Operator-- (prefix).

Definition at line 26133 of file cimg.h.

References cimglist_for.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator-= ( const CImgList< t > &  list  )  [inline]

Operator-=.

Definition at line 26126 of file cimg.h.

References cimg_library::min(), and cimg_library::CImgList< T >::size.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator-= ( const t  val  )  [inline]

Operator-=.

Definition at line 26119 of file cimg.h.

References cimglist_for.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator/= ( const CImgList< t > &  list  )  [inline]

Operator/=.

Definition at line 26173 of file cimg.h.

References cimg_library::min(), N, and cimg_library::CImgList< T >::size.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator/= ( const t  val  )  [inline]

Operator/=.

Definition at line 26166 of file cimg.h.

References cimglist_for.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator<< ( const CImgList< t > &  list  )  [inline]

Insert a copy of the image list list at the end of the current image list.

Definition at line 26722 of file cimg.h.

References cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator<< ( const CImg< t > &  img  )  [inline]

Insert a copy of the image img at the end of the current image list.

Definition at line 26717 of file cimg.h.

References cimg_library::insert().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::operator= ( const T  val  )  [inline]

Assignment operator.

Definition at line 26068 of file cimg.h.

References cimglist_for.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator= ( const CImg< t > &  img  )  [inline]

Assignment operator.

Definition at line 26062 of file cimg.h.

References cimglist_for.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::operator= ( const CImgList< T > &  list  )  [inline]

Definition at line 26057 of file cimg.h.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator= ( const CImgList< t > &  list  )  [inline]

Assignment operator.

Definition at line 26053 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::operator>> ( CImgDisplay disp  )  const [inline]

Display an image list into a CImgDisplay.

Definition at line 26738 of file cimg.h.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator>> ( CImgList< t > &  list  )  const [inline]

Insert a copy of the current image list at the beginning of the image list list.

Definition at line 26733 of file cimg.h.

References cimg_library::CImgList< T >::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator>> ( CImg< t > &  img  )  const [inline]

Return a copy of the current image list, where the image img has been inserted at the end.

Definition at line 26727 of file cimg.h.

template<typename T >
const CImg<T>& cimg_library::CImgList< T >::operator[] ( const unsigned int  pos  )  const [inline]

Definition at line 26342 of file cimg.h.

References cimg_library::cimg::warn().

template<typename T >
CImg<T>& cimg_library::CImgList< T >::operator[] ( const unsigned int  pos  )  [inline]

Return a reference to the i-th element of the image list.

Definition at line 26332 of file cimg.h.

References cimg_library::cimg::warn().

template<typename T >
static const char* cimg_library::CImgList< T >::pixel_type (  )  [inline, static]

Return a string describing the type of the image pixels in the list (template parameter T).

Definition at line 25985 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::pop_back (  )  [inline]

Remove last element of the list;.

Definition at line 26763 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::pop_front (  )  [inline]

Remove first element of the list;.

Definition at line 26768 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::print ( const int  print_flag  )  const [inline]

Display informations about the list on the standard output.

Definition at line 27085 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::print ( const char *  title = 0,
const int  print_flag = 1 
) const [inline]

Print informations about the list on the standard output.

Definition at line 27058 of file cimg.h.

References cimglist_for.

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::push_back ( const CImgList< t > &  list  )  [inline]

Insert list list at the end of the current list.

Definition at line 26753 of file cimg.h.

References cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::push_back ( const CImg< t > &  img  )  [inline]

Insert image img at the end of the list.

Definition at line 26743 of file cimg.h.

References cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::push_front ( const CImgList< t > &  list  )  [inline]

Insert list list at the front of the current list.

Definition at line 26758 of file cimg.h.

References cimg_library::insert().

template<typename T >
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::push_front ( const CImg< t > &  img  )  [inline]

Insert image img at the front of the list.

Definition at line 26748 of file cimg.h.

References cimg_library::insert().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::remove (  )  [inline]

In-place version of the previous function.

Definition at line 26610 of file cimg.h.

References cimg_library::cimg::warn().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::remove ( const unsigned int  pos  )  [inline]

In-place version of the previous function.

Definition at line 26600 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::remove ( const unsigned int  pos1,
const unsigned int  pos2 
) [inline]

In-place version of the previous function.

Definition at line 26561 of file cimg.h.

References memcpy(), and cimg_library::cimg::warn().

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::reverse (  )  [inline]

In-place version of the previous function.

Definition at line 26622 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save ( const char *const   filename,
const int  number = -1 
) const [inline]

Save an image list into a file.

Depending on the extension of the given filename, a file format is chosen for the output file.

Definition at line 27572 of file cimg.h.

References cimglist_for, cimg_library::cimg::filename_number(), cimg_library::cimg::filename_split(), and cimg_library::cimg::strncasecmp().

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save_cimg ( const char *const   filename,
const unsigned int  n0,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0 
) const [inline]

Insert the instance image into into an existing .cimg file, at specified coordinates.

Definition at line 27791 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save_cimg ( std::FILE *const   file,
const unsigned int  n0,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0 
) const [inline]

Insert the instance image into into an existing .cimg file, at specified coordinates.

Definition at line 27783 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save_cimg ( std::FILE *const   file,
const char *const   filename,
const unsigned int  n0,
const unsigned int  x0,
const unsigned int  y0,
const unsigned int  z0,
const unsigned int  v0 
) const [inline]

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save_cimg ( const char *const   filename  )  const [inline]

Save an image list into a CImg file (RAW binary file + simple header).

Definition at line 27672 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save_cimg ( std::FILE *const   file,
const char *const   filename = 0 
) const [inline]

Save an image list into a .cimg file.

A CImg RAW file is a simple uncompressed binary file that may be used to save list of CImg<T> images.

Parameters:
filename : name of the output file.
Returns:
A reference to the current CImgList instance is returned.

Definition at line 27647 of file cimg.h.

References cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::depth, cimg_library::CImg< T >::dim, cimg_library::cimg::endian(), cimg_library::cimg::endian_swap(), cimg_library::cimg::fclose(), cimg_library::cimg::fopen(), cimg_library::cimg::fwrite(), cimg_library::CImg< T >::height, cimg_library::CImg< T >::size(), cimg_library::cimg::strncmp(), and cimg_library::CImg< T >::width.

Referenced by cimg_library::CImg< T >::save_cimg().

template<typename T >
static void cimg_library::CImgList< T >::save_empty_cimg ( const char *const   filename,
const unsigned int  nb,
const unsigned int  dx,
const unsigned int  dy = 1,
const unsigned int  dz = 1,
const unsigned int  dv = 1 
) [inline, static]

Create an empty .cimg file with specified dimensions.

Definition at line 27822 of file cimg.h.

template<typename T >
static void cimg_library::CImgList< T >::save_empty_cimg ( std::FILE *const   file,
const unsigned int  nb,
const unsigned int  dx,
const unsigned int  dy = 1,
const unsigned int  dz = 1,
const unsigned int  dv = 1 
) [inline, static]

Create an empty .cimg file with specified dimensions.

Definition at line 27814 of file cimg.h.

template<typename T >
static void cimg_library::CImgList< T >::save_empty_cimg ( std::FILE *const   file,
const char *const   filename,
const unsigned int  nb,
const unsigned int  dx,
const unsigned int  dy = 1,
const unsigned int  dz = 1,
const unsigned int  dv = 1 
) [inline, static]

Definition at line 27799 of file cimg.h.

References cimg_library::cimg::fclose(), and cimg_library::cimg::fopen().

template<typename T >
template<typename tf , typename tc >
const CImgList<T>& cimg_library::CImgList< T >::save_off ( const char *const   filename,
const CImgList< tf > &  primitives,
const CImgList< tc > &  colors,
const bool  invert_faces = false 
) const [inline]

Save an image list into a OFF file.

Definition at line 27839 of file cimg.h.

template<typename T >
template<typename tf , typename tc >
const CImgList<T>& cimg_library::CImgList< T >::save_off ( std::FILE *const   file,
const char *const   filename,
const CImgList< tf > &  primitives,
const CImgList< tc > &  colors,
const bool  invert_faces = false 
) const [inline]

Save an image list into a OFF file.

Definition at line 27831 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save_yuv ( const char *const   filename = 0,
const bool  rgb2yuv = true 
) const [inline]

Save an image sequence into a YUV file.

Definition at line 27637 of file cimg.h.

template<typename T >
const CImgList<T>& cimg_library::CImgList< T >::save_yuv ( std::FILE *const   file,
const char *const   filename = 0,
const bool  rgb2yuv = true 
) const [inline]

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::split ( const char  axe = 'x'  )  [inline]

In-place version of the previous function.

Definition at line 27852 of file cimg.h.

template<typename T >
CImgList<T>& cimg_library::CImgList< T >::swap ( CImgList< T > &  list  )  [inline]

template<typename T >
double cimg_library::CImgList< T >::variance (  )  [inline]

Return the variance of the image.

Definition at line 26309 of file cimg.h.

References cimg_for, cimglist_for, and cimg_library::CImg< T >::size().


Member Data Documentation

template<typename T >
unsigned int cimg_library::CImgList< T >::allocsize

Allocation size of the list.

Definition at line 25622 of file cimg.h.

Referenced by cimg_library::CImgList< T >::swap().

template<typename T >
CImg<T>* cimg_library::CImgList< T >::data

template<typename T >
unsigned int cimg_library::CImgList< T >::size


The documentation for this struct was generated from the following file:

Generated on Mon May 18 07:19:18 2009 for lux by  doxygen 1.5.7.1