firevision::Circle Class Reference

Circle shape. More...

#include <models/shape/circle.h>

Inheritance diagram for firevision::Circle:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Circle ()
 Constructor.
 Circle (const center_in_roi_t &c, float r, int n=0)
 Constructor.
void printToStream (std::ostream &stream)
 Print info.
void setMargin (unsigned int margin)
 Set margin around shape.
bool isClose (unsigned int in_roi_x, unsigned int in_roi_y)
 Check if the given point is close to the shape.
void fitCircle (std::vector< fawkes::point_t > &points)
 Fit circle.

Public Attributes

center_in_roi_t center
 Center of object in ROI.
float radius
 Radius of object.
int count
 Number of pixels.
unsigned int margin
 Margin around shape.

Detailed Description

Circle shape.

Definition at line 45 of file circle.h.


Constructor & Destructor Documentation

firevision::Circle::Circle (  ) 

Constructor.

Definition at line 41 of file circle.cpp.

References center, count, radius, firevision::center_in_roi_t::x, and firevision::center_in_roi_t::y.

firevision::Circle::Circle ( const center_in_roi_t c,
float  r,
int  n = 0 
)

Constructor.

Parameters:
c center
r radius
n number of pixels

Definition at line 53 of file circle.cpp.

References center, count, and radius.


Member Function Documentation

void firevision::Circle::fitCircle ( std::vector< fawkes::point_t > &  points  ) 

Fit circle.

Fit a circle through the given points.

Parameters:
points points to fit circle through.

Definition at line 75 of file circle.cpp.

References center, count, radius, firevision::center_in_roi_t::x, fawkes::point_t::x, firevision::center_in_roi_t::y, and fawkes::point_t::y.

Referenced by firevision::RhtCircleModel::parseImage(), and firevision::RcdCircleModel::parseImage().

bool firevision::Circle::isClose ( unsigned int  in_roi_x,
unsigned int  in_roi_y 
) [virtual]

Check if the given point is close to the shape.

Parameters:
in_roi_x x coordinate of point in the same ROI as the shape
in_roi_y y coordinate of point in the same ROI as the shape
Returns:
true if point is close to shape, false otherwise

Implements firevision::Shape.

Definition at line 127 of file circle.cpp.

References center, margin, radius, firevision::center_in_roi_t::x, and firevision::center_in_roi_t::y.

void firevision::Circle::printToStream ( std::ostream &  stream  ) 

Print info.

Parameters:
stream stream to print to

Definition at line 64 of file circle.cpp.

References center, count, radius, firevision::center_in_roi_t::x, and firevision::center_in_roi_t::y.

void firevision::Circle::setMargin ( unsigned int  margin  )  [virtual]

Set margin around shape.

Parameters:
margin margin

Implements firevision::Shape.

Definition at line 120 of file circle.cpp.


Member Data Documentation

Margin around shape.

Definition at line 66 of file circle.h.

Referenced by isClose().


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1