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)
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	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).
Fourier Transforms
CImgList< Tfloat >	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)
	Compute the Fast Fourier Transform (along the specified axis) (in-place).
CImgList< Tfloat >	get_FFT (const bool invert=false) const
	Compute the Fast Fourier Transform of a complex image.
CImgList< T > &	FFT (const bool invert=false)
	Compute the Fast Fourier Transform of a complex image (in-place).
CImgList< T >	get_split (const char axe='x') const
CImgList< T > &	split (const char axe='x')
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 ()
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)
CImgList< T > &	font (const unsigned int font_width, const bool variable_size=true)
	Return a CImg pre-defined font with desired size.
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 *const title=0, const unsigned normalization_type=1, 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_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.
Input-Output
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 (in-place).
CImgList< T > &	_load_cimg (std::FILE *const file, const char *const filename)
CImgList< T > &	load_cimg (const char *const filename)
	Load an image list from a .cimg file (in-place).
CImgList< T > &	load_cimg (std::FILE *const file)
	Load an image list from a .cimg file (in-place).
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)
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 (in-place).
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 (in-place).
CImgList< T > &	load_parrec (const char *const filename)
	Load an image list from a PAR/REC (Philips) file (in-place).
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, const unsigned int last_frame, const unsigned int step_frame, const bool yuv2rgb)
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 (in-place).
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 (in-place).
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 (in-place).
CImgList< T > &	load_ffmpeg_external (const char *const filename)
	Load an image from a video file (MPEG,AVI) using the external tool 'ffmpeg (in-place).
CImgList< T > &	load_gzip_external (const char *const filename)
	Load a gzipped list, using external tool 'gunzip' (in-place).
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 (in-place).
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 (in-place).
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, const bool rgb2yuv) const
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 *const file, const char *const filename, const bool compression) const
	Save an image list into a .cimg 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 (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 (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 char *const codec="mpeg2video") const
	Save an image sequence using the external tool 'ffmpeg'.
static CImgList< T >	get_load (const char *const filename)
	Load an image list from a 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)
	Load an 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 non compressed .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 non compressed .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 (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 (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)
	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'.
static CImgList< T >	get_load_gzip_external (const char *const filename)
	Load a gzipped list, using external tool 'gunzip'.
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.
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 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, const unsigned int dz, const unsigned int dv)
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 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 &g