iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
LowPass.H
Go to the documentation of this file.
1 /*! @file
2  @author Laurent Itti
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 #ifndef INCLUDE_NRT_IMAGEPROC_FILTERING_LOWPASS_H
37 #define INCLUDE_NRT_IMAGEPROC_FILTERING_LOWPASS_H
38 
39 #include <nrt/Core/Image/Image.H>
41 #include <nrt/Core/Typing/Macros.H>
45 
47 
48 namespace nrt
49 {
50  /*! \defgroup lowpass Low-Pass / Blur Operations
51 
52  Methods for performing low-pass (blurring) operations on Images. Each of these methods takes a filter size (N),
53  which they will use to select a proper filter at runtime. If N is 3, 5, or 9, then these methods will just forward
54  the work to some very optimized methods (see \link lowpasshelpers Low Pass Helpers \endlink). Otherwise, a new
55  binomial kernel will be computed on the fly and the Image will be filtered with the newly computed kernel. Thus,
56  if you need to perform a low pass many times with some odd-ball sized kernel, you could save a few clock cycles by
57  computing the kernel manually using the binomialKernel() method, and then passing it to separableFilter().
58 
59  \ingroup imagefiltering
60  \see imagefiltering */
61 
62  /*! @{ */ // **********************************************************************
63 
64  //! Low-pass filter, NxN applied in X and Y
65  /*! This method just calls lowPassX() and lowPassY() in sequence. */
66  template <NRT_PROMOTE_PIX_NO_DEFAULT_PROMO>
67  Image<DestType> lowPass(int const N, Image<PixType> const & src);
68 
69  //! Low-pass filter, Nx1 separable, applied in X
70  template <NRT_PROMOTE_PIX_NO_DEFAULT_PROMO>
71  Image<DestType> lowPassX(int const N, Image<PixType> const & src);
72 
73  //! Low-pass filter, 1xN separable, applied in Y
74  template <NRT_PROMOTE_PIX_NO_DEFAULT_PROMO>
75  Image<DestType> lowPassY(int const N, Image<PixType> const & src);
76 
77  /*! @} */ // **********************************************************************
78 
80 } // namespace nrt
81 
82 //! Include implementation details
84 
85 #endif // INCLUDE_NRT_IMAGEPROC_FILTERING_LOWPASS_H