<xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

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

# CImgList Struct Template Reference

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

List of all members.

## 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)
| Construct an image list from two images, forcing the shared state.
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)
| Construct an image list from three images, forcing the shared state.
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)
| Construct an image list from four images, forcing the shared state.
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)
| Construct an image list from five images, forcing the shared state.
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)
| Construct an image list from six images, forcing the shared state.
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)
| Construct an image list from seven images, forcing the shared state.
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)
| Construct an image list from eight images, forcing the shared state.
| 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 corresponding 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 corresponding 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 corresponding 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 corresponding 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 corresponding 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 corresponding constructor.
template<typename t >
CImgList< T > & | assign (const CImg< t > &img, const bool shared=false)
| In-place version of the corresponding 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 corresponding 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 corresponding 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 corresponding 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 corresponding 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 corresponding 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 corresponding 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 corresponding constructor.
CImgList< T > & | assign (const char *const filename)
| In-place version of the corresponding 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)
template<typename t >
CImgList< t > & | transfer_to (CImgList< t > &list, const unsigned int pos)
CImgList< T > & | swap (CImgList< T > &list)
| Swap all fields of two CImgList instances (use with care !).
bool | is_empty () const
| Return `true` if list is empty.
| operator bool () const
| Return `true` if list is not empty.
bool | is_sameN (const unsigned int n) const
| Return `true` if list if of specified size.
template<typename t >
bool | is_sameN (const CImgList< t > &list) const
| Return `true` if list if of specified size.
template<typename t >
bool | is_sameXY (const CImg< t > &img) const
template<typename t >
bool | is_sameXY (const CImgList< t > &list) const
template<typename t >
bool | is_sameNXY (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNXY (const CImgList< t > &list) const
template<typename t >
bool | is_sameXZ (const CImg< t > &img) const
template<typename t >
bool | is_sameXZ (const CImgList< t > &list) const
template<typename t >
bool | is_sameNXZ (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNXZ (const CImgList< t > &list) const
template<typename t >
bool | is_sameXV (const CImg< t > &img) const
template<typename t >
bool | is_sameXV (const CImgList< t > &list) const
template<typename t >
bool | is_sameNXV (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNXV (const CImgList< t > &list) const
template<typename t >
bool | is_sameYZ (const CImg< t > &img) const
template<typename t >
bool | is_sameYZ (const CImgList< t > &list) const
template<typename t >
bool | is_sameNYZ (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNYZ (const CImgList< t > &list) const
template<typename t >
bool | is_sameYV (const CImg< t > &img) const
template<typename t >
bool | is_sameYV (const CImgList< t > &list) const
template<typename t >
bool | is_sameNYV (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNYV (const CImgList< t > &list) const
template<typename t >
bool | is_sameXYZ (const CImg< t > &img) const
template<typename t >
bool | is_sameXYZ (const CImgList< t > &list) const
template<typename t >
bool | is_sameNXYZ (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNXYZ (const CImgList< t > &list) const
template<typename t >
bool | is_sameXYV (const CImg< t > &img) const
template<typename t >
bool | is_sameXYV (const CImgList< t > &list) const
template<typename t >
bool | is_sameNXYV (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNXYV (const CImgList< t > &list) const
template<typename t >
bool | is_sameYZV (const CImg< t > &img) const
template<typename t >
bool | is_sameYZV (const CImgList< t > &list) const
template<typename t >
bool | is_sameNYZV (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNYZV (const CImgList< t > &list) const
template<typename t >
bool | is_sameXYZV (const CImg< t > &img) const
template<typename t >
bool | is_sameXYZV (const CImgList< t > &list) const
template<typename t >
bool | is_sameNXYZV (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool | is_sameNXYZV (const CImgList< t > &list) const
bool | is_sameX (const unsigned int val) const
bool | is_sameNX (const unsigned int n, const unsigned int val) const
bool | is_sameY (const unsigned int val) const
bool | is_sameNY (const unsigned int n, const unsigned int val) const
bool | is_sameZ (const unsigned int val) const
bool | is_sameNZ (const unsigned int n, const unsigned int val) const
bool | is_sameV (const unsigned int val) const
bool | is_sameNV (const unsigned int n, const unsigned int val) const
bool | is_sameXY (const unsigned int val1, const unsigned int val2) const
bool | is_sameNXY (const unsigned int n, const unsigned int val1, const unsigned int val2) const
bool | is_sameXZ (const unsigned int val1, const unsigned int val2) const
bool | is_sameNXZ (const unsigned int n, const unsigned int val1, const unsigned int val2) const
bool | is_sameXV (const unsigned int val1, const unsigned int val2) const
bool | is_sameNXV (const unsigned int n, const unsigned int val1, const unsigned int val2) const
bool | is_sameYZ (const unsigned int val1, const unsigned int val2) const
bool | is_sameNYZ (const unsigned int n, const unsigned int val1, const unsigned int val2) const
bool | is_sameYV (const unsigned int val1, const unsigned int val2) const
bool | is_sameNYV (const unsigned int n, const unsigned int val1, const unsigned int val2) const
bool | is_sameZV (const unsigned int val1, const unsigned int val2) const
bool | is_sameNZV (const unsigned int n, const unsigned int val1, const unsigned int val2) const
bool | is_sameXYZ (const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameNXYZ (const unsigned int n, const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameXYV (const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameNXYV (const unsigned int n, const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameXZV (const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameNXZV (const unsigned int n, const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameYZV (const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameNYZV (const unsigned int n, const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool | is_sameXYZV (const unsigned int dx, const unsigned int dy, const unsigned int dz, const unsigned int dv) const
bool | is_sameNXYZV (const unsigned int n, const unsigned int dx, const unsigned int dy, const unsigned int dz, const unsigned int dv) 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 specified referenced value. 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 specified referenced value. 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 specified referenced value. 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 specified referenced value. 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 specified referenced value. If true, set coordinates (n).
bool | contains (const T &pixel) const
| Return `true` if one of the image list contains the specified referenced value.
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`).
static CImgList< T > & | empty ()
| Return a reference to an empty list.

## 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.
CImgList< T > & | stats (const unsigned int variance_method=1)
| Compute a list of statistics vectors (min,max,mean,variance,xmin,ymin,zmin,vmin,xmax,ymax,zmax,vmax).
CImgList< Tfloat > | get_stats (const unsigned int variance_method=1) const

## 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 int pos)
| Read an image in specified position.
T & | atNXYZV (const int pos, const int x, const int y, const int z, const int v, const T out_val)
| Read a pixel value with Dirichlet boundary conditions.
T | atNXYZV (const int pos, const int x, const int y, const int z, const int v, const T out_val) const
T & | atNXYZV (const int pos, const int x, const int y, const int z, const int v)
| Read a pixel value with Neumann boundary conditions.
T | atNXYZV (const int pos, const int x, const int y, const int z, const int v) const
T & | atNXYZ (const int pos, const int x, const int y, const int z, const int v, const T out_val)
| Read a pixel value with Dirichlet boundary conditions for the four first coordinates (`pos`, `x`,`y`,`z`).
T | atNXYZ (const int pos, const int x, const int y, const int z, const int v, const T out_val) const
T & | atNXYZ (const int pos, const int x, const int y, const int z, const int v=0)
| Read a pixel value with Neumann boundary conditions for the four first coordinates (`pos`, `x`,`y`,`z`).
T | atNXYZ (const int pos, const int x, const int y, const int z, const int v=0) const
T & | atNXY (const int pos, const int x, const int y, const int z, const int v, const T out_val)
| Read a pixel value with Dirichlet boundary conditions for the three first coordinates (`pos`, `x`,`y`).
T | atNXY (const int pos, const int x, const int y, const int z, const int v, const T out_val) const
T & | atNXY (const int pos, const int x, const int y, const int z=0, const int v=0)
| Read a pixel value with Neumann boundary conditions for the three first coordinates (`pos`, `x`,`y`).
T | atNXY (const int pos, const int x, const int y, const int z=0, const int v=0) const
T & | atNX (const int pos, const int x, const int y, const int z, const int v, const T out_val)
| Read a pixel value with Dirichlet boundary conditions for the two first coordinates (`pos`,`x`).
T | atNX (const int pos, const int x, const int y, const int z, const int v, const T out_val) const
T & | atNX (const int pos, const int x, const int y=0, const int z=0, const int v=0)
| Read a pixel value with Neumann boundary conditions for the two first coordinates (`pos`, `x`).
T | atNX (const int pos, const int x, const int y=0, const int z=0, const int v=0) const
T & | atN (const int pos, const int x, const int y, const int z, const int v, const T out_val)
| Read a pixel value with Dirichlet boundary conditions for the first coordinates (`pos`).
T | atN (const int pos, const int x, const int y, const int z, const int v, const T out_val) const
T & | atN (const int pos, const int x=0, const int y=0, const int z=0, const int v=0)
| Read a pixel value with Neumann boundary conditions for the first coordinates (`pos`).
T | atN (const int pos, const int x=0, const int y=0, const int z=0, const int v=0) const
CImg< T > & | back ()
| Returns a reference to the 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
const CImg< T > & | first () const
| Return a reference to the first image.
CImg< T > & | first ()
iterator | end ()
| Returns an iterator just past the last element.
const_iterator | end () const
const CImg< T > & | last () const
| Return a reference to the last image.
CImg< T > & | last ()
template<typename t >
CImgList< T > & | insert (const CImg< t > &img, const unsigned int pos, const bool shared)
| Insert a copy of the image `img` into the current image list, at position `pos`.
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)
| Insert a copy of the image `img` into the current image list, at position `pos`.
template<typename t >
CImgList< T > | get_insert (const CImg< t > &img, const unsigned int pos=~0U, const bool shared=false) const
CImgList< T > & | insert (const unsigned int n, const unsigned int pos=~0U)
| Insert n empty images img into the current image list, at position `pos`.
CImgList< T > | get_insert (const unsigned int n, const unsigned int pos=~0U) const
template<typename t >
CImgList< T > & | insert (const unsigned int n, const CImg< t > &img, const unsigned int pos=~0U, const bool shared=false)
| Insert n copies of the image `img` into the current image list, at position `pos`.
template<typename t >
CImgList< T > | get_insert (const unsigned int n, const CImg< t > &img, const unsigned int pos=~0U, const bool shared=false) const
template<typename t >
CImgList< T > & | insert (const CImgList< t > &list, const unsigned int pos=~0U, const bool shared=false)
| Insert a copy of the image list `list` into the current image list, starting from position `pos`.
template<typename t >
CImgList< T > | get_insert (const CImgList< t > &list, const unsigned int pos=~0U, const bool shared=false) const
template<typename t >
CImgList< T > & | insert (const unsigned int n, const CImgList< t > &list, const unsigned int pos=~0U, const bool shared=false)
| Insert n copies of the list `list` at position `pos` of the current list.
template<typename t >
CImgList< T > | get_insert (const unsigned int n, const CImgList< t > &list, const unsigned int pos=~0U, const bool shared=false) const
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`.
CImgList< T > & | remove (const unsigned int pos1, const unsigned int pos2)
| Remove the images at positions `pos1` to `pos2` from the image list.
CImgList< T > | get_remove (const unsigned int pos1, const unsigned int pos2) const
CImgList< T > & | remove (const unsigned int pos)
| Remove the image at position `pos` from the image list.
CImgList< T > | get_remove (const unsigned int pos) const
CImgList< T > & | remove ()
| Remove the last image from the image list.
CImgList< T > | get_remove () const
CImgList< T > & | reverse ()
| Reverse list order.
CImgList< T > | get_reverse () const
CImgList< T > & | crop (const unsigned int i0, const unsigned int i1, const bool shared=false)
| Get a sub-list.
CImgList< T > | get_crop (const unsigned int i0, const unsigned int i1, const bool shared=false) const
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)
| Get sub-images of a sublist.
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
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)
| Get sub-images of a sublist.
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
CImgList< T > & | crop (const unsigned int i0, const unsigned int i1, const int x0, const int y0, const int x1, const int y1)
| Get sub-images of a sublist.
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
CImgList< T > & | crop (const unsigned int i0, const unsigned int i1, const int x0, const int x1)
| Get sub-images of a sublist.
CImgList< T > | get_crop (const unsigned int i0, const unsigned int i1, const int x0, const int x1) const
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< T > & | FFT (const char axis, const bool invert=false)
| Compute the Fast Fourier Transform (along the specified axis).
CImgList< Tfloat > | get_FFT (const char axis, const bool invert=false) const
CImgList< T > & | FFT (const bool invert=false)
| Compute the Fast Fourier Transform of a complex image.
CImgList< Tfloat > | get_FFT (const bool invert=false) const
CImgList< T > & | split (const char axis, const int nb=0)
CImgList< T > | get_split (const char axis, const int nb=0) const
CImg< T > | get_append (const char axis, const char align='p') const
| Return a single image which is the concatenation of all images of the current CImgList instance.
CImgList< T > & | crop_font ()
| Create an auto-cropped font (along the X axis) from a input font `font`.
CImgList< T > | get_crop_font () const
CImgList< T > & | invert_object3d ()
| Invert primitives orientation of a 3D object.
CImgList< T > | get_invert_object3d () const
const CImgList< T > & | display (CImgDisplay &disp, const char axis='x', const char align='p') const
| Display the current CImgList instance in an existing CImgDisplay window (by reference).
const CImgList< T > & | display (CImgDisplay &disp, const bool display_info, const char axis='x', const char align='p') const
| Display the current CImgList instance in a new display window.
const CImgList< T > & | display (const char *const title=0, const bool display_info=true, const char axis='x', const char align='p') const
| Display the current CImgList instance in a new display window.
static CImgList< T > | font (const unsigned int font_width, const bool variable_size=true)
| Return a CImg pre-defined font with desired size.

## Input-Output

CImg< charT > | value_string (const char separator=',', const unsigned int max_size=0) const
| Return a C-string containing the values of all images in the instance list.
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)
| Load an image list from a file.
CImgList< T > & | load_cimg (const char *const filename)
| Load an image list from a .cimg file.
CImgList< T > & | load_cimg (std::FILE *const file)
| Load an image list from a .cimg file.
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)
| Load a sub-image list from a non compressed .cimg file.
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)
| Load a sub-image list from a non compressed .cimg file.
CImgList< T > & | load_parrec (const char *const filename)
| Load an image list from a PAR/REC (Philips) file.
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)
| Load an image sequence from a YUV file.
CImgList< T > & | load_yuv (std::FILE *const file, 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)
| Load an image sequence from a YUV file.
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)
| Load an image from a video file, using ffmpeg libraries.
CImgList< T > & | load_ffmpeg_external (const char *const filename)
| Load an image from a video file (MPEG,AVI) using the external tool 'ffmpeg'.
CImgList< T > & | load_gzip_external (const char *const filename)
| Load a gzipped list, using external tool 'gunzip'.
template<typename tf , typename tc >
CImgList< T > & | 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.
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)
| Load a TIFF file.
const CImgList< T > & | save (const char *const filename, const int number=-1) const
| Save an image list into a file.
const CImgList< T > & | save_ffmpeg (const char *const filename, const unsigned int first_frame=0, const unsigned int last_frame=~0U, const unsigned int fps=25) const
| Save an image sequence, using FFMPEG library.
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_yuv (std::FILE *const file, const bool rgb2yuv=true) const
| Save an image sequence into a YUV file.
const CImgList< T > & | save_cimg (std::FILE *file, const bool compress=false) const
| Save an image list into a CImg file (RAW binary file + simple header).
const CImgList< T > & | save_cimg (const char *const filename, const bool compress=false) const
| Save an image list into a CImg file (RAW binary file + simple header).
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.
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_gzip_external (const char *const filename) const
| Save a file in TIFF format.
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.
template<typename tf , typename tc >
const CImgList< T > & | save_off (std::FILE *const file, 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 unsigned int first_frame=0, const unsigned int last_frame=~0U, const char *const codec="mpeg2video") const
| Save an image sequence using the external tool 'ffmpeg'.
static CImgList< T > | get_load (const char *const filename)
static CImgList< T > | get_load_cimg (const char *const filename)
static CImgList< T > | get_load_cimg (std::FILE *const 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)
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)
static CImgList< T > | get_load_parrec (const char *const filename)
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)
static CImgList< T > | get_load_yuv (std::FILE *const file, 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)
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)
static CImgList< T > | get_load_ffmpeg_external (const char *const filename)
static CImgList< T > | get_load_gzip_external (const char *const filename)
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)
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)
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 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.

## Public Types

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

## Public Attributes

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

## Detailed Description

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

Class representing list of images CImg<T>.

## Member Function Documentation

CImg<T> get_append | ( | const char | axis,
|  | const char | align = `'p'` |
| ) |  |  | const

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

Parameters:

  | axis | : specify the axis for image concatenation. Can be 'x','y','z' or 'v'.
  | align | : specify the alignment for image concatenation. Can be 'p' (top), 'c' (center) or 'n' (bottom).

Returns:
  A CImg<T> image corresponding to the concatenation is returned.

static CImgList<T> font | ( | const unsigned int | font_width,
|  | const bool | variable_size = `true` |
| ) |  |  | `[static]`

Return a CImg pre-defined font with desired size.

Parameters:

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

const CImgList<T>& display | ( | CImgDisplay & | disp,
|  | const char | axis = `'x'`,
|  | const char | align = `'p'` |
| ) |  |  | const

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

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

Parameters:

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

Returns:
  A reference to the current CImgList instance is returned.

const CImgList<T>& display | ( | CImgDisplay & | disp,
|  | const bool | display_info,
|  | const char | axis = `'x'`,
|  | const char | align = `'p'` |
| ) |  |  | const

Display the current CImgList instance in a new display window.

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

Parameters:

  | title | : specify the title of the opening display window.
  | axis | : specify the axis for image concatenation. Can be 'x','y','z' or 'v'.
  | align | : specify the alignment for image concatenation. Can be 'p' (top), 'c' (center) or 'n' (bottom).

Returns:
  A reference to the current CImgList instance is returned.

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

Save an image list into a file.

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

const CImgList<T>& save_gzip_external | ( | const char *const | filename | ) | const

Save a file in TIFF format.

Save an image list as a gzipped file, using external tool 'gzip'.