rgrl_feature_set Class Reference

#include <rgrl_feature_set.h>

Inheritance diagram for rgrl_feature_set:

Inheritance graph
[legend]

List of all members.


Detailed Description

Base class to represent and provide access in several ways to a set of registration features.

Each feature set represents features of one type and at one resolution.

Definition at line 60 of file rgrl_feature_set.h.


Public Types

typedef vcl_vector
< rgrl_feature_sptr
feature_vector

Public Member Functions

 rgrl_feature_set (feature_vector const &fea_vec, rgrl_feature_set_label const &label=rgrl_feature_set_label())
virtual ~rgrl_feature_set ()
void set_label (rgrl_feature_set_label const &label)
 set label.
rgrl_feature_set_label const & label () const
 get label.
virtual feature_vector const & all_features () const
 Return all the features.
virtual void features_in_region (feature_vector &results, rgrl_mask_box const &roi) const =0
 Return the features in a given ROI.
virtual void features_within_radius (feature_vector &results, vnl_vector< double > const &center, double radius) const =0
 Return the features in a given circle/sphere.
virtual rgrl_feature_sptr nearest_feature (const vnl_vector< double > &loc) const =0
 Return the nearest feature to the given location.
virtual rgrl_feature_sptr nearest_feature (rgrl_feature_sptr const &feature) const =0
 Return the nearest feature to the given location.
virtual void features_within_radius (feature_vector &results, rgrl_feature_sptr const &feature, double distance) const =0
 Return all features within a given distance of the given feature, one per segment (if segmented).
virtual void k_nearest_features (feature_vector &results, const vnl_vector< double > &feature_loc, unsigned int k) const =0
 Return the k nearest features to the given location, one per segment (if segmented).
virtual void k_nearest_features (feature_vector &results, rgrl_feature_sptr const &feature, unsigned int k) const =0
 Return the k nearest features, one per segment (if segmented).
virtual rgrl_mask_box bounding_box () const =0
 Return the bounding box encloses the feature set.
virtual const vcl_type_info & type () const =0
 Return the type of feature.
 rgrl_type_macro (rgrl_feature_set, 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 ()

Protected Attributes

rgrl_feature_set_label label_
feature_vector fea_vec_

Private Member Functions

 rgrl_feature_set (rgrl_feature_set const &other)
rgrl_feature_setoperator= (rgrl_feature_set const &other)

Member Typedef Documentation

Definition at line 64 of file rgrl_feature_set.h.


Constructor & Destructor Documentation

rgrl_feature_set::rgrl_feature_set ( feature_vector const &  fea_vec,
rgrl_feature_set_label const &  label = rgrl_feature_set_label() 
)

Definition at line 9 of file rgrl_feature_set.cxx.

rgrl_feature_set::~rgrl_feature_set (  )  [virtual]

Definition at line 15 of file rgrl_feature_set.cxx.

rgrl_feature_set::rgrl_feature_set ( rgrl_feature_set const &  other  )  [private]


Member Function Documentation

void rgrl_feature_set::set_label ( rgrl_feature_set_label const &  label  )  [inline]

set label.

Definition at line 72 of file rgrl_feature_set.h.

rgrl_feature_set_label const& rgrl_feature_set::label (  )  const [inline]

get label.

Definition at line 76 of file rgrl_feature_set.h.

virtual feature_vector const& rgrl_feature_set::all_features (  )  const [inline, virtual]

Return all the features.

Reimplemented in rgrl_feature_set_location_masked.

Definition at line 83 of file rgrl_feature_set.h.

virtual void rgrl_feature_set::features_in_region ( feature_vector results,
rgrl_mask_box const &  roi 
) const [pure virtual]

Return the features in a given ROI.

virtual void rgrl_feature_set::features_within_radius ( feature_vector results,
vnl_vector< double > const &  center,
double  radius 
) const [pure virtual]

Return the features in a given circle/sphere.

virtual rgrl_feature_sptr rgrl_feature_set::nearest_feature ( const vnl_vector< double > &  loc  )  const [pure virtual]

Return the nearest feature to the given location.

This may be constructed from an underlying continuous representation.

Implemented in rgrl_feature_set_bins< N >, rgrl_feature_set_bins_2d, rgrl_feature_set_location< N >, and rgrl_feature_set_location_masked.

virtual rgrl_feature_sptr rgrl_feature_set::nearest_feature ( rgrl_feature_sptr const &  feature  )  const [pure virtual]

Return the nearest feature to the given location.

virtual void rgrl_feature_set::features_within_radius ( feature_vector results,
rgrl_feature_sptr const &  feature,
double  distance 
) const [pure virtual]

Return all features within a given distance of the given feature, one per segment (if segmented).

virtual void rgrl_feature_set::k_nearest_features ( feature_vector results,
const vnl_vector< double > &  feature_loc,
unsigned int  k 
) const [pure virtual]

Return the k nearest features to the given location, one per segment (if segmented).

virtual void rgrl_feature_set::k_nearest_features ( feature_vector results,
rgrl_feature_sptr const &  feature,
unsigned int  k 
) const [pure virtual]

Return the k nearest features, one per segment (if segmented).

virtual rgrl_mask_box rgrl_feature_set::bounding_box (  )  const [pure virtual]

Return the bounding box encloses the feature set.

Implemented in rgrl_feature_set_bins< N >, rgrl_feature_set_bins_2d, rgrl_feature_set_location< N >, and rgrl_feature_set_location_masked.

virtual const vcl_type_info& rgrl_feature_set::type (  )  const [pure virtual]

rgrl_feature_set::rgrl_type_macro ( rgrl_feature_set  ,
rgrl_object   
)

rgrl_feature_set& rgrl_feature_set::operator= ( rgrl_feature_set const &  other  )  [private]

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  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.


Member Data Documentation

Definition at line 149 of file rgrl_feature_set.h.

Definition at line 150 of file rgrl_feature_set.h.


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

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