[ Main ] [ News ] [ Download ] [ Screenshots ] [ FAQ ] [ Tutorial ] [ Documentation ] [ Forum ] [ Online Chat ] [ Links ] [ ]

CImgList< T > Struct Template Reference

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

List of all members.

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 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.

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).

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 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.

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.

Detailed Description

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

Class representing list of images CImg<T>.


Member Function Documentation

const CImgList<T>& save ( const char *const   filename,
const int  number = -1 
) const

Save an image list into a file.

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

const CImgList<T>& save_cimg ( std::FILE *const   file,
const char *const   filename = 0 
) const

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.
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.

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.
static CImgList<T> get_font ( const unsigned int  font_width,
const bool  variable_size = true 
) [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.
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).

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.
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.

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.
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.

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.
The CImg Library - C++ Template Image Processing Library