firevision::FilterROIDraw Class Reference

ROI Drawing filter. More...

#include <filters/roidraw.h>

Inheritance diagram for firevision::FilterROIDraw:

[legend]
List of all members.

Public Types

 INVERTED
 Displays border with inverted Y-value.
 DASHED_HINT
 Displays border dashed black and color of hint.
enum  border_style_t { INVERTED, DASHED_HINT }
 Defines the possible border styles to display a ROI. More...

Public Member Functions

 FilterROIDraw (const std::list< ROI > *rois=0, border_style_t style=INVERTED)
 Constructor.
virtual ~FilterROIDraw ()
 Destructor.
virtual void apply ()
 Apply the filter.
void set_rois (const std::list< ROI > *rois)
 Set ROIs.
void set_style (border_style_t style)
 Sets the preferred style.

Detailed Description

ROI Drawing filter.

This filter visually marks the given region of interest.

Author:
Tim Niemueller

Definition at line 38 of file roidraw.h.


Member Enumeration Documentation

enum firevision::FilterROIDraw::border_style_t

Defines the possible border styles to display a ROI.

Enumerator:
INVERTED  Displays border with inverted Y-value.
DASHED_HINT  Displays border dashed black and color of hint.

Definition at line 42 of file roidraw.h.


Constructor & Destructor Documentation

firevision::FilterROIDraw::FilterROIDraw ( const std::list< ROI > *  rois = 0,
border_style_t  style = INVERTED 
)

Constructor.

Parameters:
rois optional list of ROIs to draw additionally to the dst_roi
style optional border style (default is INVERTED)

Definition at line 45 of file roidraw.cpp.

firevision::FilterROIDraw::~FilterROIDraw (  )  [virtual]

Destructor.

Definition at line 54 of file roidraw.cpp.


Member Function Documentation

void firevision::FilterROIDraw::apply (  )  [virtual]

Apply the filter.

Apply the filter to the given source and destination buffers with given width and height and orientation (ori may be ignored for some filters).

Implements firevision::Filter.

Definition at line 124 of file roidraw.cpp.

References firevision::Filter::dst_roi.

void firevision::FilterROIDraw::set_rois ( const std::list< ROI > *  rois  ) 

Set ROIs.

Set a list of ROIs. The list must persist as long as the filter is applied with this list. Set to NULL to have it ignored again.

Parameters:
rois list of ROIs to draw additionally to the dst_roi.

Definition at line 143 of file roidraw.cpp.

void firevision::FilterROIDraw::set_style ( border_style_t  style  ) 

Sets the preferred style.

Parameters:
style The preferred style

Definition at line 153 of file roidraw.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:32:59 2011 for Fawkes API by  doxygen 1.4.7