tr_image.hh

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


# include <cmath>

# include <mln/core/internal/image_identity.hh>
# include <mln/algebra/vec.hh>
# include <mln/value/set.hh>


namespace mln
{

  // Forward declaration.
  template <typename S, typename I, typename T> struct tr_image;

  namespace internal
  {

    template <typename S, typename I, typename T>
    struct data< tr_image<S,I,T> >
    {
      data(const S& s, const I& ima, const T& tr);

      I ima_;
      T tr_;
      S s_;
    };

  } // end of namespace mln::internal

  namespace trait
  {

    template <typename S, typename I, typename T>
    struct image_< tr_image<S,I,T> >
      : public image_<I> // Same as I except...
    {
      // ...these changes.
      typedef trait::image::value_io::read_only value_io;
      typedef mln_internal_trait_image_speed_from(I) speed; // Un-fastest.
    };

  } // end of namespace mln::trait


  //
  template <typename S, typename I, typename T>
  struct tr_image :
    public mln::internal::image_identity< I, S, tr_image<S,I,T> >
  {

    typedef
    mln::internal::image_identity< I, S, tr_image<S,I,T> > super_;

    typedef mln_psite(I) psite;

    typedef mln_site(I) site;

    typedef mln_value(I) value;

    typedef mln_value(I) lvalue; // FIXME: Depends on lvalue presence in I.

    typedef mln_value(I) rvalue;

    typedef tr_image< S, tag::image_<I>, T> skeleton;


    tr_image(const S& s, const I& ima, const T& tr);
    /* FIXME: What's the purpose of this ctor?  AFAIK, morphers
       objects (and images in general) cannot have their structure /
       core data altered after they're built.  Here, there's a
       (partial) exception: this morpher provides set_tr(), but has no
       set_ima().  I (Roland) don't see the point in keeping this ctor
       if we do not provide set_ima().  */
    tr_image();

    void init_(const S& s, const I& ima, const T& tr);

    bool is_valid() const;

    using super_::has;

    enum { dim_ = site::dim };
    typedef mln::algebra::vec<dim_, float> vec_t;

    bool has(const vec_t& v) const;

    //using super_::operator();

    mln_value(I) operator()(const psite& p) const;
    mln_value(I) operator()(const psite& p);

    void set_tr(T& tr);

    const T& tr() const;

    const S& domain() const;
  };



# ifndef MLN_INCLUDE_ONLY

  namespace internal
  {

    // internal::data< tr_image<I,S> >

    template <typename S, typename I, typename T>
    inline
    data< tr_image<S,I,T> >::data(const S& s, const I& ima, const T& tr)
      : ima_(ima),
        tr_(tr),
        s_(s)
    {
    }

  } // end of namespace mln::internal

  template <typename S, typename I, typename T>
  inline
  tr_image<S,I,T>::tr_image(const S& s, const I& ima, const T& tr)
  {
    init_(s, ima, tr);
  }

  template <typename S, typename I, typename T>
  inline
  void
  tr_image<S,I,T>::init_(const S& s, const I& ima, const T& tr)
  {
    mln_precondition(ima.is_valid());
    this->data_ = new internal::data< tr_image<S,I,T> >(s, ima, tr);
  }

  template <typename S, typename I, typename T>
  inline
  bool
  tr_image<S,I,T>::is_valid() const
  {
    mln_invariant(this->delegatee_()->is_valid());
    return true;
  }

  template <typename S, typename I, typename T>
  inline
  bool
  tr_image<S,I,T>::has(const vec_t& v) const
  {
    mln_psite(I) p;
    algebra::vec<site::dim, float> v2 = this->data_->tr_.inv()(v);
    for (unsigned i = 0; i < site::dim; ++i)
      p[i] = static_cast<int>(v2[i]);
    return this->delegatee_().has(p);
  }


  template <typename S, typename I, typename T>
  inline
  mln_value(I)
  tr_image<S,I,T>::operator()(const psite& p) const
  {
    algebra::vec<site::dim, float> v = p.to_vec();
    return this->data_->ima_(this->data_->tr_.inv()(v));
  }

  template <typename S, typename I, typename T>
  inline
  mln_value(I)
  tr_image<S,I,T>::operator()(const psite& p)
  {
    algebra::vec<site::dim, float> v = p.to_vec();
    return this->data_->ima_(this->data_->tr_.inv()(v));
  }

  template <typename S, typename I, typename T>
  inline
  void
  tr_image<S,I,T>::set_tr(T& tr)
  {
    this->data_->tr_ = tr;
  }

  template <typename S, typename I, typename T>
  inline
  const T&
  tr_image<S,I,T>::tr() const
  {
    return this->data_->tr_;
  }

  template <typename S, typename I, typename T>
  inline
  const S&
  tr_image<S,I,T>::domain() const
  {
    return this->data_->s_;
  }


  template <typename S, typename I, typename T>
  inline
  tr_image<S,I,T>
  transposed_image(const Site_Set<S>& s, const Image<I>& ima,
                   const Function_v2v<T>& t)
  {
    tr_image<S,I,T> tmp(exact(s), exact(ima), exact(t));
    return tmp;
  }

# endif // ! MLN_INCLUDE_ONLY

} // end of namespace mln


#endif // ! MLN_CORE_IMAGE_IMORPH_TR_IMAGE_HH