Interface for initial estimate generators. More...

#include <rgrl_initializer.h>

Inheritance diagram for rgrl_initializer:

Public Member Functions
	rgrl_initializer ()
virtual	~rgrl_initializer ()
virtual bool	next_initial (rgrl_view_sptr &view, rgrl_scale_sptr &prior_scale)=0
	Get next initial view.
bool	next_initial (rgrl_mask_sptr &from_image_roi, rgrl_mask_sptr &to_image_roi, rgrl_mask_box &current_region, rgrl_mask_box &global_region, rgrl_estimator_sptr &xform_estimator, rgrl_transformation_sptr &xform_estimate, unsigned &current_resolution, rgrl_scale_sptr &prior_scale)
	Get next set of initial information without the notion of a view.
bool	next_initial (rgrl_mask_box &current_region, rgrl_estimator_sptr &xform_estimator, rgrl_transformation_sptr &xform_estimate, unsigned &current_resolution, rgrl_scale_sptr &prior_scale)
	Get next set of initial information, assuming current_region is the region of interest for registration.
bool	next_initial (rgrl_mask_box &current_region, rgrl_estimator_sptr &xform_estimator, rgrl_transformation_sptr &xform_estimate, rgrl_scale_sptr &prior_scale)
	Get next set of initial information, assuming current_region is the region of interest for registration, and single-resol.
void	set_prior_geometric_scale (double scale)
	force the setting of prior scale.
virtual int	size () const =0
	return number of initializations.
	rgrl_type_macro (rgrl_initializer, rgrl_object)
virtual bool	is_type (const vcl_type_info &type) const
void	set_debug_flag (unsigned int debugFlag) const
	Set the value of the debug flag. A non-zero value turns debugging on.
unsigned int	debug_flag () const
	Get the value of the debug flag.
void	set_warning (bool) const
	Set the flag for warning messages.
bool	warning () const
	Get the warning flag.
unsigned int	add_observer (rgrl_event_sptr event, rgrl_command_sptr)
	Allow people to add/remove/invoke observers (callbacks) to any rgrl object.
rgrl_command_sptr	get_command (unsigned int tag)
	Get the command associated with the given tag.
void	invoke_event (const rgrl_event &)
	Call execute(.) on all the rgrl_commands observing this event id.
void	invoke_event (const rgrl_event &) const
	Call execute(.) on all the rgrl_commands observing this event id.
void	remove_observer (unsigned int tag)
	Remove the observer with this tag value.
bool	has_observer (const rgrl_event &event) const
	Return true if an observer is registered for this event.
void	ref ()
void	unref ()
int	get_references () const
bool	is_referenced () const
Static Public Member Functions
static const vcl_type_info &	type_id ()
Protected Member Functions
rgrl_scale_sptr	enforce_prior_scale (rgrl_scale_sptr match_scale)
	Generate a prior scale depending on current settings.
Protected Attributes
rgrl_scale_sptr	prior_scale_
bool	use_prior_scale_from_match_

Detailed Description

Interface for initial estimate generators.

Definition at line 23 of file rgrl_initializer.h.

Constructor & Destructor Documentation

rgrl_initializer::rgrl_initializer ( ) [inline]

Definition at line 27 of file rgrl_initializer.h.

rgrl_initializer::~rgrl_initializer ( ) [virtual]

Definition at line 11 of file rgrl_initializer.cxx.

Member Function Documentation

unsigned int rgrl_object::add_observer	(	rgrl_event_sptr	event,
		rgrl_command_sptr	cmd
	)		`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any rgrl object.

This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an rgrl_command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command.

Definition at line 47 of file rgrl_object.cxx.

unsigned int rgrl_object::debug_flag ( ) const [inherited]

Get the value of the debug flag.

Definition at line 26 of file rgrl_object.cxx.

rgrl_scale_sptr rgrl_initializer::enforce_prior_scale ( rgrl_scale_sptr match_scale ) [protected]

Generate a prior scale depending on current settings.

Definition at line 101 of file rgrl_initializer.cxx.

rgrl_command_sptr rgrl_object::get_command ( unsigned int tag ) [inherited]

Get the command associated with the given tag.

Definition at line 57 of file rgrl_object.cxx.

bool rgrl_object::has_observer ( const rgrl_event & event ) const [inherited]

Return true if an observer is registered for this event.

Definition at line 107 of file rgrl_object.cxx.

void rgrl_object::invoke_event ( const rgrl_event & event ) [inherited]

Call execute(.) on all the rgrl_commands observing this event id.

Definition at line 69 of file rgrl_object.cxx.

void rgrl_object::invoke_event ( const rgrl_event & event ) const [inherited]

Call execute(.) on all the rgrl_commands observing this event id.

The actions triggered by this call doesn't modify this object.

Definition at line 83 of file rgrl_object.cxx.

virtual bool rgrl_object::is_type ( const vcl_type_info & type ) const [inline, virtual, inherited]

Reimplemented in rgrl_scale_estimator.

Definition at line 66 of file rgrl_object.h.

virtual bool rgrl_initializer::next_initial	(	rgrl_view_sptr &	view,
		rgrl_scale_sptr &	prior_scale
	)		`[pure virtual]`

Get next initial view.

Return true iff an estimate is available. The initial transformation estimate must have a covariance matrix filled in because it is used in matching

This is the only pure virtual function implemented in the derived classes.

Implemented in rgrl_initializer_ran_sam, rgrl_initializer_inv_indexing, rgrl_initializer_prior, and rgrl_initializer_reader.

bool rgrl_initializer::next_initial	(	rgrl_mask_sptr &	from_image_roi,
		rgrl_mask_sptr &	to_image_roi,
		rgrl_mask_box &	current_region,
		rgrl_mask_box &	global_region,
		rgrl_estimator_sptr &	xform_estimator,
		rgrl_transformation_sptr &	xform_estimate,
		unsigned &	current_resolution,
		rgrl_scale_sptr &	prior_scale
	)

Get next set of initial information without the notion of a view.

Definition at line 17 of file rgrl_initializer.cxx.

bool rgrl_initializer::next_initial	(	rgrl_mask_box &	current_region,
		rgrl_estimator_sptr &	xform_estimator,
		rgrl_transformation_sptr &	xform_estimate,
		unsigned &	current_resolution,
		rgrl_scale_sptr &	prior_scale
	)

Get next set of initial information, assuming current_region is the region of interest for registration.

Definition at line 43 of file rgrl_initializer.cxx.

bool rgrl_initializer::next_initial	(	rgrl_mask_box &	current_region,
		rgrl_estimator_sptr &	xform_estimator,
		rgrl_transformation_sptr &	xform_estimate,
		rgrl_scale_sptr &	prior_scale
	)

Get next set of initial information, assuming current_region is the region of interest for registration, and single-resol.

Definition at line 63 of file rgrl_initializer.cxx.

void rgrl_object::remove_observer ( unsigned int tag ) [inherited]

Remove the observer with this tag value.

Definition at line 97 of file rgrl_object.cxx.

rgrl_initializer::rgrl_type_macro	(	rgrl_initializer	,
		rgrl_object
	)

void rgrl_object::set_debug_flag ( unsigned int debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 19 of file rgrl_object.cxx.

void rgrl_initializer::set_prior_geometric_scale ( double scale )

force the setting of prior scale.

scale > 0 set to this scale value scale == 0 scale pointer is NULL, which indicates to use unwgted scale estimate scale < 0 use whatever scale set by the match

Definition at line 85 of file rgrl_initializer.cxx.

void rgrl_object::set_warning ( bool flag ) const [inherited]

Set the flag for warning messages.

Definition at line 33 of file rgrl_object.cxx.

virtual int rgrl_initializer::size ( ) const [pure virtual]

return number of initializations.

-1 stands for unknown

Implemented in rgrl_initializer_ran_sam, rgrl_initializer_inv_indexing, rgrl_initializer_prior, and rgrl_initializer_reader.

static const vcl_type_info& rgrl_object::type_id ( ) [inline, static, inherited]

Reimplemented in rgrl_scale_estimator.

Definition at line 63 of file rgrl_object.h.

bool rgrl_object::warning ( ) const [inherited]