Fawkes API  Fawkes Development Version
firevision::MorphologicalFilter Class Reference

Morphological filter interface. More...

#include <>>

Inheritance diagram for firevision::MorphologicalFilter:

Public Member Functions

 MorphologicalFilter (const char *name, unsigned int max_num_buffers=1)
 Constructor. More...
 
virtual ~MorphologicalFilter ()
 Destructor. More...
 
virtual void set_structuring_element (unsigned char *se, unsigned int se_width, unsigned int se_height, unsigned int se_anchor_x, unsigned int se_anchor_y)
 Set the structuring element for successive filter runs. 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...
 
virtual void apply ()=0
 Apply the filter. More...
 
void shrink_region (ROI *r, unsigned int n)
 This shrinks the regions as needed for a N x N matrix. More...
 

Protected Attributes

unsigned char * se
 Structuring element. More...
 
unsigned int se_width
 Width of structuring element. More...
 
unsigned int se_height
 Height of structuring element. More...
 
unsigned int se_anchor_x
 Anchor point x offset of structuring element. More...
 
unsigned int se_anchor_y
 Anchor point y offset of structuring element. More...
 
- 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

Morphological filter interface.

This interface defines specific API details for morphological filters.

Author
Tim Niemueller

Definition at line 37 of file morphologicalfilter.h.

Constructor & Destructor Documentation

◆ MorphologicalFilter()

firevision::MorphologicalFilter::MorphologicalFilter ( const char *  name,
unsigned int  max_num_buffers = 1 
)

Constructor.

Parameters
namefilter name
max_num_buffersmaximum number of source buffers.

Definition at line 43 of file morphologicalfilter.cpp.

References se, se_anchor_x, se_anchor_y, se_height, and se_width.

◆ ~MorphologicalFilter()

firevision::MorphologicalFilter::~MorphologicalFilter ( )
virtual

Destructor.

Definition at line 52 of file morphologicalfilter.cpp.

Member Function Documentation

◆ set_structuring_element()

void firevision::MorphologicalFilter::set_structuring_element ( unsigned char *  se,
unsigned int  se_width,
unsigned int  se_height,
unsigned int  se_anchor_x,
unsigned int  se_anchor_y 
)
virtual

Set the structuring element for successive filter runs.

Parameters
sestructuring element buffer. This is just a line-wise concatenated array of values. A value of zero means ignore, any other value means to consider this value.
se_widthwidth of structuring element
se_heightheight of structuring element
se_anchor_xx coordinate of anchor in structuring element
se_anchor_yy coordinate of anchor in structuring element

Reimplemented in firevision::FilterClosing, and firevision::FilterOpening.

Definition at line 67 of file morphologicalfilter.cpp.

References se, se_anchor_x, se_anchor_y, se_height, and se_width.

Referenced by firevision::FilterGeodesicDilation::FilterGeodesicDilation(), firevision::FilterGeodesicErosion::FilterGeodesicErosion(), firevision::FilterOpening::set_structuring_element(), and firevision::FilterClosing::set_structuring_element().

Member Data Documentation

◆ se

◆ se_anchor_x

unsigned int firevision::MorphologicalFilter::se_anchor_x
protected

◆ se_anchor_y

unsigned int firevision::MorphologicalFilter::se_anchor_y
protected

◆ se_height

unsigned int firevision::MorphologicalFilter::se_height
protected

◆ se_width

unsigned int firevision::MorphologicalFilter::se_width
protected

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