vidl_vil1_image_list_codec Class Reference

#include <vidl_vil1_image_list_codec.h>

Inheritance diagram for vidl_vil1_image_list_codec:

Detailed Description

Coder/decoder for a list of images.

A vidl_vil1_image_list_codec is the video I/O access for list of images.

Definition at line 22 of file vidl_vil1_image_list_codec.h.


Public Member Functions
	vidl_vil1_image_list_codec ()
	Basic constructor. Should not be called unless we initialize the codec by some ways.
	vidl_vil1_image_list_codec (vcl_list< vil1_image > &images)
	Constructor, from a list of images.
	vidl_vil1_image_list_codec (vcl_vector< vil1_image > &images)
	Constructor, from a vector of images.
	~vidl_vil1_image_list_codec ()
virtual vidl_vil1_image_list_codec *	casttovidl_vil1_image_list_codec ()
virtual bool	get_section (int position, void *ib, int x0, int y0, int w, int h) const
	Get a section of pixels in function of the frame number, position and size.
virtual int	put_section (int position, void *ib, int x0, int y0, int w, int h)
	Put a section of pixels in function of the frame number, position and size.
virtual vidl_vil1_codec_sptr	load (vcl_string const &fname, char mode= 'r')
	Load from a file name.
virtual vidl_vil1_codec_sptr	load (const vcl_list< vcl_string > &fnames, char mode= 'r')
	Load a 'movie' from a list of filenames, return a codec.
virtual vidl_vil1_codec_sptr	load (const vcl_vector< vcl_string > &fnames, char mode= 'r')
	Load a 'movie' from a vector of filenames, return a codec.
virtual bool	save (vidl_vil1_movie *movie, vcl_string const &fname)
	Save the given video as a set of images of the default set type.
virtual bool	save (vidl_vil1_movie *movie, vcl_string const &fname, vcl_string const &type)
	Save the given video as a set of images of the type given.
virtual bool	probe (vcl_string const &fname)
	Supposed to check the validity of this codec for a special filename.
virtual vcl_string	type () const
virtual void	set_image_type (vcl_string const &type)
virtual vcl_string	get_image_type () const
vcl_vector< vil1_image >	get_images () const
virtual vidl_vil1_image_list_codec *	castto_vidl_vil1_image_list_codec ()
virtual vidl_vil1_mpegcodec *	castto_vidl_vil1_mpegcodec ()
virtual vidl_vil1_avicodec *	castto_vidl_vil1_avicodec ()
void	set_number_frames (int n=0)
void	set_name (vcl_string n="")
void	set_description (vcl_string d="")
void	set_format (char f= '\0')
void	set_image_class (char t= 'M')
void	set_bits_pixel (int d=0)
void	set_width (int x=0)
void	set_height (int y=0)
void	set_size_z (int z=1)
void	set_size_t (int t=1)
int	length () const
vcl_string	get_name () const
vcl_string	get_description () const
char	get_image_class () const
char	get_format () const
int	width () const
int	height () const
int	get_bits_pixel () const
int	get_bytes_pixel () const
virtual void	close ()
	Perform any operations required to close down the codec.
void	ref ()
void	unref ()
int	get_references () const
bool	is_referenced () const
Static Public Member Functions
static void	set_default_image_type (vcl_string const &type)
Protected Member Functions
virtual bool	init ()
	Initialize.
Protected Attributes
vcl_vector< vil1_image >	images_
Private Attributes
vcl_string	default_image_type_
Static Private Attributes
static vcl_string	default_initialization_image_type_

Constructor & Destructor Documentation

vidl_vil1_image_list_codec::vidl_vil1_image_list_codec ( )

Basic constructor. Should not be called unless we initialize the codec by some ways.

Definition at line 57 of file vidl_vil1_image_list_codec.cxx.

vidl_vil1_image_list_codec::vidl_vil1_image_list_codec ( vcl_list< vil1_image > & images )

Constructor, from a list of images.

Definition at line 31 of file vidl_vil1_image_list_codec.cxx.

vidl_vil1_image_list_codec::vidl_vil1_image_list_codec ( vcl_vector< vil1_image > & images )

Constructor, from a vector of images.

Definition at line 44 of file vidl_vil1_image_list_codec.cxx.

vidl_vil1_image_list_codec::~vidl_vil1_image_list_codec ( ) [inline]

Definition at line 32 of file vidl_vil1_image_list_codec.h.

Member Function Documentation

virtual vidl_vil1_image_list_codec* vidl_vil1_image_list_codec::casttovidl_vil1_image_list_codec ( ) [inline, virtual]

Definition at line 36 of file vidl_vil1_image_list_codec.h.

bool vidl_vil1_image_list_codec::get_section	(	int	position,
		void *	ib,
		int	x0,
		int	y0,
		int	w,
		int	h
	)			const `[virtual]`

Get a section of pixels in function of the frame number, position and size.

Implements vidl_vil1_codec.

Definition at line 90 of file vidl_vil1_image_list_codec.cxx.

int vidl_vil1_image_list_codec::put_section	(	int	position,
		void *	ib,
		int	x0,
		int	y0,
		int	w,
		int	h
	)			`[virtual]`

Put a section of pixels in function of the frame number, position and size.

Implements vidl_vil1_codec.

Definition at line 96 of file vidl_vil1_image_list_codec.cxx.

vidl_vil1_codec_sptr vidl_vil1_image_list_codec::load	(	vcl_string const &	fname,
		char	mode = `'r'`
	)			`[virtual]`

Load from a file name.

fname should contain "%d", which will be replaced with 0, 1, 2, etc. in turn.

Implements vidl_vil1_codec.

Definition at line 104 of file vidl_vil1_image_list_codec.cxx.

vidl_vil1_codec_sptr vidl_vil1_image_list_codec::load	(	const vcl_list< vcl_string > &	fnames,
		char	mode = `'r'`
	)			`[virtual]`

Load a 'movie' from a list of filenames, return a codec.

Definition at line 130 of file vidl_vil1_image_list_codec.cxx.

vidl_vil1_codec_sptr vidl_vil1_image_list_codec::load	(	const vcl_vector< vcl_string > &	fnames,
		char	mode = `'r'`
	)			`[virtual]`

Load a 'movie' from a vector of filenames, return a codec.

Definition at line 156 of file vidl_vil1_image_list_codec.cxx.

bool vidl_vil1_image_list_codec::save	(	vidl_vil1_movie *	movie,
		vcl_string const &	fname
	)			`[virtual]`

Save the given video as a set of images of the default set type.

Implements vidl_vil1_codec.

Definition at line 191 of file vidl_vil1_image_list_codec.cxx.

bool vidl_vil1_image_list_codec::save	(	vidl_vil1_movie *	movie,
		vcl_string const &	fname,
		vcl_string const &	type
	)			`[virtual]`

Save the given video as a set of images of the type given.

Definition at line 203 of file vidl_vil1_image_list_codec.cxx.

bool vidl_vil1_image_list_codec::probe ( vcl_string const & fname ) [virtual]

Supposed to check the validity of this codec for a special filename.

Not so well implemented for this codec. This could check if the filename is a valid image type by probing all the image types.

Implements vidl_vil1_codec.

Definition at line 185 of file vidl_vil1_image_list_codec.cxx.

virtual vcl_string vidl_vil1_image_list_codec::type ( ) const [inline, virtual]

Implements vidl_vil1_codec.

Definition at line 48 of file vidl_vil1_image_list_codec.h.

static void vidl_vil1_image_list_codec::set_default_image_type ( vcl_string const & type ) [inline, static]

Definition at line 51 of file vidl_vil1_image_list_codec.h.

virtual void vidl_vil1_image_list_codec::set_image_type ( vcl_string const & type ) [inline, virtual]

Definition at line 54 of file vidl_vil1_image_list_codec.h.

virtual vcl_string vidl_vil1_image_list_codec::get_image_type ( ) const [inline, virtual]

Definition at line 57 of file vidl_vil1_image_list_codec.h.

vcl_vector<vil1_image> vidl_vil1_image_list_codec::get_images ( ) const [inline]

Definition at line 58 of file vidl_vil1_image_list_codec.h.

bool vidl_vil1_image_list_codec::init ( ) [protected, virtual]

Initialize.

Definition at line 68 of file vidl_vil1_image_list_codec.cxx.

virtual vidl_vil1_image_list_codec* vidl_vil1_codec::castto_vidl_vil1_image_list_codec ( ) [inline, virtual, inherited]

Definition at line 39 of file vidl_vil1_codec.h.

virtual vidl_vil1_mpegcodec* vidl_vil1_codec::castto_vidl_vil1_mpegcodec ( ) [inline, virtual, inherited]

Reimplemented in vidl_vil1_mpegcodec.

Definition at line 40 of file vidl_vil1_codec.h.

virtual vidl_vil1_avicodec* vidl_vil1_codec::castto_vidl_vil1_avicodec ( ) [inline, virtual, inherited]

Reimplemented in vidl_vil1_avicodec.

Definition at line 41 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_number_frames ( int n = 0 ) [inline, inherited]

Definition at line 44 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_name ( vcl_string n = "" ) [inline, inherited]

Definition at line 45 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_description ( vcl_string d = "" ) [inline, inherited]

Definition at line 46 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_format ( char f = '\0' ) [inline, inherited]

Definition at line 47 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_image_class ( char t = 'M' ) [inline, inherited]

Definition at line 48 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_bits_pixel ( int d = 0 ) [inline, inherited]

Definition at line 49 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_width ( int x = 0 ) [inline, inherited]

Definition at line 50 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_height ( int y = 0 ) [inline, inherited]

Definition at line 51 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_size_z ( int z = 1 ) [inline, inherited]

Definition at line 52 of file vidl_vil1_codec.h.

void vidl_vil1_codec::set_size_t ( int t = 1 ) [inline, inherited]

Definition at line 53 of file vidl_vil1_codec.h.

int vidl_vil1_codec::length ( ) const [inline, inherited]

Definition at line 57 of file vidl_vil1_codec.h.

vcl_string vidl_vil1_codec::get_name ( ) const [inline, inherited]

Definition at line 58 of file vidl_vil1_codec.h.

vcl_string vidl_vil1_codec::get_description ( ) const [inline, inherited]

Definition at line 59 of file vidl_vil1_codec.h.

char vidl_vil1_codec::get_image_class ( ) const [inline, inherited]

Definition at line 61 of file vidl_vil1_codec.h.

char vidl_vil1_codec::get_format ( ) const [inline, inherited]

Definition at line 62 of file vidl_vil1_codec.h.

int vidl_vil1_codec::width ( ) const [inline, inherited]

Definition at line 63 of file vidl_vil1_codec.h.

int vidl_vil1_codec::height ( ) const [inline, inherited]

Definition at line 64 of file vidl_vil1_codec.h.

int vidl_vil1_codec::get_bits_pixel ( ) const [inline, inherited]

Definition at line 65 of file vidl_vil1_codec.h.

int vidl_vil1_codec::get_bytes_pixel ( ) const [inline, inherited]

Definition at line 66 of file vidl_vil1_codec.h.

virtual void vidl_vil1_codec::close ( ) [inline, virtual, inherited]

Perform any operations required to close down the codec.

This will typically be called just before program exit.

Definition at line 97 of file vidl_vil1_codec.h.

Member Data Documentation

vcl_vector<vil1_image> vidl_vil1_image_list_codec::images_ [protected]

Definition at line 67 of file vidl_vil1_image_list_codec.h.

vcl_string vidl_vil1_image_list_codec::default_image_type_ [private]

Definition at line 70 of file vidl_vil1_image_list_codec.h.

vcl_string vidl_vil1_image_list_codec::default_initialization_image_type_ [static, private]

Definition at line 71 of file vidl_vil1_image_list_codec.h.

The documentation for this class was generated from the following files:

core/vidl_vil1/vidl_vil1_image_list_codec.h
core/vidl_vil1/vidl_vil1_image_list_codec.cxx

Generated on Tue Dec 2 05:09:14 2008 for core/vidl_vil1 by

1.5.1

vidl_vil1_image_list_codec Class Reference

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation