filter.hh

// Copyright (C) 2001, 2002, 2003, 2004, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena 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 of the License.
//
// Olena 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 Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_LINEAR_GAUSSIAN_FILTER_HH
# define MLN_LINEAR_GAUSSIAN_FILTER_HH


# include <mln/core/concept/image.hh>
# include <mln/linear/gaussian/impl.hh>
# include <mln/linear/gaussian/internal/coefficients.hh>


namespace mln
{

  namespace linear
  {

    namespace gaussian
    {

      template <typename I>
      mln_concrete(I)
      filter(const Image<I>& input, double sigma);


      template <typename I>
      mln_concrete(I)
      filter(const Image<I>& input, double sigma, int dir);



# ifndef MLN_INCLUDE_ONLY


      // Facades.

      template <typename I>
      inline
      mln_concrete(I)
      filter(const Image<I>& input, double sigma, int dir)
      {
        trace::entering("linear::gaussian::filter");

        mln_precondition(exact(input).is_valid());
        mln_precondition(dir < I::site::dim);

        mln_concrete(I) output;
        initialize(output, input);

        internal::coefficients coef = internal::coefficients_not_derivative(sigma);

        impl::generic_filter_common_(mln_trait_value_nature(mln_value(I))(),
                                     input, coef, sigma, output, dir);

        trace::exiting("linear::gaussian::filter");
        return output;
      }




      template <typename I>
      inline
      mln_concrete(I)
      filter(const Image<I>& input, double sigma)
      {
        trace::entering("linear::gaussian::filter");

        mln_precondition(exact(input).is_valid());

        mln_concrete(I) output;
        initialize(output, input);

        internal::coefficients coef = internal::coefficients_not_derivative(sigma);

        impl::generic_filter_common_(mln_trait_value_nature(mln_value(I))(),
                                     input, coef, sigma, output);

        trace::exiting("linear::gaussian::filter");
        return output;
      }


# endif // ! MLN_INCLUDE_ONLY

    } // end of namespace mln::linear::gaussian

  } // end of namespace mln::linear

} // end of namespace mln


#endif // ! MLN_LINEAR_GAUSSIAN_FILTER_HH