rgrl_invariant_match Class Reference

#include <rgrl_invariant_match.h>

Inheritance diagram for rgrl_invariant_match:

Detailed Description

Definition at line 21 of file rgrl_invariant_match.h.


Public Member Functions
	rgrl_invariant_match (rgrl_invariant_sptr from, rgrl_invariant_sptr to)
	Constructor.
	~rgrl_invariant_match ()
	Destructor.
rgrl_invariant_sptr	from () const
	Returns a smart pointer to the "from" invariant.
rgrl_invariant_sptr	to () const
	Returns a smart pointer to the "to" invariant.
double	distance () const
	Returns the distance between the constellations in the match.
rgrl_transformation_sptr	transform () const
	Returns a transform smart pointer to the estimated transform.
rgrl_scale_sptr	scale () const
	Return a scale smart pointer to the estimated similarity transform.
rgrl_mask_box	initial_region () const
	Computes the initial ROI where the initial transformation is valid.
bool	has_initial_region () const
	Return true if the match is associated with an initial ROI.
bool	estimate ()
	Trigger the estimate() function of the to_ feature.
	rgrl_type_macro (rgrl_invariant_match, 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(.
void	invoke_event (const rgrl_event &) const
	Call execute(.
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 ()
Private Attributes
rgrl_invariant_sptr	from_
rgrl_invariant_sptr	to_
double	distance_
rgrl_transformation_sptr	xform_
rgrl_scale_sptr	scale_
bool	is_estimate_set_

Constructor & Destructor Documentation

rgrl_invariant_match::rgrl_invariant_match	(	rgrl_invariant_sptr	from,
		rgrl_invariant_sptr	to
	)

Constructor.

Definition at line 6 of file rgrl_invariant_match.cxx.

rgrl_invariant_match::~rgrl_invariant_match ( ) [inline]

Destructor.

Definition at line 30 of file rgrl_invariant_match.h.

Member Function Documentation

rgrl_invariant_sptr rgrl_invariant_match::from ( ) const [inline]

Returns a smart pointer to the "from" invariant.

Definition at line 33 of file rgrl_invariant_match.h.

rgrl_invariant_sptr rgrl_invariant_match::to ( ) const [inline]

Returns a smart pointer to the "to" invariant.

Definition at line 36 of file rgrl_invariant_match.h.

double rgrl_invariant_match::distance ( ) const [inline]

Returns the distance between the constellations in the match.

Note:: distance is calculated as the Euclidean distance in the "invariant space"

Definition at line 41 of file rgrl_invariant_match.h.

rgrl_transformation_sptr rgrl_invariant_match::transform ( ) const

Returns a transform smart pointer to the estimated transform.

Definition at line 31 of file rgrl_invariant_match.cxx.

rgrl_scale_sptr rgrl_invariant_match::scale ( ) const

Return a scale smart pointer to the estimated similarity transform.

Definition at line 39 of file rgrl_invariant_match.cxx.

rgrl_mask_box rgrl_invariant_match::initial_region ( ) const

Computes the initial ROI where the initial transformation is valid.

Definition at line 47 of file rgrl_invariant_match.cxx.

bool rgrl_invariant_match::has_initial_region ( ) const

Return true if the match is associated with an initial ROI.

The initial ROI is where the initial transformation is valid

Definition at line 54 of file rgrl_invariant_match.cxx.

bool rgrl_invariant_match::estimate ( )

Trigger the estimate() function of the to_ feature.

Definition at line 61 of file rgrl_invariant_match.cxx.

rgrl_invariant_match::rgrl_type_macro	(	rgrl_invariant_match	,
		rgrl_object
	)

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

Reimplemented in rgrl_scale_estimator.

Definition at line 64 of file rgrl_object.h.

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

Reimplemented in rgrl_scale_estimator.

Definition at line 67 of file rgrl_object.h.

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.

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

Get the value of the debug flag.

Definition at line 26 of file rgrl_object.cxx.

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

Set the flag for warning messages.

Definition at line 33 of file rgrl_object.cxx.

bool rgrl_object::warning ( ) const [inherited]

Get the warning flag.

Definition at line 40 of file rgrl_object.cxx.

unsigned int rgrl_object::add_observer	(	rgrl_event_sptr	event,
		rgrl_command_sptr
	)			`[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_ommand 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.

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.

void rgrl_object::invoke_event ( const rgrl_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 & ) const [inherited]

Call execute(.

) on all the rgrl_commands observing this event id.

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