JeVoisBase  1.20
JeVois Smart Embedded Machine Vision Toolkit Base Modules
Share this page:
Filter.H
Go to the documentation of this file.
1 // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
2 //
3 // JeVois Smart Embedded Machine Vision Toolkit - Copyright (C) 2017 by Laurent Itti, the University of Southern
4 // California (USC), and iLab at USC. See http://iLab.usc.edu and http://jevois.org for information about this project.
5 //
6 // This file is part of the JeVois Smart Embedded Machine Vision Toolkit. This program is free software; you can
7 // redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software
8 // Foundation, version 2. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
9 // without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
10 // License for more details. You should have received a copy of the GNU General Public License along with this program;
11 // if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
12 //
13 // Contact information: Laurent Itti - 3641 Watt Way, HNB-07A - Los Angeles, CA 90089-2520 - USA.
14 // Tel: +1 213 740 3527 - itti@pollux.usc.edu - http://iLab.usc.edu - http://jevois.org
15 // ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
16 /*! \file */
17 
18 #pragma once
19 
21 #include <opencv2/core.hpp>
22 
23 /*! \defgroup filters Image filters
24 
25  Collection of filters using OpenCV filtering functions.
26 
27  \ingroup components */
28 
29 //! Base class for an image filter
30 /*! This base class defines a single process() function that takes a cv::Mat in and outputs a cv::Mat with the
31  results. \ingroup filters */
32 class Filter : public jevois::Component
33 {
34  public:
35  //! Inherited constructor ok
37 
38  //! Virtual destructor for safe inheritance
39  virtual ~Filter();
40 
41  //! Processing function: filters the image src and puts results into dst, returns string with parameter settings
42  virtual std::string process(cv::Mat const & src, cv::Mat & dst) = 0;
43 };
jevois::ParameterRegistry::Component
friend friend class Component
jevois::Component
Filter::~Filter
virtual ~Filter()
Virtual destructor for safe inheritance.
Definition: Filter.C:20
Filter
Base class for an image filter.
Definition: Filter.H:32
Component.H
Filter::process
virtual std::string process(cv::Mat const &src, cv::Mat &dst)=0
Processing function: filters the image src and puts results into dst, returns string with parameter s...