vvid_command_line_player Class Reference

A class for processing videos. More...

#include <vvid_command_line_player.h>

List of all members.

Public Member Functions
	vvid_command_line_player ()
	Default Constructor.
	~vvid_command_line_player ()
	Destructor.
bool	load_video_file ()
	load a video.
bool	set_video_process (vpro_video_process_sptr video_proc)
	set video process.
bool	add_output_file (vul_arg< vcl_string > output_file)
	register an output file so that it can be identified in the XML output.
bool	play_video ()
	set the status output filename.
bool	add_system_info_args (vul_arg_info_list &arg_list)
	add required system_info args.
bool	print_params_only ()
	check if user only wants an xml parameter file output.
bool	print_xml_params (vul_arg_info_list &arg_list, vcl_string param_block_name)
	print and xml parameter file.
bool	print_performance_output (vcl_string video_name, vcl_vector< float > frame_scores)
	print performance output.
Protected Member Functions
void	write_status (vcl_string filename, int iframe)
	write status block to file.
Private Attributes
vidl_vil1_movie_sptr	movie_
vpro_video_process_sptr	video_process_
vcl_string	status_output_filename_
int	nframes_
vul_arg_info_list	arg_list_
vul_arg< vcl_string > *	parameter_output_file_
vul_arg< vcl_string > *	input_video_file_
vul_arg< vcl_string > *	status_block_file_
vul_arg< vcl_string > *	output_directory_
vul_arg< vcl_string > *	performance_output_file_
vul_arg< bool > *	print_params_flag_
vcl_vector< vul_arg< vcl_string > >	output_files_

---

Detailed Description

A class for processing videos.

Definition at line 21 of file vvid_command_line_player.h.

---

Constructor & Destructor Documentation

vvid_command_line_player::vvid_command_line_player

(

)

Default Constructor.

Definition at line 20 of file vvid_command_line_player.cxx.

vvid_command_line_player::~vvid_command_line_player

(

)

Destructor.

Definition at line 36 of file vvid_command_line_player.cxx.

---

Member Function Documentation

bool vvid_command_line_player::add_output_file

(

vul_arg< vcl_string >

output_file

)

register an output file so that it can be identified in the XML output.

Definition at line 146 of file vvid_command_line_player.cxx.

bool vvid_command_line_player::add_system_info_args

(

vul_arg_info_list &

arg_list

)

add required system_info args.

add the required SYSTEM_INFO args to the list of args.

Algorithm-specific args can then be added to the list and parsed.

Definition at line 70 of file vvid_command_line_player.cxx.

bool vvid_command_line_player::load_video_file

(

)

load a video.

Definition at line 46 of file vvid_command_line_player.cxx.

bool vvid_command_line_player::play_video

(

)

set the status output filename.

play the video.

bool set_status_output_file(vcl_string filename); play the video.

Definition at line 83 of file vvid_command_line_player.cxx.

bool vvid_command_line_player::print_params_only

(

)

check if user only wants an xml parameter file output.

so the wrapper program can exit if the user wants param file only.

Definition at line 141 of file vvid_command_line_player.cxx.

bool vvid_command_line_player::print_performance_output	(	vcl_string	video_name,
		vcl_vector< float >	frame_scores
	)

print performance output.

Definition at line 152 of file vvid_command_line_player.cxx.

bool vvid_command_line_player::print_xml_params	(	vul_arg_info_list &	arg_list,
		vcl_string	param_block_name
	)

print and xml parameter file.

Definition at line 183 of file vvid_command_line_player.cxx.

bool vvid_command_line_player::set_video_process

(

vpro_video_process_sptr

video_proc

)

set video process.

Definition at line 61 of file vvid_command_line_player.cxx.

void vvid_command_line_player::write_status	(	vcl_string	output_file,
		int	iframe
	)		[protected]

write status block to file.

Todo:

each video process should be able to have its own status_block type

Definition at line 119 of file vvid_command_line_player.cxx.

---

Member Data Documentation

vul_arg_info_list vvid_command_line_player::arg_list_ [private]

Definition at line 64 of file vvid_command_line_player.h.

vul_arg<vcl_string>* vvid_command_line_player::input_video_file_ [private]

Definition at line 66 of file vvid_command_line_player.h.

vidl_vil1_movie_sptr vvid_command_line_player::movie_ [private]

Definition at line 59 of file vvid_command_line_player.h.

int vvid_command_line_player::nframes_ [private]

Definition at line 62 of file vvid_command_line_player.h.

vul_arg<vcl_string>* vvid_command_line_player::output_directory_ [private]

Definition at line 68 of file vvid_command_line_player.h.

vcl_vector<vul_arg<vcl_string> > vvid_command_line_player::output_files_ [private]

Definition at line 71 of file vvid_command_line_player.h.

vul_arg<vcl_string>* vvid_command_line_player::parameter_output_file_ [private]

Definition at line 65 of file vvid_command_line_player.h.

vul_arg<vcl_string>* vvid_command_line_player::performance_output_file_ [private]

Definition at line 69 of file vvid_command_line_player.h.

vul_arg<bool>* vvid_command_line_player::print_params_flag_ [private]

Definition at line 70 of file vvid_command_line_player.h.

vul_arg<vcl_string>* vvid_command_line_player::status_block_file_ [private]

Definition at line 67 of file vvid_command_line_player.h.

vcl_string vvid_command_line_player::status_output_filename_ [private]

Definition at line 61 of file vvid_command_line_player.h.

vpro_video_process_sptr vvid_command_line_player::video_process_ [private]

Definition at line 60 of file vvid_command_line_player.h.

---

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

• contrib/brl/vvid/vvid_command_line_player.h
• contrib/brl/vvid/vvid_command_line_player.cxx