This is a wrapper on the circular region or sphere. More...
#include <rgrl_mask.h>
Public Member Functions | |
| rgrl_mask_sphere (unsigned dim) | |
| Null initialization. | |
| rgrl_mask_sphere (const vnl_vector< double > &in_center, double in_radius) | |
| bool | inside (vnl_vector< double > const &pt) const |
| True if a point is inside the region. | |
| void | set_center (vnl_vector< double > const &pt) |
| void | set_radius (double radius) |
| rgrl_type_macro (rgrl_mask_sphere, rgrl_mask) | |
| rgrl_type_macro (rgrl_mask, rgrl_object) | |
| vnl_vector< double > const & | x0 () const |
| The lower coordinate of the bounding box. | |
| vnl_vector< double > const & | x1 () const |
| The upper coordinate of the bounding box. | |
| rgrl_mask_box | bounding_box () const |
| 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 Attributes | |
| vnl_vector< double > | x0_ |
| vnl_vector< double > | x1_ |
Private Member Functions | |
| void | update_bounding_box () |
Private Attributes | |
| vnl_vector< double > | center_ |
| double | radius_sqr_ |
Detailed Description
This is a wrapper on the circular region or sphere.
Definition at line 83 of file rgrl_mask.h.
Constructor & Destructor Documentation
| rgrl_mask_sphere::rgrl_mask_sphere | ( | unsigned | dim | ) |
Null initialization.
Initializes the region to the sphere centered at (0,0,...) with radius set to 0.
Definition at line 76 of file rgrl_mask.cxx.
| rgrl_mask_sphere::rgrl_mask_sphere | ( | const vnl_vector< double > & | in_center, |
| double | in_radius | ||
| ) |
Definition at line 82 of file rgrl_mask.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.
| rgrl_mask_box rgrl_mask::bounding_box | ( | ) | const [inherited] |
Definition at line 10 of file rgrl_mask.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_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.
| bool rgrl_mask_sphere::inside | ( | vnl_vector< double > const & | pt | ) | const [virtual] |
True if a point is inside the region.
Implements rgrl_mask.
Definition at line 93 of file rgrl_mask.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.
| 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_mask::rgrl_type_macro | ( | rgrl_mask | , |
| rgrl_object | |||
| ) | [inherited] |
| rgrl_mask_sphere::rgrl_type_macro | ( | rgrl_mask_sphere | , |
| rgrl_mask | |||
| ) |
| void rgrl_mask_sphere::set_center | ( | vnl_vector< double > const & | pt | ) |
Definition at line 106 of file rgrl_mask.cxx.
| 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_mask_sphere::set_radius | ( | double | radius | ) |
Definition at line 116 of file rgrl_mask.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.
| 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.
| void rgrl_mask_sphere::update_bounding_box | ( | ) | [private] |
Definition at line 125 of file rgrl_mask.cxx.
| bool rgrl_object::warning | ( | ) | const [inherited] |
Get the warning flag.
Definition at line 40 of file rgrl_object.cxx.
| vnl_vector<double> const& rgrl_mask::x0 | ( | ) | const [inline, inherited] |
The lower coordinate of the bounding box.
Definition at line 46 of file rgrl_mask.h.
| vnl_vector<double> const& rgrl_mask::x1 | ( | ) | const [inline, inherited] |
The upper coordinate of the bounding box.
Definition at line 50 of file rgrl_mask.h.
Member Data Documentation
vnl_vector<double> rgrl_mask_sphere::center_ [private] |
Definition at line 111 of file rgrl_mask.h.
double rgrl_mask_sphere::radius_sqr_ [private] |
Definition at line 112 of file rgrl_mask.h.
vnl_vector<double> rgrl_mask::x0_ [protected, inherited] |
Definition at line 56 of file rgrl_mask.h.
vnl_vector<double> rgrl_mask::x1_ [protected, inherited] |
Definition at line 56 of file rgrl_mask.h.
The documentation for this class was generated from the following files:
- contrib/rpl/rgrl/rgrl_mask.h
- contrib/rpl/rgrl/rgrl_mask.cxx
