rgrl_scale Class Reference

#include <rgrl_scale.h>

Inheritance diagram for rgrl_scale:

rgrl_object vbl_ref_count List of all members.

Detailed Description

Represents error scale estimates.

Definition at line 26 of file rgrl_scale.h.


Public Types

enum  type { prior, estimate }
 scale type. More...

Public Member Functions

 rgrl_scale ()
bool has_geometric_scale () const
double geometric_scale () const
 Valid iff has_geometric_scale() is true.
bool has_signature_inv_covar () const
vnl_matrix< double > const & signature_inv_covar () const
 Valid iff has_signature_inv_covariance() is true.
void set_scales (double geometric_scale, vnl_matrix< double > const &signature_inv_covar, type new_type=estimate)
 Set all scale information.
void set_geometric_scale (double scale, type new_type=estimate)
 Set the geometric scale.
void set_signature_inv_covar (vnl_matrix< double > const &covar)
 Set the signature covariance matrix.
 rgrl_type_macro (rgrl_scale, rgrl_object)
type geo_scale_type () const
 return scale type.
void set_geo_scale_type (type new_type)
 set scale type.
void write (vcl_ostream &os) const
 write to io stream.
bool read (vcl_istream &is)
 read from io stream.
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

bool has_geometric_scale_
double geometric_scale_
bool has_signature_inv_covar_
vnl_matrix< double > signature_inv_covar_
type geo_scale_type_

Member Enumeration Documentation

enum rgrl_scale::type

scale type.

Enumerator:
prior 
estimate 

Definition at line 33 of file rgrl_scale.h.


Constructor & Destructor Documentation

rgrl_scale::rgrl_scale (  ) 

Definition at line 14 of file rgrl_scale.cxx.


Member Function Documentation

bool rgrl_scale::has_geometric_scale (  )  const

Definition at line 23 of file rgrl_scale.cxx.

double rgrl_scale::geometric_scale (  )  const

Valid iff has_geometric_scale() is true.

Definition at line 31 of file rgrl_scale.cxx.

bool rgrl_scale::has_signature_inv_covar (  )  const

Definition at line 39 of file rgrl_scale.cxx.

vnl_matrix< double > const & rgrl_scale::signature_inv_covar (  )  const

Valid iff has_signature_inv_covariance() is true.

Definition at line 47 of file rgrl_scale.cxx.

void rgrl_scale::set_scales ( double  geometric_scale,
vnl_matrix< double > const &  signature_inv_covar,
type  new_type = estimate 
)

Set all scale information.

Definition at line 55 of file rgrl_scale.cxx.

void rgrl_scale::set_geometric_scale ( double  scale,
type  new_type = estimate 
)

Set the geometric scale.

Definition at line 67 of file rgrl_scale.cxx.

void rgrl_scale::set_signature_inv_covar ( vnl_matrix< double > const &  covar  ) 

Set the signature covariance matrix.

Definition at line 77 of file rgrl_scale.cxx.

rgrl_scale::rgrl_type_macro ( rgrl_scale  ,
rgrl_object   
)

type rgrl_scale::geo_scale_type (  )  const [inline]

return scale type.

Definition at line 62 of file rgrl_scale.h.

void rgrl_scale::set_geo_scale_type ( type  new_type  )  [inline]

set scale type.

Definition at line 65 of file rgrl_scale.h.

void rgrl_scale::write ( vcl_ostream &  os  )  const

write to io stream.

Definition at line 85 of file rgrl_scale.cxx.

bool rgrl_scale::read ( vcl_istream &  is  ) 

read from io stream.

Definition at line 107 of file rgrl_scale.cxx.

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.

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.


Member Data Documentation

bool rgrl_scale::has_geometric_scale_ [private]

Definition at line 75 of file rgrl_scale.h.

double rgrl_scale::geometric_scale_ [private]

Definition at line 76 of file rgrl_scale.h.

bool rgrl_scale::has_signature_inv_covar_ [private]

Definition at line 77 of file rgrl_scale.h.

vnl_matrix<double> rgrl_scale::signature_inv_covar_ [private]

Definition at line 78 of file rgrl_scale.h.

type rgrl_scale::geo_scale_type_ [private]

Definition at line 80 of file rgrl_scale.h.


The documentation for this class was generated from the following files:
Generated on Mon Mar 8 05:27:43 2010 for contrib/rpl/rgrl by  doxygen 1.5.1