labeled_image.hh

// Copyright (C) 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_CORE_IMAGE_IMORPH_LABELED_IMAGE_HH
# define MLN_CORE_IMAGE_IMORPH_LABELED_IMAGE_HH


# include <mln/core/image/dmorph/image_if.hh>
# include <mln/core/concept/function.hh>
# include <mln/core/internal/image_identity.hh>
# include <mln/core/site_set/box.hh>

# include <mln/accu/pair.hh>
# include <mln/accu/nil.hh>
# include <mln/accu/center.hh>

# include <mln/labeling/compute.hh>
# include <mln/labeling/pack.hh>
# include <mln/labeling/relabel.hh>

# include <mln/util/array.hh>

# include <mln/pw/cst.hh>
# include <mln/pw/value.hh>

# ifndef NDEBUG
#  include <mln/accu/stat/max.hh>
#  include <mln/data/compute.hh>
# endif // ! NDEBUG


namespace mln
{

  // Forward declarations.
  template <typename I> struct labeled_image;
  namespace accu
  {
    template <typename T> struct nil;
    template <typename T> struct bbox;
  }


  namespace internal
  {

    template <typename I>
    struct data< labeled_image<I> >
    {
      data(const I& ima, const mln_value(I)& nlabels);

      I ima_;
      mln_value(I) nlabels_;
      mutable util::array< box<mln_psite(I)> > bboxes_;
    };

  } // end of namespace mln::internal


  namespace trait
  {

    template <typename I>
    struct image_< labeled_image<I> > : image_< I > // Same as I except...
    {
      // ...these changes.
      typedef trait::image::category::identity_morpher category;
      typedef mln_internal_trait_image_speed_from(I) speed; // Un-fastest.
      typedef trait::image::value_access::indirect value_access;

      typedef trait::image::value_io::read_only value_io;
      typedef trait::image::pw_io::read pw_io;

      // extended domain
      typedef trait::image::ext_value::multiple  ext_value;
      typedef trait::image::ext_io::read_only    ext_io;
    };

  } // end of namespace mln::trait



  //
  template <typename I>
  class labeled_image
    : public internal::image_identity< const I, mln_domain(I), labeled_image<I> >
  {
    typedef internal::image_identity< const I, mln_domain(I), labeled_image<I> >
            super_;

  public:

    typedef labeled_image< tag::image_<I> > skeleton;

    typedef mln_result(accu::shape::bbox<mln_psite(I)>) bbox_t;

    labeled_image();

    labeled_image(const I& ima, const mln_value(I)& nlabels);

    void init_(const I& ima, const mln_value(I)& nlabels);

    void init_from_(const labeled_image<I>& model);

    //
    template <typename F>
    void relabel(const Function_v2v<F>& f);
    //
    template <typename F>
    void relabel(const Function_v2b<F>& f);

    void pack_();

    mln_value(I) nlabels() const;

    void update_();

    const bbox_t& bbox(const mln_value(I)& label) const;

    const util::array<bbox_t>& bboxes() const;

      p_if<mln_box(I),
           fun::eq_v2b_expr_<pw::value_<I>, pw::cst_<mln_value(I)> > >
      subdomain(const mln_value(I)& label) const;
  };


  // init_

  //FIXME: not enough generic? We would like 'J' instead of
  // 'labeled_image<I>'.
  template <typename I, typename J>
  void init_(tag::image_t, labeled_image<I>& target,
                           const labeled_image<J>& model);



  namespace make
  {

    template <typename I>
    mln::labeled_image<I>
    labeled_image(const Image<I>& ima, const mln_value(I)& nlabels);

  } // end of namespace mln::make




# ifndef MLN_INCLUDE_ONLY


  // internal::data< labeled_image<I> >

  namespace internal
  {


    // data< labeled_image<I> >

    template <typename I>
    inline
    data< labeled_image<I> >::data(const I& ima, const mln_value(I)& nlabels)
      : ima_(ima), nlabels_(nlabels)
    {
    }

  } // end of namespace mln::internal


  template <typename I>
  inline
  labeled_image<I>::labeled_image()
  {
  }

  template <typename I>
  inline
  labeled_image<I>::labeled_image(const I& ima, const mln_value(I)& nlabels)
  {
    init_(ima, nlabels);
  }

  template <typename I>
  inline
  void
  labeled_image<I>::init_(const I& ima, const mln_value(I)& nlabels)
  {
    mln_precondition(data::compute(accu::meta::stat::max(), ima) == nlabels);
    this->data_ = new internal::data< labeled_image<I> >(ima, nlabels);
    this->update_();
 }

  template <typename I>
  inline
  void
  labeled_image<I>::init_from_(const labeled_image<I>& model)
  {
    this->data_
      = new internal::data< labeled_image<I> >(duplicate(model.hook_data_()->ima_),
                                                 model.nlabels());
    this->data_->bboxes_ = model.hook_data_()->bboxes_;
  }

  template <typename I>
  template <typename F>
  inline
  void
  labeled_image<I>::relabel(const Function_v2v<F>& f_)
  {
    const F& f = exact(f_);
    labeling::relabel_inplace(this->data_->ima_, this->data_->nlabels_, f);

    pack_();

    this->update_();
  }

  template <typename I>
  template <typename F>
  inline
  void
  labeled_image<I>::relabel(const Function_v2b<F>& f_)
  {
    const F& f = exact(f_);
    labeling::relabel_inplace(this->data_->ima_, this->data_->nlabels_, f);

    this->update_();
  }

  template <typename I>
  inline
  void
  labeled_image<I>::pack_()
  {
    labeling::pack_inplace(this->data_->ima_, this->data_->nlabels_);

    this->update_();
  }


  template <typename I>
  inline
  mln_value(I)
  labeled_image<I>::nlabels() const
  {
    return this->data_->nlabels_;
  }


  // init_

  template <typename I, typename J>
  void init_(tag::image_t, labeled_image<I>& target,
             const labeled_image<J>& model)
  {
    I ima;
    init_(tag::image, ima, model);
    target.init_(ima, model.nlabels());
  }


  template <typename I>
  void
  labeled_image<I>::update_()
  {
    this->data_->bboxes_ = labeling::compute(accu::meta::shape::bbox(),
                                             this->data_->ima_,
                                             this->data_->nlabels_);
  }


  template <typename I>
  const typename labeled_image<I>::bbox_t&
  labeled_image<I>::bbox(const mln_value(I)& label) const
  {
    return this->data_->bboxes_[label];
  }


  template <typename I>
  const util::array<typename labeled_image<I>::bbox_t>&
  labeled_image<I>::bboxes() const
  {
      return this->data_->bboxes_;
  }


  template <typename I>
  p_if<mln_box(I),
       fun::eq_v2b_expr_<pw::value_<I>, pw::cst_<mln_value(I)> > >
  labeled_image<I>::subdomain(const mln_value(I)& label) const
  {
    return ((this->data_->ima_ | bbox(label))
            | (pw::value(this->data_->ima_) == pw::cst(label))).domain();
  }


  // Make routines.

  namespace make
  {

    template <typename I>
    mln::labeled_image<I>
    labeled_image(const Image<I>& ima, const mln_value(I)& nlabels)
    {
      mln_precondition(exact(ima).is_valid());
      mln::labeled_image<I> tmp(exact(ima), nlabels);
      return tmp;
    }

  } // end of namespace mln::make


# endif // ! MLN_INCLUDE_ONLY

} // end of namespace mln


#endif // ! MLN_CORE_IMAGE_IMORPH_LABELED_IMAGE_HH