Filter.H

Go to the documentation of this file.

// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// JeVois Smart Embedded Machine Vision Toolkit - Copyright (C) 2017 by Laurent Itti, the University of Southern
// California (USC), and iLab at USC. See http://iLab.usc.edu and http://jevois.org for information about this project.
//
// This file is part of the JeVois Smart Embedded Machine Vision Toolkit.  This program is free software; you can
// redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software
// Foundation, version 2.  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
// License for more details.  You should have received a copy of the GNU General Public License along with this program;
// if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// Contact information: Laurent Itti - 3641 Watt Way, HNB-07A - Los Angeles, CA 90089-2520 - USA.
// Tel: +1 213 740 3527 - itti@pollux.usc.edu - http://iLab.usc.edu - http://jevois.org
// ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/*! \file */
 
#pragma once
 
#include <jevois/Component/Component.H>
#include <opencv2/core.hpp>
 
/*! \defgroup filters Image filters
 
    Collection of filters using OpenCV filtering functions.
 
    \ingroup components */
 
//! Base class for an image filter
/*! This base class defines a single process() function that takes a cv::Mat in and outputs a cv::Mat with the
    results. \ingroup filters */
class Filter : public jevois::Component
{
  public:
    //! Inherited constructor ok
    using jevois::Component::Component;
 
    //! Virtual destructor for safe inheritance
    virtual ~Filter();
    
    //! Processing function: filters the image src and puts results into dst, returns string with parameter settings
    virtual std::string process(cv::Mat const & src, cv::Mat & dst) = 0;
};