Fawkes API Fawkes Development Version
filter.h
1
2/***************************************************************************
3 * filter.h - Abstract class defining a filter
4 *
5 * Created: Tue May 03 19:50:02 2005
6 * Copyright 2005-2007 Tim Niemueller [www.niemueller.de]
7 *
8 ****************************************************************************/
9
10/* This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version. A runtime exception applies to
14 * this software (see LICENSE.GPL_WRE file mentioned below for details).
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Library General Public License for more details.
20 *
21 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22 */
23
24#ifndef _FIREVISION_FILTER_H_
25#define _FIREVISION_FILTER_H_
26
27#include <fvutils/base/roi.h>
28#include <fvutils/base/types.h>
29
30namespace firevision {
31
32class Filter
33{
34public:
35 Filter(const char *name, unsigned int max_num_buffers = 1);
36 virtual ~Filter();
37
38 virtual void set_src_buffer(unsigned char *buf,
39 ROI * roi,
40 orientation_t ori = ORI_HORIZONTAL,
41 unsigned int buffer_num = 0);
42
43 virtual void set_src_buffer(unsigned char *buf, ROI *roi, unsigned int buffer_num);
44
45 virtual void set_dst_buffer(unsigned char *buf, ROI *roi);
46
47 virtual void set_orientation(orientation_t ori, unsigned int buffer_num);
48 virtual const char *name();
49
50 virtual void apply() = 0;
51
52 void shrink_region(ROI *r, unsigned int n);
53
54protected:
55 /** Maximum number of buffers */
56 unsigned int _max_num_buffers;
57 /** Filter name */
58 char *_name;
59
60 /** Source buffers, dynamically allocated by Filter ctor. */
61 unsigned char **src;
62 /** Destination buffer */
63 unsigned char *dst;
64
65 /** Source ROIs, dynamically allocated by Filter ctor. */
67 /** Destination ROI */
69
70 /** Orientations, one for each source image */
71 orientation_t *ori;
72};
73
74} // end namespace firevision
75
76#endif
Filter interface.
Definition: filter.h:33
ROI ** src_roi
Source ROIs, dynamically allocated by Filter ctor.
Definition: filter.h:66
virtual void set_dst_buffer(unsigned char *buf, ROI *roi)
Set the destination buffer.
Definition: filter.cpp:123
unsigned int _max_num_buffers
Maximum number of buffers.
Definition: filter.h:56
virtual const char * name()
Get filter name.
Definition: filter.cpp:148
char * _name
Filter name.
Definition: filter.h:58
void shrink_region(ROI *r, unsigned int n)
This shrinks the regions as needed for a N x N matrix.
Definition: filter.cpp:158
unsigned char ** src
Source buffers, dynamically allocated by Filter ctor.
Definition: filter.h:61
Filter(const char *name, unsigned int max_num_buffers=1)
Constructor.
Definition: filter.cpp:51
virtual void apply()=0
Apply the filter.
virtual ~Filter()
Destructor.
Definition: filter.cpp:71
unsigned char * dst
Destination buffer.
Definition: filter.h:63
ROI * dst_roi
Destination ROI.
Definition: filter.h:68
orientation_t * ori
Orientations, one for each source image.
Definition: filter.h:71
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.
Definition: filter.cpp:89
virtual void set_orientation(orientation_t ori, unsigned int buffer_num)
Set the orientation to apply the filter in.
Definition: filter.cpp:135
Region of interest.
Definition: roi.h:55