image3d.hh

// Copyright (C) 2007, 2008, 2009, 2010, 2011 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_IMAGE3D_HH
# define MLN_CORE_IMAGE_IMAGE3D_HH


# include <mln/core/internal/fixme.hh>
# include <mln/core/internal/image_primary.hh>
# include <mln/core/alias/box3d.hh>

# include <mln/border/thickness.hh>
# include <mln/value/set.hh>
# include <mln/fun/i2v/all_to.hh>

// # include <mln/core/line_piter.hh>

// FIXME:

// # include <mln/core/pixter3d.hh>
// # include <mln/core/dpoints_pixter.hh>


namespace mln
{

  // Forward declaration.
  template <typename T> struct image3d;



  namespace internal
  {

    template <typename T>
    struct data< image3d<T> >
    {
      data(const box3d& b, unsigned bdr);
      ~data();

      T*  buffer_;
      T*** array_;

      box3d b_;  // theoretical box
      unsigned bdr_;
      box3d vb_; // virtual box, i.e., box including the virtual border

      void update_vb_();
      void allocate_();
      void deallocate_();
      void swap_ (data< image3d<T> >& other_);
      void reallocate_(unsigned new_border);
    };

  } // end of namespace mln::internal



  namespace trait
  {

    template <typename T>
    struct image_< image3d<T> > : default_image_< T, image3d<T> >
    {
      // misc
      typedef trait::image::category::primary category;
      typedef trait::image::speed::fastest    speed;
      typedef trait::image::size::regular     size;

      // value
      typedef trait::image::vw_io::none                    vw_io;
      typedef trait::image::vw_set::none                   vw_set;
      typedef trait::image::value_access::direct           value_access;
      typedef trait::image::value_storage::one_block       value_storage;
      typedef trait::image::value_browsing::site_wise_only value_browsing;
      typedef trait::image::value_alignment::with_grid     value_alignment;
      typedef trait::image::value_io::read_write           value_io;

      // site / domain
      typedef trait::image::pw_io::read_write        pw_io;
      typedef trait::image::localization::basic_grid localization;
      typedef trait::image::dimension::three_d         dimension;

      // extended domain
      typedef trait::image::ext_domain::extendable ext_domain;
      typedef trait::image::ext_value::multiple    ext_value;
      typedef trait::image::ext_io::read_write     ext_io;
    };

  } // end of namespace mln::trait



  //
  template <typename T>
  struct image3d : public internal::image_primary< T, box3d, image3d<T> >
  {
    // Warning: just to make effective types appear in Doxygen:
    typedef box3d   pset;
    typedef point3d psite;
    typedef point3d point;
    typedef dpoint3d dpoint;
    typedef mln_fwd_piter(box3d) fwd_piter;
    typedef mln_bkd_piter(box3d) bkd_piter;
//     typedef line_piter_<point> line_piter;
    // End of warning.


    typedef internal::image_primary< T, box3d, image3d<T> > super_;

    typedef T         value;

    typedef const T& rvalue;

    typedef T&       lvalue;


    typedef image3d< tag::value_<T> > skeleton;

    image3d();

    image3d(const box3d& b, unsigned bdr = border::thickness);

    image3d(int nslis, int nrows, int ncols, unsigned bdr = border::thickness);


    void init_(const box3d& b, unsigned bdr = border::thickness);


    bool has(const point3d& p) const;

    const box3d& domain() const;

    const box3d& bbox() const;

    const box3d& vbbox() const;

    unsigned border() const;

    unsigned nelements() const;

    const T& operator()(const point3d& p) const;

    T& operator()(const point3d& p);

    const T& element(unsigned i) const;

    T& element(unsigned i);

    const T& at_(def::coord sli, def::coord row, def::coord col) const;

    T& at_(def::coord sli, def::coord row, def::coord col);


    unsigned nslis() const;

    unsigned nrows() const;

    unsigned ncols() const;



    int delta_index(const dpoint3d& dp) const;

    point3d point_at_index(unsigned o) const;

    const T* buffer() const;

    T* buffer();

    using super_::data_;



    void resize_(unsigned new_border);

  };

  template <typename T, typename J>
  void init_(tag::image_t, mln::image3d<T>& target, const J& model);



# ifndef MLN_INCLUDE_ONLY

  // init_

  template <typename T>
  inline
  void init_(tag::border_t, unsigned& b, const image3d<T>& model)
  {
    b = model.border();
  }

  template <typename T, typename J>
  inline
  void init_(tag::image_t, image3d<T>& target, const J& model)
  {
    box3d b;
    init_(tag::bbox, b, model);
    unsigned bdr;
    init_(tag::border, bdr, model);
    target.init_(b, bdr);
  }


  // internal::data< image3d<T> >

  namespace internal
  {

    template <typename T>
    inline
    data< image3d<T> >::data(const box3d& b, unsigned bdr)
      : buffer_(0),
        array_ (0),
        b_     (b),
        bdr_   (bdr)
    {
      allocate_();
    }

    template <typename T>
    inline
    data< image3d<T> >::~data()
    {
      deallocate_();
    }

    template <typename T>
    inline
    void
    data< image3d<T> >::update_vb_()
    {
      vb_.pmin() = b_.pmin() - dpoint3d(all_to(bdr_));
      vb_.pmax() = b_.pmax() + dpoint3d(all_to(bdr_));
    }

    template <typename T>
    inline
    void
    data< image3d<T> >::allocate_()
    {
      update_vb_();
      unsigned
        ns = vb_.len(0),
        nr = vb_.len(1),
        nc = vb_.len(2);
      buffer_ = new T[nr * nc * ns];
      array_ = new T**[ns];
      T* buf = buffer_ - vb_.pmin().col();
      for (unsigned i = 0; i < ns; ++i)
      {
        T** tmp = new T*[nr];
        array_[i] = tmp;
        for (unsigned j = 0; j < nr; ++j)
        {
          array_[i][j] = buf;
          buf += nc;
        }
        array_[i] -= vb_.pmin().row();
      }
      array_ -= vb_.pmin().sli();
      mln_postcondition(vb_.len(0) == b_.len(0) + 2 * bdr_);
    }

    template <typename T>
    inline
    void
    data< image3d<T> >::deallocate_()
    {
      if (buffer_)
      {
        delete[] buffer_;
        buffer_ = 0;
      }
      for (typename point3d::coord i = vb_.pmin().sli(); i <= vb_.pmax().sli(); ++i)
      {
        if (array_[i])
        {
          array_[i] += vb_.pmin().row();
          delete[] array_[i];
          array_[i] = 0;
        }
      }
      if (array_)
      {
        array_ += vb_.pmin().sli();
        delete[] array_;
        array_ = 0;
      }
    }

    template <typename T>
    inline
    void
    data< image3d<T> >::swap_(data< image3d<T> >& other_)
    {
      data< image3d<T> > self_ = *this;
      *this = other_;
      other_ = self_;
    }

    template <typename T>
    inline
    void
    data< image3d<T> >::reallocate_(unsigned new_border)
    {
      data< image3d<T> >& tmp = *(new data< image3d<T> >(this->b_, new_border));
      this->swap_(tmp);
    }


  } // end of namespace mln::internal

  // image3d<T>

  template <typename T>
  inline
  image3d<T>::image3d()
  {
  }

  template <typename T>
  inline
  image3d<T>::image3d(const box3d& b, unsigned bdr)
  {
    init_(b, bdr);
  }

  template <typename T>
  inline
  image3d<T>::image3d(int nslis, int nrows, int ncols, unsigned bdr)
  {
    init_(make::box3d(nslis, nrows, ncols), bdr);
  }

  template <typename T>
  inline
  void
  image3d<T>::init_(const box3d& b, unsigned bdr)
  {
    mln_precondition(! this->is_valid());
    this->data_ = new internal::data< image3d<T> >(b, bdr);
  }

  template <typename T>
  inline
  const box3d&
  image3d<T>::domain() const
  {
    mln_precondition(this->is_valid());
    return data_->b_;
  }

  template <typename T>
  inline
  const box3d&
  image3d<T>::bbox() const
  {
    mln_precondition(this->is_valid());
    return data_->b_;
  }

  template <typename T>
  inline
  const box3d&
  image3d<T>::vbbox() const
  {
    mln_precondition(this->is_valid());
    return data_->vb_;
  }

  template <typename T>
  inline
  unsigned
  image3d<T>::border() const
  {
    mln_precondition(this->is_valid());
    return data_->bdr_;
  }

  template <typename T>
  inline
  unsigned
  image3d<T>::nelements() const
  {
    mln_precondition(this->is_valid());
    return data_->vb_.nsites();
  }

  template <typename T>
  inline
  bool
  image3d<T>::has(const point3d& p) const
  {
    mln_precondition(this->is_valid());
    return data_->vb_.has(p);
  }

  template <typename T>
  inline
  const T&
  image3d<T>::operator()(const point3d& p) const
  {
    mln_precondition(this->has(p));
    return data_->array_[p.sli()][p.row()][p.col()];
  }

  template <typename T>
  inline
  T&
  image3d<T>::operator()(const point3d& p)
  {
    mln_precondition(this->has(p));
    return data_->array_[p.sli()][p.row()][p.col()];
  }

  template <typename T>
  inline
  const T&
  image3d<T>::element(unsigned i) const
  {
    mln_precondition(i < nelements());
    return *(data_->buffer_ + i);
  }

  template <typename T>
  inline
  T&
  image3d<T>::element(unsigned i)
  {
    mln_precondition(i < nelements());
    return *(data_->buffer_ + i);
  }

  template <typename T>
  inline
  const T&
  image3d<T>::at_(def::coord sli, def::coord row, def::coord col) const
  {
    mln_precondition(this->has(point3d(sli, row, col)));
    return data_->array_[sli][row][col];
  }

  template <typename T>
  inline
  T&
  image3d<T>::at_(def::coord sli, def::coord row, def::coord col)
  {
    mln_precondition(this->has(point3d(sli, row, col)));
    return data_->array_[sli][row][col];
  }

  template <typename T>
  inline
  unsigned
  image3d<T>::nslis() const
  {
    mln_precondition(this->is_valid());
    return this->data_->b_.len(0);
  }

  template <typename T>
  inline
  unsigned
  image3d<T>::nrows() const
  {
    mln_precondition(this->is_valid());
    return this->data_->b_.len(1);
  }

  template <typename T>
  inline
  unsigned
  image3d<T>::ncols() const
  {
    mln_precondition(this->is_valid());
    return this->data_->b_.len(2);
  }

  template <typename T>
  inline
  const T*
  image3d<T>::buffer() const
  {
    mln_precondition(this->is_valid());
    return data_->buffer_;
  }

  template <typename T>
  inline
  T*
  image3d<T>::buffer()
  {
    mln_precondition(this->is_valid());
    return data_->buffer_;
  }

  template <typename T>
  inline
  int
  image3d<T>::delta_index(const dpoint3d& dp) const
  {
    mln_precondition(this->is_valid());
    int o = (dp[0] * this->data_->vb_.len(1)
             + dp[1]) * this->data_->vb_.len(2) + dp[2];
    return o;
  }

  template <typename T>
  inline
  point3d
  image3d<T>::point_at_index(unsigned o) const
  {
    mln_precondition(o < nelements());
    def::coord
      sli = static_cast<def::coord>(o / (data_->vb_.len(1) * data_->vb_.len(2)) + data_->vb_.min_sli()),
      row = static_cast<def::coord>((o % (data_->vb_.len(1) * data_->vb_.len(2))) / data_->vb_.len(2) + data_->vb_.min_row()),
      col = static_cast<def::coord>(o % data_->vb_.len(2) + data_->vb_.min_col());
    point3d p = point3d(sli, row, col);
    mln_postcondition(& this->operator()(p) == this->data_->buffer_ + o);
    return p;
  }

  template <typename T>
  inline
  void
  image3d<T>::resize_(unsigned new_border)
  {
    this->data_->reallocate_(new_border);
  }

# endif // ! MLN_INCLUDE_ONLY

} // end of namespace mln



# include <mln/core/trait/pixter.hh>
# include <mln/core/dpoints_pixter.hh>
# include <mln/core/pixter3d.hh>
# include <mln/core/w_window.hh>


namespace mln
{

  namespace trait
  {

    // pixter

    template <typename T>
    struct fwd_pixter< image3d<T> >
    {
      typedef fwd_pixter3d< image3d<T> > ret;
    };

    template <typename T>
    struct fwd_pixter< const image3d<T> >
    {
      typedef fwd_pixter3d< const image3d<T> > ret;
    };

    template <typename T>
    struct bkd_pixter< image3d<T> >
    {
      typedef bkd_pixter3d< image3d<T> > ret;
    };

    template <typename T>
    struct bkd_pixter< const image3d<T> >
    {
      typedef bkd_pixter3d< const image3d<T> > ret;
    };

    // qixter

    template <typename T, typename W>
    struct fwd_qixter< image3d<T>, W >
    {
      typedef dpoints_fwd_pixter< image3d<T> > ret;
    };

    template <typename T, typename W>
    struct fwd_qixter< const image3d<T>, W >
    {
      typedef dpoints_fwd_pixter< const image3d<T> > ret;
    };

    template <typename T, typename W>
    struct bkd_qixter< image3d<T>, W >
    {
      typedef dpoints_bkd_pixter< image3d<T> > ret;
    };

    template <typename T, typename W>
    struct bkd_qixter< const image3d<T>, W >
    {
      typedef dpoints_bkd_pixter< const image3d<T> > ret;
    };

    // nixter

    template <typename T, typename W>
    struct fwd_nixter< image3d<T>, W >
    {
      typedef dpoints_fwd_pixter< image3d<T> > ret;
    };

    template <typename T, typename W>
    struct fwd_nixter< const image3d<T>, W >
    {
      typedef dpoints_fwd_pixter< const image3d<T> > ret;
    };

    template <typename T, typename W>
    struct bkd_nixter< image3d<T>, W >
    {
      typedef dpoints_bkd_pixter< image3d<T> > ret;
    };

    template <typename T, typename W>
    struct bkd_nixter< const image3d<T>, W >
    {
      typedef dpoints_bkd_pixter< const image3d<T> > ret;
    };

  } // end of namespace mln::trait

} // end of namespace mln


#endif // ! MLN_CORE_IMAGE_IMAGE3D_HH