The CImg Library - C++ Template Image Processing Toolkit





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

CImgList< T > Struct Template Reference

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

List of all members.

Public Types

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

Constructors / Destructor / Instance Management

 ~CImgList ()
 Destructor.
 CImgList ()
 Default constructor.
 CImgList (const unsigned int n)
 Construct an image list containing n empty images.
 CImgList (const unsigned int n, const unsigned int width, const unsigned int height=1, const unsigned int depth=1, const unsigned int spectrum=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 spectrum, 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 spectrum, 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 spectrum, 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, const bool shared=false)
 Construct a list containing n copies of the image img.
template<typename t >
 CImgList (const CImg< t > &img, const bool shared=false)
 Construct an image list from one image.
template<typename t1 , typename t2 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const bool shared=false)
 Construct an image list from two images.
template<typename t1 , typename t2 , typename t3 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const bool shared=false)
 Construct an image list from three images.
template<typename t1 , typename t2 , typename t3 , typename t4 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const bool shared=false)
 Construct an image list from four images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const bool shared=false)
 Construct an image list from five images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const bool shared=false)
 Construct an image list from six images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const CImg< t7 > &img7, const bool shared=false)
 Construct an image list from seven images.
template<typename t1 , typename t2 , typename t3 , typename t4 , typename t5 , typename t6 , typename t7 , typename t8 >
 CImgList (const CImg< t1 > &img1, const CImg< t2 > &img2, const CImg< t3 > &img3, const CImg< t4 > &img4, const CImg< t5 > &img5, const CImg< t6 > &img6, const CImg< t7 > &img7, const CImg< t8 > &img8, const bool shared=false)
 Construct an image list from eight images.
template<typename 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 char *const filename)
 Construct an image list from a filename.
 CImgList (const CImgDisplay &disp)
 Construct an image list from a display.
CImgList< T > get_shared ()
 Return a shared instance of the list.
const CImgList< T > get_shared () const
 Return a shared instance of the list.
CImgList< T > & assign ()
 In-place version of the default constructor and default destructor.
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 spectrum=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 spectrum, 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 spectrum, 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 spectrum, const double val0, const double val1,...)
 In-place version of the corresponding constructor.
CImgList< T > & assign (const CImgList< T > &list, const bool shared=false)
 In-place version of the copy constructor.
template<typename t >
CImgList< T > & assign (const CImgList< t > &list, const bool shared=false)
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.
CImgList< T > & assign (const CImgDisplay &disp)
 In-place version of the corresponding constructor.
CImgList< T > & clear ()
 In-place version of the default constructor.
template<typename t >
CImgList< t > & move_to (CImgList< t > &list)
 Move the content of the image instance list into another one.
template<typename t >
CImgList< t > & move_to (CImgList< t > &list, const unsigned int pos)
CImgList< T > & swap (CImgList< T > &list)
 Swap all fields of two CImgList instances (use with care !)
static CImgList< T > & empty ()
 Return a reference to an empty list.

Overloaded Operators

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
T & operator() (const unsigned int pos, const unsigned int x, const unsigned int y=0, const unsigned int z=0, const unsigned int c=0)
 Return a reference to (x,y,z,c) 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 c=0) const
 operator const CImg< T > * () const
 Return address of the image vector.
 operator CImg< T > * ()
template<typename t >
CImgList< T > & operator= (const CImg< t > &img)
 Operator=().
CImgList< T > & operator= (const CImgDisplay &disp)
 Operator=().
template<typename t >
CImgList< T > & operator= (const CImgList< t > &list)
 Operator=().
CImgList< T > & operator= (const CImgList< T > &list)
CImgList< T > & operator= (const char *const filename)
 Operator=().
CImgList< T > operator+ () const
 Operator+() (unary).
template<typename t >
CImgList< T > & operator, (const CImg< t > &img)
 Operator,().
template<typename t >
CImgList< T > & operator, (const CImgList< t > &list)
 Operator,().
CImg< T > operator> (const char axis) const
 Operator>().
CImgList< T > operator< (const char axis) const
 Operator<().

Instance Characteristics

int width () const
 Return the size of the list.
unsigned int size () const
 Return the size of the list.
CImg< T > * data ()
 Return a pointer to the image buffer.
const CImg< T > * data () const
CImg< T > * data (const unsigned int l)
 Return a pointer to the image buffer.
const CImg< T > * data (const unsigned int l) const
iterator begin ()
 Returns an iterator to the beginning of the vector (STL-compliant name).
const_iterator begin () const
iterator end ()
 Returns an iterator just past the last element (STL-compliant name).
const_iterator end () const
CImg< T > & front ()
 Returns a reference to the first element (STL-compliant name).
const CImg< T > & front () const
const CImg< T > & back () const
 Return a reference to the last image (STL-compliant name).
CImg< T > & back ()
CImg< T > & at (const int pos)
 Read an image in specified position.
T & atNXYZC (const int pos, const int x, const int y, const int z, const int c, const T out_value)
 Get pixel value with Dirichlet boundary conditions.
atNXYZC (const int pos, const int x, const int y, const int z, const int c, const T out_value) const
T & atNXYZC (const int pos, const int x, const int y, const int z, const int c)
 Get pixel value with Neumann boundary conditions.
atNXYZC (const int pos, const int x, const int y, const int z, const int c) const
T & atNXYZ (const int pos, const int x, const int y, const int z, const int c, const T out_value)
 Get pixel value with Dirichlet boundary conditions for the four first coordinates (pos, x,y,z).
atNXYZ (const int pos, const int x, const int y, const int z, const int c, const T out_value) const
T & atNXYZ (const int pos, const int x, const int y, const int z, const int c=0)
 Get pixel value with Neumann boundary conditions for the four first coordinates (pos, x,y,z).
atNXYZ (const int pos, const int x, const int y, const int z, const int c=0) const
T & atNXY (const int pos, const int x, const int y, const int z, const int c, const T out_value)
 Get pixel value with Dirichlet boundary conditions for the three first coordinates (pos, x,y).
atNXY (const int pos, const int x, const int y, const int z, const int c, const T out_value) const
T & atNXY (const int pos, const int x, const int y, const int z=0, const int c=0)
 Get pixel value with Neumann boundary conditions for the three first coordinates (pos, x,y).
atNXY (const int pos, const int x, const int y, const int z=0, const int c=0) const
T & atNX (const int pos, const int x, const int y, const int z, const int c, const T out_value)
 Get pixel value with Dirichlet boundary conditions for the two first coordinates (pos,x).
atNX (const int pos, const int x, const int y, const int z, const int c, const T out_value) const
T & atNX (const int pos, const int x, const int y=0, const int z=0, const int c=0)
 Get pixel value with Neumann boundary conditions for the two first coordinates (pos, x).
atNX (const int pos, const int x, const int y=0, const int z=0, const int c=0) const
T & atN (const int pos, const int x, const int y, const int z, const int c, const T out_value)
 Get pixel value with Dirichlet boundary conditions for the first coordinates (pos).
atN (const int pos, const int x, const int y, const int z, const int c, const T out_value) const
T & atN (const int pos, const int x=0, const int y=0, const int z=0, const int c=0)
 Get pixel value with Neumann boundary conditions for the first coordinates (pos).
atN (const int pos, const int x=0, const int y=0, const int z=0, const int c=0) const
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.
static const char * pixel_type ()
 Return a string describing the type of the image pixels in the list (template parameter T).

Instance Checking

bool is_empty () const
 Return true if list is 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_sameXC (const CImg< t > &img) const
template<typename t >
bool is_sameXC (const CImgList< t > &list) const
template<typename t >
bool is_sameNXC (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool is_sameNXC (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_sameYC (const CImg< t > &img) const
template<typename t >
bool is_sameYC (const CImgList< t > &list) const
template<typename t >
bool is_sameNYC (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool is_sameNYC (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_sameXYC (const CImg< t > &img) const
template<typename t >
bool is_sameXYC (const CImgList< t > &list) const
template<typename t >
bool is_sameNXYC (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool is_sameNXYC (const CImgList< t > &list) const
template<typename t >
bool is_sameYZC (const CImg< t > &img) const
template<typename t >
bool is_sameYZC (const CImgList< t > &list) const
template<typename t >
bool is_sameNYZC (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool is_sameNYZC (const CImgList< t > &list) const
template<typename t >
bool is_sameXYZC (const CImg< t > &img) const
template<typename t >
bool is_sameXYZC (const CImgList< t > &list) const
template<typename t >
bool is_sameNXYZC (const unsigned int n, const CImg< t > &img) const
template<typename t >
bool is_sameNXYZC (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_sameC (const unsigned int val) const
bool is_sameNC (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_sameXC (const unsigned int val1, const unsigned int val2) const
bool is_sameNXC (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_sameYC (const unsigned int val1, const unsigned int val2) const
bool is_sameNYC (const unsigned int n, const unsigned int val1, const unsigned int val2) const
bool is_sameZC (const unsigned int val1, const unsigned int val2) const
bool is_sameNZC (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_sameXYC (const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool is_sameNXYC (const unsigned int n, const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool is_sameXZC (const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool is_sameNXZC (const unsigned int n, const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool is_sameYZC (const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool is_sameNYZC (const unsigned int n, const unsigned int val1, const unsigned int val2, const unsigned int val3) const
bool is_sameXYZC (const unsigned int dx, const unsigned int dy, const unsigned int dz, const unsigned int dc) const
bool is_sameNXYZC (const unsigned int n, const unsigned int dx, const unsigned int dy, const unsigned int dz, const unsigned int dc) const
bool containsNXYZC (const int n, const int x=0, const int y=0, const int z=0, const int c=0) const
 Return true if the list contains the pixel (n,x,y,z,c).
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 &c) const
 Return true if one of the image list contains the specified referenced value. If true, set coordinates (n,x,y,z,c).
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.

Mathematical Functions

T & min ()
 Return a reference to the minimum pixel value of the instance list.
const T & min () const
T & max ()
 Return a reference to the maximum pixel value of the instance list.
const T & max () const
template<typename t >
T & min_max (t &max_val)
 Return a reference to the minimum pixel value of the instance list.
template<typename t >
const T & min_max (t &max_val) const
template<typename t >
T & max_min (t &min_val)
 Return a reference to the minimum pixel value of the instance list.
template<typename t >
const T & max_min (t &min_val) const

List Manipulation

template<typename t >
CImgList< T > & insert (const CImg< t > &img, const unsigned int pos=~0U, const bool shared=false)
 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=~0U, const bool shared=false)
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
CImgList< T > & remove (const unsigned int pos1, const unsigned int pos2)
 Remove the images from positions pos1 to pos2.
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 > & images (const unsigned int i0, const unsigned int i1)
 Get a sub-list.
CImgList< T > get_images (const unsigned int i0, const unsigned int i1) const
CImgList< T > get_shared_images (const unsigned int i0, const unsigned int i1)
 Get a shared sub-list.
const CImgList< T > get_shared_images (const unsigned int i0, const unsigned int i1) const
CImg< T > get_append (const char axis, const float align=0) const
 Return a single image which is the concatenation of all images of the current CImgList instance.
CImgList< T > & split (const char axis, const int nb=0)
 Return a list where each image has been split along the specified axis.
CImgList< T > get_split (const char axis, const int nb=0) const
template<typename t >
CImgList< T > & push_back (const CImg< t > &img)
 Insert image img at the end of the list (STL-compliant name).
template<typename t >
CImgList< T > & push_front (const CImg< t > &img)
 Insert image img at the front of the list (STL-compliant name).
template<typename t >
CImgList< T > & push_back (const CImgList< t > &list)
 Insert list list at the end of the current list (STL-compliant name).
template<typename t >
CImgList< T > & push_front (const CImgList< t > &list)
 Insert list list at the front of the current list (STL-compliant name).
CImgList< T > & pop_back ()
 Remove last element of the list (STL-compliant name).
CImgList< T > & pop_front ()
 Remove first element of the list (STL-compliant name).
CImgList< T > & erase (const iterator iter)
 Remove the element pointed by iterator iter (STL-compliant name).

Data Input

CImg< intT > get_select (CImgDisplay &disp, const bool feature_type=true, const char axis='x', const float align=0) const
 Simple interface to select sub-lists or single images in a list.
CImg< intT > get_select (const char *const title, const bool feature_type=true, const char axis='x', const float align=0) const
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 c0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int c1)
 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 c0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int c1)
 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)
 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.
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 c0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int c1)
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 c0, const unsigned int x1, const unsigned int y1, const unsigned int z1, const unsigned int c1)
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)
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)

Data Output

const CImgList< T > & print (const char *const title=0, const bool display_stats=true) const
 Print informations about the list on the standard output.
const CImgList< T > & display (CImgDisplay &disp, const char axis='x', const float align=0) 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 float align=0) 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 float align=0) const
 Display the current CImgList instance in a new display window.
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 unsigned int bitrate=2048) 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 c0) const
 Insert the image instance 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 c0) const
 Insert the image instance into into an existing .cimg file, at specified coordinates.
const CImgList< T > & save_tiff (const char *const filename, const unsigned int compression=0) const
 Save a file in TIFF format.
const CImgList< T > & save_gzip_external (const char *const filename) const
 Save an image list as a gzipped file, using external tool 'gzip'.
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 unsigned int fps=25, const unsigned int bitrate=2048) const
 Save an image sequence using the external tool 'ffmpeg'.
static bool is_saveable (const char *const filename)
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 dc=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 dc=1)
 Create an empty .cimg file with specified dimensions.

Others

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 > & FFT (const char axis, const bool invert=false)
 Compute a 1-D Fast Fourier Transform, along specified axis.
CImgList< Tfloat > get_FFT (const char axis, const bool invert=false) const
CImgList< T > & FFT (const bool invert=false)
 Compute a n-d Fast Fourier Transform.
CImgList< Tfloat > get_FFT (const bool invert=false) const
CImgList< T > & reverse_object3d ()
 Invert primitives orientation of a 3d object.
CImgList< T > get_reverse_object3d () const
static const CImgList< T > & font (const unsigned int font_height, const bool variable_size=true)
 Return a CImg pre-defined font with desired size.

Detailed Description

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

Class representing list of images CImg<T>.


Member Function Documentation

CImgList<T>& clear ( )

In-place version of the default constructor.

Equivalent to assign().

Note:
  • It has been defined for compatibility with STL naming conventions.
See also:
assign().
CImgList<T> operator+ ( ) const

Operator+() (unary).

Writing '+list' is a convenient shortcut to 'CImgList<T>(list,false)' (forces a copy with non-shared elements).

CImg<T> get_append ( const char  axis,
const float  align = 0 
) 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 'c'.
align: specify the alignment for image concatenation. Can be '0' (top), '0.5' (center) or '1' (bottom) for instance.
Returns:
A CImg<T> image corresponding to the concatenation is returned.
const CImgList<T>& display ( CImgDisplay disp,
const char  axis = 'x',
const float  align = 0 
) 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 'c'.
align: specify the alignment for image concatenation.
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 float  align = 0 
) 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 'c'.
align: specify the alignment for image concatenation.
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.

static const CImgList<T>& font ( const unsigned int  font_height,
const bool  variable_size = true 
) [static]

Return a CImg pre-defined font with desired size.

Parameters:
font_height= height of the desired font (exact match for 11,13,17,19,24,32,38,57)
fixed_size= tell if the font has a fixed or variable width.

Support This Project