rgrl_scale_estimator Class Reference

#include <rgrl_scale_estimator.h>

Inheritance diagram for rgrl_scale_estimator:

Inheritance graph
[legend]

List of all members.


Detailed Description

Interface for scale estimator that can estimate with and without weights.

Definition at line 92 of file rgrl_scale_estimator.h.


Public Member Functions

virtual bool is_type (const vcl_type_info &type) const
virtual rgrl_scale_sptr estimate_unweighted (rgrl_match_set const &match_set, rgrl_scale_sptr const &current_scales, bool penalize_scaling=false) const =0
 Estimated an unweighted scale.
 rgrl_type_macro (rgrl_scale_estimator_unwgted, rgrl_object)
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
virtual rgrl_scale_sptr estimate_weighted (rgrl_match_set const &match_set, rgrl_scale_sptr const &current_scales, bool use_signature_only=false, bool penalize_scaling=false) const =0
 Estimated a weighted scale.
 rgrl_type_macro (rgrl_scale_estimator_wgted, rgrl_object)

Static Public Member Functions

static const vcl_type_info & type_id ()

Member Function Documentation

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

Reimplemented from rgrl_object.

Definition at line 97 of file rgrl_scale_estimator.h.

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

Reimplemented from rgrl_object.

Definition at line 100 of file rgrl_scale_estimator.h.

virtual rgrl_scale_sptr rgrl_scale_estimator_unwgted::estimate_unweighted ( rgrl_match_set const &  match_set,
rgrl_scale_sptr const &  current_scales,
bool  penalize_scaling = false 
) const [pure virtual, inherited]

Estimated an unweighted scale.

match_set stores the current matches, and, if not null, current_scales has the current scale estimates. (Perhaps from the previous iteration.)

Implemented in rgrl_scale_est_closest, and rgrl_scale_est_null.

rgrl_scale_estimator_unwgted::rgrl_type_macro ( rgrl_scale_estimator_unwgted  ,
rgrl_object   
) [inherited]

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  flag  )  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  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_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 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.

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.

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.

virtual rgrl_scale_sptr rgrl_scale_estimator_wgted::estimate_weighted ( rgrl_match_set const &  match_set,
rgrl_scale_sptr const &  current_scales,
bool  use_signature_only = false,
bool  penalize_scaling = false 
) const [pure virtual, inherited]

Estimated a weighted scale.

match_set stores the current matches, and, if not null, current_scales has the current scale estimates. (Perhaps from the previous iteration.)

Implemented in rgrl_scale_est_all_weights, rgrl_scale_est_closest, and rgrl_scale_est_null.

rgrl_scale_estimator_wgted::rgrl_type_macro ( rgrl_scale_estimator_wgted  ,
rgrl_object   
) [inherited]


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

Generated on Sun Nov 22 06:34:31 2009 for contrib/rpl/rgrl by  doxygen 1.5.5