Fawkes API  Fawkes Development Version
firevision::FilterOpening Class Reference

Morphological opening. More...

#include <>>

Inheritance diagram for firevision::FilterOpening:

Public Member Functions

 FilterOpening ()
 Constructor. More...
 
virtual ~FilterOpening ()
 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_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...
 
virtual void apply ()
 Apply the filter. More...
 
- Public Member Functions inherited from firevision::MorphologicalFilter
 MorphologicalFilter (const char *name, unsigned int max_num_buffers=1)
 Constructor. More...
 
virtual ~MorphologicalFilter ()
 Destructor. 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_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::MorphologicalFilter
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 opening.

Author
Tim Niemueller

Definition at line 37 of file opening.h.

Constructor & Destructor Documentation

◆ FilterOpening()

firevision::FilterOpening::FilterOpening ( )

Constructor.

Definition at line 44 of file opening.cpp.

◆ ~FilterOpening()

firevision::FilterOpening::~FilterOpening ( )
virtual

Destructor.

Definition at line 53 of file opening.cpp.

Member Function Documentation

◆ apply()

void firevision::FilterOpening::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 98 of file opening.cpp.

References firevision::FilterErosion::apply(), and firevision::FilterDilation::apply().

◆ set_dst_buffer()

void firevision::FilterOpening::set_dst_buffer ( unsigned char *  buf,
ROI roi 
)
virtual

Set the destination buffer.

Parameters
bufBuffer to use as destination image
roiRegion Of Interest where the result is put in the dst image

Reimplemented from firevision::Filter.

Definition at line 78 of file opening.cpp.

References firevision::Filter::set_dst_buffer(), and firevision::Filter::set_src_buffer().

◆ set_src_buffer() [1/2]

void firevision::FilterOpening::set_src_buffer ( unsigned char *  buf,
ROI roi,
orientation_t  ori = ORI_HORIZONTAL,
unsigned int  buffer_num = 0 
)
virtual

Set source buffer with orientation.

Parameters
bufBuffer to use as source image
roiRegion Of Interest to work on
oriOrientation to apply the filter in, maybe ignored in some filters
buffer_numsource buffer to set for filter that need multiple src buffers
Exceptions
OutOfBoundsExceptionThrown if buffer_num is illegal

Reimplemented from firevision::Filter.

Definition at line 61 of file opening.cpp.

References firevision::Filter::set_src_buffer().

◆ set_src_buffer() [2/2]

void firevision::FilterOpening::set_src_buffer ( unsigned char *  buf,
ROI roi,
unsigned int  buffer_num 
)
virtual

Set source buffer.

Parameters
bufBuffer to use as source image
roiRegion Of Interest to work on
buffer_numsource buffer to set for filter that need multiple src buffers
Exceptions
OutOfBoundsExceptionThrown if buffer_num is illegal

Reimplemented from firevision::Filter.

Definition at line 70 of file opening.cpp.

References firevision::Filter::set_src_buffer().

◆ set_structuring_element()

void firevision::FilterOpening::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 from firevision::MorphologicalFilter.

Definition at line 87 of file opening.cpp.

References firevision::MorphologicalFilter::set_structuring_element().


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