iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SeparableFilter.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 
37 #ifndef INCLUDE_NRT_IMAGEPROC_FILTERING_SEPARABLEFILTER_H
38 #define INCLUDE_NRT_IMAGEPROC_FILTERING_SEPARABLEFILTER_H
39 
40 #include <nrt/Core/Image/Image.H>
42 #include <nrt/Core/Typing/Macros.H>
43 
44 namespace nrt
45 {
46 
47  /*! \defgroup separablefilter Separable Filtering
48 
49  These methods perform convolution of a separable kernel and an Image using a given \ref ConvolutionBoundaryStrategy
50  "convolution boundary strategy."
51 
52  \ingroup imagefiltering
53  \see imagefiltering */
54 
55  /*! @{ */ // **********************************************************************
56 
57  //! Convolution boundary strategies
59  {
60  ZERO, //!< zero-pad, i.e., a black border is simulated around the source image
61  CLEAN, //!< normalize by the sum of the used filter coefficients (see Itti and Koch, Vision Research, 2000)
62  REPLICATE //!< replicate the nearest image pixel value
63  };
64 
65  //! Convolve a horizontal 1-D kernel with the input Image using the given boundary strategy
66  template <NRT_PROMOTE_PIX(double)>
67  Image<DestType> const
68  xFilter(Image<PixType> const src, Image<DestType> const hKernel, ConvolutionBoundaryStrategy const boundary);
69 
70  //! Convolve a vertical 1-D kernel with the input Image using the given boundary strategy
71  template <NRT_PROMOTE_PIX(double)>
72  Image<DestType> const
73  yFilter(Image<PixType> const src, Image<DestType> const vKernel, ConvolutionBoundaryStrategy const boundary);
74 
75  //! Convolve horizontal and vertical separable kernels with the input Image using the given boundary strategy
76  /*! Internally, this method just calls nrt::yFilter(nrt::xFilter(src, hKernel), vKernel) */
77  template <NRT_PROMOTE_PIX(double)>
78  Image<DestType> const
79  separableFilter(Image<PixType> const src, Image<DestType> const hKernel, Image<DestType> const vKernel,
80  ConvolutionBoundaryStrategy const boundary);
81 
82  //! Convolve a single separable filter (either 1xN or Nx1) with the input Image using the given boundary strategy
83  /*! Internally, this method just calls yFilter() OR xFilter(), depending on whether kernel is a row or a column */
84  template <NRT_PROMOTE_PIX(double)>
85  Image<DestType> const
86  separableFilter(Image<PixType> const src, Image<DestType> const kernel,
87  ConvolutionBoundaryStrategy const boundary);
88 
89  /*! @} */ // **********************************************************************
90 }
91 
92 //! Include implementation details
94 
95 #endif // INCLUDE_NRT_IMAGEPROC_FILTERING_SEPARABLEFILTER_H
96