top_hat.hh

// Copyright (C) 2007, 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_MORPHO_TOP_HAT_HH
# define MLN_MORPHO_TOP_HAT_HH


# include <mln/morpho/opening/structural.hh>
# include <mln/morpho/closing/structural.hh>


namespace mln
{

  namespace morpho
  {


    //
    template <typename I, typename W>
    mln_concrete(I)
    top_hat_white(const Image<I>& input, const Window<W>& win);


    //
    template <typename I, typename W>
    mln_concrete(I)
    top_hat_black(const Image<I>& input, const Window<W>& win);


    //
    template <typename I, typename W>
    mln_concrete(I)
    top_hat_self_complementary(const Image<I>& input, const Window<W>& win);



# ifndef MLN_INCLUDE_ONLY


    template <typename I, typename W>
    inline
    mln_concrete(I)
    top_hat_white(const Image<I>& input, const Window<W>& win)
    {
      trace::entering("morpho::top_hat_white");

      mln_precondition(exact(input).is_valid());
      mln_precondition(! exact(win).is_empty());

      mln_concrete(I) output = morpho::minus(input,
                                             opening::structural(input, win));

      mln_postcondition(test::positive(output));

      trace::exiting("morpho::top_hat_white");
      return output;
    }


    template <typename I, typename W>
    inline
    mln_concrete(I) top_hat_black(const Image<I>& input, const Window<W>& win)
    {
      trace::entering("morpho::top_hat_black");

      mln_precondition(exact(input).is_valid());
      mln_precondition(! exact(win).is_empty());

      mln_concrete(I) output = morpho::minus(closing::structural(input, win),
                                             input);

      mln_postcondition(test::positive(output));

      trace::exiting("morpho::top_hat_black");
      return output;
    }


    template <typename I, typename W>
    inline
    mln_concrete(I) top_hat_self_complementary(const Image<I>& input, const Window<W>& win)
    {
      trace::entering("morpho::top_hat_self_complementary");

      mln_precondition(exact(input).is_valid());
      mln_precondition(! exact(win).is_empty());

      mln_concrete(I) output = morpho::minus(closing::structural(input, win),
                                             opening::structural(input, win));

      mln_postcondition(test::positive(output));

      trace::exiting("morpho::top_hat_self_complementary");
      return output;
    }


# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::morpho

} // end of namespace mln


#endif // ! MLN_MORPHO_TOP_HAT_HH