cimg_library::CImgList< T > Struct Template Reference

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

#include <cimg.h>

Collaboration diagram for cimg_library::CImgList< T >:
[legend]

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 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 list.
T & max ()
 Return a reference to the maximum pixel value of the instance list.
const T & min () const
 Return a reference to the minimum pixel value of the instance list.
T & min ()
 Return a reference to the minimum pixel value of the instance list.
template<typename t >
const T & minmax (t &max_val) const
 Return a reference to the minimum pixel value of the instance list.
template<typename t >
T & minmax (t &max_val)
 Return a reference to the minimum pixel value of the instance list.
template<typename t >
const T & maxmin (t &min_val) const
 Return a reference to the minimum pixel value of the instance list.
template<typename t >
T & maxmin (t &min_val)
 Return a reference to the minimum pixel value of the instance list.
double mean () const
 Return the mean pixel value of the instance list.
double variance ()
 Return the variance of the instance list.
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 unsigned int pos=~0U) const
 Insert n empty images img into the current image list, at position pos.
CImgList< T > & insert (const unsigned int n, const unsigned int pos=~0U)
 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, const bool shared=false) 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 bool shared=false)
 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 bool shared=false) 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 bool shared=false)
 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 invert=false) const
 Compute the Fast Fourier Transform (along the specified axis).
CImgList< T > & FFT (const char axe, const bool invert=false)
 In-place version of the previous function.
CImgList< typename
cimg::superset< T, float >
::type > 
get_FFT (const bool invert=false) const
 Compute the Fast Fourier Transform of a complex image.
CImgList< T > & FFT (const bool invert=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.

Constructors - Destructor - Copy



 ~CImgList ()
 Destructor.
 CImgList ()
 Default constructor.
 CImgList (const unsigned int n)
 Construct an image list containing n empty images.
template<typename t >
 CImgList (const CImgList< t > &list)
 Default copy constructor.
 CImgList (const CImgList< T > &list)
template<typename t >
 CImgList (const CImgList< t > &list, const bool shared)
 Advanced copy constructor.
 CImgList (const CImgList< T > &list, const bool shared)
 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 (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 specified value.
 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 (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).
template<typename t >
 CImgList (const unsigned int n, const CImg< t > &img)
 Construct a list containing n copies of the image img.
template<typename t >
 CImgList (const unsigned int n, const CImg< t > &img, const bool shared)
 Construct a list containing n copies of the image img, forcing the shared state.
template<typename t >
 CImgList (const CImg< t > &img)
 Construct an image list from one image.
template<typename t >
 CImgList (const CImg< t > &img, const bool shared)
 Construct an image list from one image, forcing the shared state.
template<typename t1 , typename t2 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2)
 Construct an image list from two images.
template<typename t1 , typename t2 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const bool shared)
template<typename t1 , typename t2 , typename t3 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3)
 Construct an image list from three images.
template<typename t1 , typename t2 , typename t3 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const bool shared)
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)
 Construct an image list from four images.
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)
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)
 Construct an image list from five images.
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)
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)
 Construct an image list from six images.
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)
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)
 Construct an image list from seven images.
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)
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)
 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 (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)
 CImgList (const char *const filename)
 Construct an image list from a filename.
CImgList< T > & assign ()
 In-place version of the default constructor and default destructor.
CImgList< T > & clear ()
 Equivalent to assign() (STL-compliant name).
CImgList< T > & assign (const unsigned int n)
 In-place version of the previous constructor.
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< 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< 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< 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< T > & assign (const CImgList< t > &list)
 In-place version of the copy constructor.
template<typename t >
CImgList< T > & assign (const CImgList< t > &list, const bool shared)
 In-place version of the copy constructor.
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< T > & assign (const CImg< t > &img, const bool shared=false)
 In-place version of the previous constructor.
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< 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< 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< 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< 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< 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< 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< T > & assign (const char *const filename)
 In-place version of the previous constructor.
template<typename t >
CImgList< T > & transfer_to (CImgList< t > &list)
 Transfer the content of the instance image list into another one.
CImgList< T > & transfer_to (CImgList< T > &list)
CImgList< T > & swap (CImgList< T > &list)
 Swap all data fields of two CImgList instances. Use with care !
bool is_empty () const
 Return true if list is empty.
 operator bool () const
bool containsNXYZV (const int n, const int x=0, const int y=0, const int z=0, const int v=0) const
 Return true if the list contains the pixel (n,x,y,z,v).
bool containsN (const int n) const
 Return true if the list contains the image (n).
template<typename t >
bool contains (const T &pixel, t &n, t &x, t &y, t &z, t &v) const
 Return true if one of the image list contains the pixel. If true, set coordinates (n,x,y,z,v).
template<typename t >
bool contains (const T &pixel, t &n, t &x, t &y, t &z) const
 Return true if one of the image list contains the pixel. If true, set coordinates (n,x,y,z).
template<typename t >
bool contains (const T &pixel, t &n, t &x, t &y) const
 Return true if one of the image list contains the pixel. If true, set coordinates (n,x,y).
template<typename t >
bool contains (const T &pixel, t &n, t &x) const
 Return true if one of the image list contains the pixel. If true, set coordinates (n,x).
template<typename t >
bool contains (const T &pixel, t &n) const
 Return true if one of the image list contains the pixel. If true, set coordinates (n).
bool contains (const T &pixel) const
 Return true if one of the image list contains the pixel.
template<typename t >
bool contains (const CImg< T > &img, t &n) const
 Return true if the list contains the image 'img'. If true, returns the position (n) of the image in the list.
bool contains (const CImg< T > &img) const
 Return true if the list contains the image img.
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 bool display_stats=true) const
 Print 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, const unsigned int first_frame=0, const unsigned int last_frame=~0U, const unsigned int step_frame=1, const bool yuv2rgb=true)
 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 unsigned int last_frame=~0U, const unsigned int step_frame=1, const bool yuv2rgb=true)
 In-place version of the previous function.
CImgList< T > & load_ffmpeg (const char *const filename, const unsigned int first_frame=0, const unsigned int last_frame=~0U, const unsigned int step_frame=1, const bool pixel_format=true, const bool resume=false)
 In-place version of the previous function.
CImgList< T > & load_ffmpeg_external (const char *const filename)
 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.
CImgList< T > & load_tiff (const char *const filename, const unsigned int first_frame=0, const unsigned int last_frame=~0U, const unsigned int step_frame=1)
 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.
const CImgList< T > & save_ffmpeg_external (const char *const filename, const char *const codec="mpeg2video") const
 Save an image sequence using the external tool 'ffmpeg'.
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=0, const bool display_info=true, const char axe='x', const char align='c') 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 unsigned int last_frame=~0U, const unsigned int step_frame=1, const bool yuv2rgb=true)
 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 unsigned int last_frame=~0U, const unsigned int step_frame=1, const bool yuv2rgb=true)
 Load an image sequence from a YUV file.
static CImgList< T > get_load_ffmpeg (const char *const filename, const unsigned int first_frame=0, const unsigned int last_frame=~0U, const unsigned int step_frame=1, const bool pixel_format=true)
 Load an image from a video file, using ffmpeg libraries.
static CImgList< T > get_load_ffmpeg_external (const char *const filename)
 Load an image from a video file (MPEG,AVI) using the external tool 'ffmpeg'.
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 CImgList< T > get_load_tiff (const char *const filename, const unsigned int first_frame=0, const unsigned int last_frame=~0U, const unsigned int step_frame=1)
 Load a (possibly multi-page) tiff file.
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>.

Definition at line 28651 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 28666 of file cimg.h.

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

Define a CImgList<T>::iterator.

Definition at line 28663 of file cimg.h.

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

Get value type.

Definition at line 28669 of file cimg.h.


Constructor & Destructor Documentation

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

Destructor.

Definition at line 28713 of file cimg.h.

References cimg_library::CImg< T >::data.

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

Default constructor.

Definition at line 28718 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 28722 of file cimg.h.

References cimg_library::CImg< T >::data, cimg_library::CImg< T >::max(), and cimg_library::cimg::nearest_pow2().

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

Default copy constructor.

Definition at line 28728 of file cimg.h.

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

template<typename T>
cimg_library::CImgList< T >::CImgList ( const CImgList< T > &  list  )  [inline]
template<typename T>
template<typename t >
cimg_library::CImgList< T >::CImgList ( const CImgList< t > &  list,
const bool  shared 
) [inline]
template<typename T>
cimg_library::CImgList< T >::CImgList ( const CImgList< T > &  list,
const bool  shared 
) [inline]
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 28756 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimglist_for, cimg_library::CImg< T >::data, and cimg_library::CImg< T >::depth.

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

Definition at line 28764 of file cimg.h.

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

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 28772 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 28779 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 
) [inline]

Construct a list containing n copies of the image img.

Definition at line 28786 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimglist_for, cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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

Construct a list containing n copies of the image img, forcing the shared state.

Definition at line 28793 of file cimg.h.

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

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

Construct an image list from one image.

Definition at line 28800 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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

Construct an image list from one image, forcing the shared state.

Definition at line 28807 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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

Construct an image list from two images.

Definition at line 28814 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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

Definition at line 28820 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 
) [inline]

Construct an image list from three images.

Definition at line 28827 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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 
) [inline]

Definition at line 28833 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 
) [inline]

Construct an image list from four images.

Definition at line 28841 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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 
) [inline]

Definition at line 28848 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 
) [inline]

Construct an image list from five images.

Definition at line 28856 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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 
) [inline]

Definition at line 28865 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 
) [inline]

Construct an image list from six images.

Definition at line 28875 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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 
) [inline]

Definition at line 28884 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 
) [inline]

Construct an image list from seven images.

Definition at line 28894 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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 
) [inline]

Definition at line 28903 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 
) [inline]

Construct an image list from eight images.

Definition at line 28913 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_shared.

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 
) [inline]

Definition at line 28922 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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

Construct an image list from a filename.

Definition at line 28931 of file cimg.h.

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


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 29085 of file cimg.h.

References cimg_library::CImg< T >::load().

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 29076 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29066 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29056 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29046 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29037 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29029 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29021 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29013 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::data.

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 29006 of file cimg.h.

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

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

In-place version of the copy constructor.

Definition at line 28999 of file cimg.h.

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

template<typename T>
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::assign ( const CImgList< t > &  list  )  [inline]
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 28985 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 28978 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 28970 of file cimg.h.

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

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 28962 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimglist_for, cimg_library::CImg< T >::data, and cimg_library::CImg< T >::depth.

template<typename T>
CImgList<T>& cimg_library::CImgList< T >::assign ( const unsigned int  n  )  [inline]
template<typename T>
CImgList<T>& cimg_library::CImgList< T >::assign (  )  [inline]
template<typename T>
const CImg<T>& cimg_library::CImgList< T >::at ( const unsigned int  pos  )  const [inline]
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 29513 of file cimg.h.

References cimg_library::CImg< T >::data, cimg_library::CImg< T >::pixel_type(), and cimg_library::CImg< T >::size().

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

Definition at line 29532 of file cimg.h.

References cimg_library::CImg< T >::size().

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

Returns a reference to last element.

Definition at line 29528 of file cimg.h.

References cimg_library::CImg< T >::size().

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

Definition at line 29550 of file cimg.h.

References cimg_library::CImg< T >::data.

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

Returns an iterator to the beginning of the vector.

Definition at line 29546 of file cimg.h.

References cimg_library::CImg< T >::data.

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

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

Definition at line 28945 of file cimg.h.

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

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

Return true if the list contains the image img.

Definition at line 29181 of file cimg.h.

References cimg_library::CImg< T >::contains().

template<typename T>
template<typename t >
bool cimg_library::CImgList< T >::contains ( const CImg< T > &  img,
t &  n 
) const [inline]

Return true if the list contains the image 'img'. If true, returns the position (n) of the image in the list.

Definition at line 29173 of file cimg.h.

References cimglist_for, cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_empty().

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 29167 of file cimg.h.

References cimg_library::CImg< T >::contains().

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

Return true if one of the image list contains the pixel. If true, set coordinates (n).

Definition at line 29161 of file cimg.h.

References cimg_library::CImg< T >::contains().

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

Return true if one of the image list contains the pixel. If true, set coordinates (n,x).

Definition at line 29155 of file cimg.h.

References cimg_library::CImg< T >::contains().

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

Return true if one of the image list contains the pixel. If true, set coordinates (n,x,y).

Definition at line 29149 of file cimg.h.

References cimg_library::CImg< T >::contains().

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

Return true if one of the image list contains the pixel. If true, set coordinates (n,x,y,z).

Definition at line 29143 of file cimg.h.

References cimg_library::CImg< T >::contains().

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

Return true if one of the image list contains the pixel. If true, set coordinates (n,x,y,z,v).

Definition at line 29136 of file cimg.h.

References cimglist_for, cimg_library::CImg< T >::contains(), cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_empty().

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

Return true if the list contains the image (n).

Definition at line 29130 of file cimg.h.

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

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

Return true if the list contains the pixel (n,x,y,z,v).

Definition at line 29124 of file cimg.h.

References cimg_library::CImg< T >::data, and cimg_library::CImg< T >::is_empty().

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 29865 of file cimg.h.

References cimg_library::CImg< T >::get_crop().

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 29847 of file cimg.h.

References cimg_library::CImg< T >::get_crop().

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 29828 of file cimg.h.

References cimg_library::CImg< T >::get_crop().

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 29809 of file cimg.h.

References cimg_library::CImg< T >::get_crop().

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 29792 of file cimg.h.

References cimg_library::CImg< T >::get_crop().

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

In-place version of the previous function.

Definition at line 31479 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 *  title = 0,
const bool  display_info = true,
const char  axe = 'x',
const char  align = 'c' 
) 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).
Returns:
A reference to the current CImgList instance is returned.

Definition at line 31591 of file cimg.h.

References cimg_library::CImg< T >::data, cimg_library::CImg< T >::display(), cimg_library::CImg< T >::get_append(), cimg_library::CImg< T >::is_empty(), cimg_library::CImg< T >::pixel_type(), and cimg_library::CImg< T >::print().

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 31576 of file cimg.h.

References cimg_library::CImg< T >::get_append().

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

Definition at line 29559 of file cimg.h.

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

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

Returns an iterator just past the last element.

Definition at line 29555 of file cimg.h.

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

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

Remove the element pointed by iterator iter;.

Definition at line 29927 of file cimg.h.

References cimg_library::CImg< T >::data.

template<typename T>
CImgList<T>& cimg_library::CImgList< T >::FFT ( const bool  invert = false  )  [inline]
template<typename T>
CImgList<T>& cimg_library::CImgList< T >::FFT ( const char  axe,
const bool  invert = 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 31562 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 31502 of file cimg.h.

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

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

Definition at line 29541 of file cimg.h.

References cimg_library::CImg< T >::data.

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

Returns a reference to the first element.

Definition at line 29537 of file cimg.h.

References cimg_library::CImg< T >::data.

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 31286 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::CImg< T >::is_empty(), cimg_library::CImg< T >::max(), cimg_library::CImg< T >::pixel_type(), cimg_library::CImg< T >::size(), cimg_library::cimg::uncase(), cimg_library::CImg< T >::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]
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]
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]
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]
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]
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  invert = false  )  const [inline]

Compute the Fast Fourier Transform of a complex image.

Definition at line 30137 of file cimg.h.

References cimg_library::CImg< T >::invert().

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

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

Definition at line 29939 of file cimg.h.

References cimg_library::CImg< T >::invert().

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 31512 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 bool  shared = false 
) const [inline]

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

Definition at line 29697 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,
const bool  shared = false 
) const [inline]

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

Definition at line 29682 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 29667 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 unsigned int  pos = ~0U 
) const [inline]

Insert n empty images img into the current image list, at position pos.

Definition at line 29652 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 29565 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 30235 of file cimg.h.

References cimg_library::CImg< T >::load().

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 30387 of file cimg.h.

References cimg_library::CImg< T >::load_cimg().

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 30371 of file cimg.h.

References cimg_library::CImg< T >::load_cimg().

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 30361 of file cimg.h.

References cimg_library::CImg< T >::load_cimg().

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 30285 of file cimg.h.

References cimg_library::CImg< T >::load_cimg().

template<typename T>
static CImgList<T> cimg_library::CImgList< T >::get_load_ffmpeg ( const char *const   filename,
const unsigned int  first_frame = 0,
const unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1,
const bool  pixel_format = true 
) [inline, static]

Load an image from a video file, using ffmpeg libraries.

Definition at line 30691 of file cimg.h.

References cimg_library::CImg< T >::load_ffmpeg().

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

Load an image from a video file (MPEG,AVI) using the external tool 'ffmpeg'.

Definition at line 30813 of file cimg.h.

References cimg_library::CImg< T >::load_ffmpeg_external().

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 30870 of file cimg.h.

References cimg_library::CImg< T >::load_off().

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 30854 of file cimg.h.

References cimg_library::CImg< T >::load_off().

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 30507 of file cimg.h.

References cimg_library::CImg< T >::load_parrec().

template<typename T>
static CImgList<T> cimg_library::CImgList< T >::get_load_tiff ( const char *const   filename,
const unsigned int  first_frame = 0,
const unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1 
) [inline, static]

Load a (possibly multi-page) tiff file.

Definition at line 30884 of file cimg.h.

References cimg_library::CImg< T >::load_tiff().

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 unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1,
const bool  yuv2rgb = true 
) [inline, static]

Load an image sequence from a YUV file.

Definition at line 30675 of file cimg.h.

References cimg_library::CImg< T >::load_yuv().

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 unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1,
const bool  yuv2rgb = true 
) [inline, static]

Load an image sequence from a YUV file.

Definition at line 30600 of file cimg.h.

References cimg_library::CImg< T >::load_yuv().

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

Remove the last image from the image list.

Definition at line 29759 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 29749 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 29710 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 29771 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]
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 bool  shared = false 
) [inline]

In-place version of the previous function.

Definition at line 29703 of file cimg.h.

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

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

In-place version of the previous function.

Definition at line 29688 of file cimg.h.

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

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 29673 of file cimg.h.

References cimg_library::CImg< T >::data, cimg_library::insert(), and cimg_library::CImg< T >::size().

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

In-place version of the previous function.

Definition at line 29658 of file cimg.h.

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

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 29646 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 29641 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 29115 of file cimg.h.

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

template<typename T>
CImgList<T>& cimg_library::CImgList< T >::load ( const char *const   filename  )  [inline]
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]
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 30395 of file cimg.h.

References cimg_library::CImg< T >::load_cimg().

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 30379 of file cimg.h.

References cimg_library::CImg< T >::load_cimg().

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 30366 of file cimg.h.

References cimg_library::CImg< T >::load_cimg().

template<typename T>
CImgList<T>& cimg_library::CImgList< T >::load_cimg ( std::FILE *const   file,
const char *const   filename = 0 
) [inline]
template<typename T>
CImgList<T>& cimg_library::CImgList< T >::load_ffmpeg ( const char *const   filename,
const unsigned int  first_frame = 0,
const unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1,
const bool  pixel_format = true,
const bool  resume = false 
) [inline]
template<typename T>
CImgList<T>& cimg_library::CImgList< T >::load_ffmpeg_external ( const char *const   filename  )  [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 30878 of file cimg.h.

References cimg_library::CImg< T >::load_off().

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 30862 of file cimg.h.

References cimg_library::CImg< T >::assign(), and cimg_library::CImg< T >::get_split().

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_tiff ( const char *const   filename,
const unsigned int  first_frame = 0,
const unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1 
) [inline]

In-place version of the previous function.

Definition at line 30891 of file cimg.h.

References cimg_library::CImg< T >::assign(), cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::pixel_type(), and cimg_library::cimg::warn().

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 unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1,
const bool  yuv2rgb = true 
) [inline]

In-place version of the previous function.

Definition at line 30683 of file cimg.h.

References cimg_library::CImg< T >::load_yuv().

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,
const unsigned int  first_frame = 0,
const unsigned int  last_frame = ~0U,
const unsigned int  step_frame = 1,
const bool  yuv2rgb = true 
) [inline]
template<typename T>
T& cimg_library::CImgList< T >::max (  )  [inline]

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

Definition at line 29333 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

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

Definition at line 29321 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

Definition at line 29420 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

Definition at line 29403 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

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

Definition at line 29357 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

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

Definition at line 29345 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

Definition at line 29386 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

Definition at line 29369 of file cimg.h.

References cimg_for, cimglist_for, cimg_library::CImg< T >::data, cimg_library::CImg< T >::is_empty(), and cimg_library::CImg< T >::pixel_type().

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

Definition at line 29119 of file cimg.h.

References cimg_library::CImg< T >::is_empty().

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 29507 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 29503 of file cimg.h.

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

Definition at line 29498 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 29494 of file cimg.h.

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

Operator*=.

Definition at line 29290 of file cimg.h.

References cimglist_for.

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

Operator+.

Definition at line 29215 of file cimg.h.

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

Operator++ (postfix).

Definition at line 29243 of file cimg.h.

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

Operator++ (prefix).

Definition at line 29237 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]
template<typename T>
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator+= ( const t  val  )  [inline]

Operator+=.

Definition at line 29223 of file cimg.h.

References cimglist_for.

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

Operator-- (postfix).

Definition at line 29280 of file cimg.h.

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

Operator-- (prefix).

Definition at line 29274 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]
template<typename T>
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator-= ( const t  val  )  [inline]

Operator-=.

Definition at line 29260 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]
template<typename T>
template<typename t >
CImgList<T>& cimg_library::CImgList< T >::operator/= ( const t  val  )  [inline]

Operator/=.

Definition at line 29307 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 29876 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 29871 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 29209 of file cimg.h.

References cimglist_for, and cimg_library::CImg< T >::data.

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

Assignment operator.

Definition at line 29203 of file cimg.h.

References cimglist_for, and cimg_library::CImg< T >::data.

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

Definition at line 29198 of file cimg.h.

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

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

Assignment operator.

Definition at line 29194 of file cimg.h.

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

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 29892 of file cimg.h.

References cimg_library::CImg< T >::display().

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 29887 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 29881 of file cimg.h.

template<typename T>
const CImg<T>& cimg_library::CImgList< T >::operator[] ( const unsigned int  pos  )  const [inline]
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 29473 of file cimg.h.

References cimg_library::CImg< T >::data, cimg_library::CImg< T >::pixel_type(), cimg_library::CImg< T >::size(), and 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 29110 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 29917 of file cimg.h.

References cimg_library::CImg< T >::size().

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

Remove first element of the list;.

Definition at line 29922 of file cimg.h.

template<typename T>
const CImgList<T>& cimg_library::CImgList< T >::print ( const char *  title = 0,
const bool  display_stats = true 
) const [inline]

Print informations about the list on the standard output.

Definition at line 30212 of file cimg.h.

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

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 29907 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 29897 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 29912 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 29902 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 29764 of file cimg.h.

References cimg_library::CImg< T >::pixel_type(), cimg_library::CImg< T >::size(), and 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 29754 of file cimg.h.

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

In-place version of the previous function.

Definition at line 29776 of file cimg.h.

References cimg_library::CImg< T >::size().

template<typename T>
const CImgList<T>& cimg_library::CImgList< T >::save ( const char *const   filename,
const int  number = -1 
) const [inline]
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 31156 of file cimg.h.

References cimg_library::CImg< T >::save_cimg().

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 31148 of file cimg.h.

References cimg_library::CImg< T >::save_cimg().

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 31037 of file cimg.h.

References cimg_library::CImg< T >::save_cimg().

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 31012 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 >::is_empty(), cimg_library::CImg< T >::pixel_type(), 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 31187 of file cimg.h.

References cimg_library::CImg< T >::save_empty_cimg().

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 31179 of file cimg.h.

References cimg_library::CImg< T >::save_empty_cimg().

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]
template<typename T>
const CImgList<T>& cimg_library::CImgList< T >::save_ffmpeg_external ( const char *const   filename,
const char *const   codec = "mpeg2video" 
) const [inline]
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 31227 of file cimg.h.

References cimg_library::CImg< T >::save_off().

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 31219 of file cimg.h.

References cimg_library::CImg< T >::get_append().

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 31002 of file cimg.h.

References cimg_library::CImg< T >::save_yuv().

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 31276 of file cimg.h.

References cimg_library::CImg< T >::get_split().

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

Transfer the content of the instance image list into another one.

Definition at line 29090 of file cimg.h.

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

Referenced by cimg_library::CImgList< T >::font(), cimg_library::CImg< T >::load_cimg(), and cimg_library::CImg< T >::load_parrec().

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

Member Data Documentation

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

Allocation size of the list.

Definition at line 28657 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 by  doxygen 1.6.2-20100208