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/types.h>
28 #include <fvutils/base/roi.h>
29 
30 namespace firevision {
31 #if 0 /* just to make Emacs auto-indent happy */
32 }
33 #endif
34 
35 class Filter
36 {
37  public:
38  Filter(const char *name, unsigned int max_num_buffers = 1);
39  virtual ~Filter();
40 
41  virtual void set_src_buffer(unsigned char *buf, ROI *roi,
42  orientation_t ori = ORI_HORIZONTAL,
43  unsigned int buffer_num = 0);
44 
45  virtual void set_src_buffer(unsigned char *buf, ROI *roi,
46  unsigned int buffer_num);
47 
48  virtual void set_dst_buffer(unsigned char *buf, ROI *roi);
49 
50 
51  virtual void set_orientation(orientation_t ori, unsigned int buffer_num);
52  virtual const char * name();
53 
54  virtual void apply() = 0 ;
55 
56  void shrink_region(ROI *r, unsigned int n);
57 
58  protected:
59  /** Maximum number of buffers */
60  unsigned int _max_num_buffers;
61  /** Filter name */
62  char *_name;
63 
64  /** Source buffers, dynamically allocated by Filter ctor. */
65  unsigned char **src;
66  /** Destination buffer */
67  unsigned char *dst;
68 
69  /** Source ROIs, dynamically allocated by Filter ctor. */
71  /** Destination ROI */
73 
74  /** Orientations, one for each source image */
75  orientation_t *ori;
76 };
77 
78 } // end namespace firevision
79 
80 #endif
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:93
unsigned int _max_num_buffers
Maximum number of buffers.
Definition: filter.h:60
Region of interest.
Definition: roi.h:58
virtual ~Filter()
Destructor.
Definition: filter.cpp:75
virtual const char * name()
Get filter name.
Definition: filter.cpp:161
void shrink_region(ROI *r, unsigned int n)
This shrinks the regions as needed for a N x N matrix.
Definition: filter.cpp:172
unsigned char ** src
Source buffers, dynamically allocated by Filter ctor.
Definition: filter.h:65
Filter interface.
Definition: filter.h:35
virtual void apply()=0
Apply the filter.
Filter(const char *name, unsigned int max_num_buffers=1)
Constructor.
Definition: filter.cpp:54
ROI ** src_roi
Source ROIs, dynamically allocated by Filter ctor.
Definition: filter.h:70
unsigned char * dst
Destination buffer.
Definition: filter.h:67
orientation_t * ori
Orientations, one for each source image.
Definition: filter.h:75
ROI * dst_roi
Destination ROI.
Definition: filter.h:72
char * _name
Filter name.
Definition: filter.h:62
virtual void set_dst_buffer(unsigned char *buf, ROI *roi)
Set the destination buffer.
Definition: filter.cpp:134
virtual void set_orientation(orientation_t ori, unsigned int buffer_num)
Set the orientation to apply the filter in.
Definition: filter.cpp:147