Fawkes API  Fawkes Development Version
firevision::FilterROIDraw Class Reference

ROI Drawing filter. More...

#include <>>

Inheritance diagram for firevision::FilterROIDraw:

Public Types

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. More...
 
virtual ~FilterROIDraw ()
 Destructor. More...
 
virtual void apply ()
 Apply the filter. More...
 
void set_rois (const std::list< ROI > *rois)
 Set ROIs. More...
 
void set_style (border_style_t style)
 Sets the preferred style. More...
 
- Public Member Functions inherited from firevision::Filter
 Filter (const char *name, unsigned int max_num_buffers=1)
 Constructor. More...
 
virtual ~Filter ()
 Destructor. More...
 
virtual void set_src_buffer (unsigned char *buf, ROI *roi, orientation_t ori=ORI_HORIZONTAL, unsigned int buffer_num=0)
 Set source buffer with orientation. More...
 
virtual void set_src_buffer (unsigned char *buf, ROI *roi, unsigned int buffer_num)
 Set source buffer. More...
 
virtual void set_dst_buffer (unsigned char *buf, ROI *roi)
 Set the destination buffer. More...
 
virtual void set_orientation (orientation_t ori, unsigned int buffer_num)
 Set the orientation to apply the filter in. More...
 
virtual const char * name ()
 Get filter name. More...
 
void shrink_region (ROI *r, unsigned int n)
 This shrinks the regions as needed for a N x N matrix. More...
 

Additional Inherited Members

- Protected Attributes inherited from firevision::Filter
unsigned int _max_num_buffers
 Maximum number of buffers. More...
 
char * _name
 Filter name. More...
 
unsigned char ** src
 Source buffers, dynamically allocated by Filter ctor. More...
 
unsigned char * dst
 Destination buffer. More...
 
ROI ** src_roi
 Source ROIs, dynamically allocated by Filter ctor. More...
 
ROIdst_roi
 Destination ROI. More...
 
orientation_t * ori
 Orientations, one for each source image. More...
 

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

◆ 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

◆ FilterROIDraw()

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

Constructor.

Parameters
roisoptional list of ROIs to draw additionally to the dst_roi
styleoptional border style (default is INVERTED)

Definition at line 45 of file roidraw.cpp.

◆ ~FilterROIDraw()

Member Function Documentation

◆ apply()

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.

◆ set_rois()

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
roislist of ROIs to draw additionally to the dst_roi.

Definition at line 143 of file roidraw.cpp.

◆ set_style()

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

Sets the preferred style.

Parameters
styleThe preferred style

Definition at line 153 of file roidraw.cpp.


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