DigitalSurfaceConvolver.h

 
#pragma once
 
#if defined(DigitalSurfaceConvolver_RECURSES)
#error Recursive header files inclusion detected in DigitalSurfaceConvolver.h
#else // defined(DigitalSurfaceConvolver_RECURSES)
#define DigitalSurfaceConvolver_RECURSES
 
#if !defined DigitalSurfaceConvolver_h
#define DigitalSurfaceConvolver_h
 
// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/PointVector.h"
#include "DGtal/math/linalg/SimpleMatrix.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/base/Alias.h"
#include "DGtal/base/Clone.h"
#include "DGtal/topology/CCellFunctor.h"
#include "DGtal/topology/CanonicSCellEmbedder.h"
#include "DGtal/topology/SCellsFunctors.h"
 
namespace DGtal
{
 
// template class DigitalSurfaceConvolver
template< typename TFunctor, typename TKernelFunctor, typename TKSpace, typename TDigitalKernel, Dimension dimension = TKSpace::dimension >
class DigitalSurfaceConvolver
{
public:
 
  typedef TFunctor Functor;
  typedef TKSpace KSpace;
  typedef TKernelFunctor KernelFunctor;
  typedef TDigitalKernel DigitalKernel;
 
  typedef Z2i::Domain Domain;
 
  typedef double Quantity;
  typedef PointVector< dimension, Quantity > VectorQuantity;
  typedef SimpleMatrix< Quantity, dimension, dimension > MatrixQuantity;
  typedef SimpleMatrix< double, dimension, dimension > CovarianceMatrix;
 
  typedef typename KSpace::SCell Spel;
  typedef typename KSpace::Point Point;
  typedef typename KSpace::Space::RealPoint RealPoint;
  typedef Z2i::DigitalSet::ConstIterator KernelConstIterator;
 
  typedef std::pair< KernelConstIterator, KernelConstIterator > PairIterators;
  typedef CanonicSCellEmbedder< KSpace > Embedder;
 
  BOOST_CONCEPT_ASSERT (( concepts::CCellFunctor< Functor > ));
  BOOST_CONCEPT_ASSERT (( concepts::CCellFunctor< KernelFunctor > ));
 
  // ----------------------- Standard services ------------------------------
 
public:
 
  DigitalSurfaceConvolver ( ConstAlias< Functor > f, ConstAlias< KernelFunctor > g, ConstAlias< KSpace > space );
 
  DigitalSurfaceConvolver ( const DigitalSurfaceConvolver & other );
 
 
  ~DigitalSurfaceConvolver () {}
 
  // ----------------------- Interface --------------------------------------
 
public:
 
  void init ( const Point & pOrigin,
              ConstAlias< PairIterators > fullKernel,
              ConstAlias< std::vector< PairIterators > > masks );
 
  void init ( const Point & pOrigin,
              ConstAlias< DigitalKernel > fullKernel,
              ConstAlias< std::vector< PairIterators > > masks );
 
  template< typename SurfelIterator >
  Quantity eval ( const SurfelIterator & it ) const;
 
 
  template< typename SurfelIterator, typename EvalFunctor >
  typename EvalFunctor::Value eval ( const SurfelIterator & it,
                                     EvalFunctor functor ) const;
 
 
  template< typename SurfelIterator, typename OutputIterator >
  void eval ( const SurfelIterator & itbegin,
              const SurfelIterator & itend,
              OutputIterator & result ) const;
 
  template< typename SurfelIterator, typename OutputIterator, typename EvalFunctor >
  void eval ( const SurfelIterator & itbegin,
              const SurfelIterator & itend,
              OutputIterator & result,
              EvalFunctor functor ) const;
 
 
  template< typename SurfelIterator >
  CovarianceMatrix evalCovarianceMatrix ( const SurfelIterator & it ) const;
 
  template< typename SurfelIterator, typename EvalFunctor >
  typename EvalFunctor::Value evalCovarianceMatrix ( const SurfelIterator & it,
                                                     EvalFunctor functor ) const;
 
  template< typename SurfelIterator, typename OutputIterator >
  void evalCovarianceMatrix ( const SurfelIterator & itbegin,
                              const SurfelIterator & itend,
                              OutputIterator & result ) const;
 
  template< typename SurfelIterator, typename OutputIterator, typename EvalFunctor >
  void evalCovarianceMatrix ( const SurfelIterator & itbegin,
                              const SurfelIterator & itend,
                              OutputIterator & result,
                              EvalFunctor functor ) const;
 
 
  bool isValid () const;
 
protected:
 
  void computeCovarianceMatrix( const Quantity * aMomentMatrix, CovarianceMatrix & aCovarianceMatrix ) const;
 
  void fillMoments( Quantity* aMomentMatrix, const Spel & aSpel, double direction ) const;
 
#ifdef _MSC_VER
  // For Visual Studio, to be defined as a static const, it has to be intialized into the header file
  static const int nbMoments = 6; 
#else
  static const int nbMoments; 
#endif //_MSC_VER
  static Spel defaultInnerSpel; 
  static Spel defaultOuterSpel; 
  static Quantity defaultInnerMoments[ 6 ]; 
  static Quantity defaultOuterMoments[ 6 ]; 
  static Quantity defaultInnerSum; 
  static Quantity defaultOuterSum; 
 
  template< typename SurfelIterator >
  bool core_eval ( const SurfelIterator & it,
                   Quantity & innerSum,
                   Quantity & outerSum,
                   bool useLastResults = false,
                   Spel & lastInnerSpel = defaultInnerSpel,
                   Spel & lastOuterSpel = defaultOuterSpel,
                   Quantity & lastInnerSum = defaultInnerSum,
                   Quantity & lastOuterSum = defaultOuterSum ) const;
 
  template< typename SurfelIterator >
  bool core_evalCovarianceMatrix ( const SurfelIterator & it,
                                   CovarianceMatrix & innerMatrix,
                                   CovarianceMatrix & outerMatrix,
                                   bool useLastResults = false,
                                   Spel & lastInnerSpel = defaultInnerSpel,
                                   Spel & lastOuterSpel = defaultOuterSpel,
                                   Quantity * lastInnerMoments = defaultInnerMoments,
                                   Quantity * lastOuterMoments = defaultOuterMoments ) const;
 
 
 
  // ------------------------- Private Datas --------------------------------
 
private:
 
  const Functor & myFFunctor; 
 
  const KernelFunctor & myGFunctor; 
 
 
  const KSpace & myKSpace; 
 
  Embedder myEmbedder; 
 
  bool isInitFullMasks; 
 
  bool isInitKernelAndMasks; 
 
  const std::vector< PairIterators > * myMasks; 
 
  const DigitalKernel * myKernel; 
  const PairIterators * myKernelMask; 
 
  Spel myKernelSpelOrigin; 
 
  // ------------------------- Hidden services ------------------------------
 
protected:
  DigitalSurfaceConvolver ();
 
private:
 
  DigitalSurfaceConvolver & operator= ( const DigitalSurfaceConvolver & other );
 
  // ------------------------- Internals ------------------------------------
 
private:
 
}; // end of class DigitalSurfaceConvolver
 
template< typename TFunctor, typename TKernelFunctor, typename TKSpace, typename TDigitalKernel >
class DigitalSurfaceConvolver< TFunctor, TKernelFunctor, TKSpace, TDigitalKernel, 2 >
{
  // ----------------------- Types ------------------------------------------
 
public:
 
  typedef TFunctor Functor;
  typedef TKSpace KSpace;
  typedef TKernelFunctor KernelFunctor;
  typedef TDigitalKernel DigitalKernel;
 
  typedef Z2i::Domain Domain;
 
  typedef double Quantity;
  typedef PointVector< 2, Quantity > VectorQuantity;
  typedef SimpleMatrix< Quantity, 2, 2 > MatrixQuantity;
  typedef SimpleMatrix< double, 2, 2 > CovarianceMatrix;
 
  typedef typename KSpace::SCell Spel;
  typedef typename KSpace::Point Point;
  typedef typename KSpace::Space::RealPoint RealPoint;
  typedef Z2i::DigitalSet::ConstIterator KernelConstIterator;
 
  typedef std::pair< KernelConstIterator, KernelConstIterator > PairIterators;
  typedef CanonicSCellEmbedder< KSpace > Embedder;
 
  BOOST_CONCEPT_ASSERT (( concepts::CCellFunctor< Functor > ));
  BOOST_CONCEPT_ASSERT (( concepts::CCellFunctor< KernelFunctor > ));
 
  // ----------------------- Standard services ------------------------------
 
public:
 
  DigitalSurfaceConvolver ( ConstAlias< Functor > f, ConstAlias< KernelFunctor > g, ConstAlias< KSpace > space );
 
  DigitalSurfaceConvolver ( const DigitalSurfaceConvolver & other );
 
  ~DigitalSurfaceConvolver () {}
 
  // ----------------------- Interface --------------------------------------
 
public:
 
  void init ( const Point & pOrigin,
              ConstAlias< PairIterators > fullKernel,
              ConstAlias< std::vector< PairIterators > > masks );
 
  void init ( const Point & pOrigin,
              ConstAlias< DigitalKernel > fullKernel,
              ConstAlias< std::vector< PairIterators > > masks );
 
  template< typename SurfelIterator >
  Quantity eval ( const SurfelIterator & it ) const;
 
 
  template< typename SurfelIterator, typename EvalFunctor >
  typename EvalFunctor::Value eval ( const SurfelIterator & it,
                                     EvalFunctor functor ) const;
 
 
  template< typename SurfelIterator, typename OutputIterator >
  void eval ( const SurfelIterator & itbegin,
              const SurfelIterator & itend,
              OutputIterator & result ) const;
 
  template< typename SurfelIterator, typename OutputIterator, typename EvalFunctor >
  void eval ( const SurfelIterator & itbegin,
              const SurfelIterator & itend,
              OutputIterator & result,
              EvalFunctor functor ) const;
 
 
  template< typename SurfelIterator >
  CovarianceMatrix evalCovarianceMatrix ( const SurfelIterator & it ) const;
 
  template< typename SurfelIterator, typename EvalFunctor >
  typename EvalFunctor::Value evalCovarianceMatrix ( const SurfelIterator & it,
                                                     EvalFunctor functor ) const;
 
  template< typename SurfelIterator, typename OutputIterator >
  void evalCovarianceMatrix ( const SurfelIterator & itbegin,
                              const SurfelIterator & itend,
                              OutputIterator & result ) const;
 
  template< typename SurfelIterator, typename OutputIterator, typename EvalFunctor >
  void evalCovarianceMatrix ( const SurfelIterator & itbegin,
                              const SurfelIterator & itend,
                              OutputIterator & result,
                              EvalFunctor functor ) const;
 
 
  bool isValid () const;
 
protected:
 
  void computeCovarianceMatrix( const Quantity * aMomentMatrix, CovarianceMatrix & aCovarianceMatrix ) const;
 
  void fillMoments( Quantity* aMomentMatrix, const Spel & aSpel, double direction ) const;
 
#ifdef _MSC_VER
  // For Visual Studio, to be defined as a static const, it has to be intialized into the header file
  static const int nbMoments = 6; 
#else
  static const int nbMoments; 
#endif //_MSC_VER
  static Spel defaultInnerSpel; 
  static Spel defaultOuterSpel; 
  static Quantity defaultInnerMoments[ 6 ]; 
  static Quantity defaultOuterMoments[ 6 ]; 
  static Quantity defaultInnerSum; 
  static Quantity defaultOuterSum; 
 
  template< typename SurfelIterator >
  bool core_eval ( const SurfelIterator & it,
                   Quantity & innerSum,
                   Quantity & outerSum,
                   bool useLastResults = false,
                   Spel & lastInnerSpel = defaultInnerSpel,
                   Spel & lastOuterSpel = defaultOuterSpel,
                   Quantity & lastInnerSum = defaultInnerSum,
                   Quantity & lastOuterSum = defaultOuterSum ) const;
 
  template< typename SurfelIterator >
  bool core_evalCovarianceMatrix ( const SurfelIterator & it,
                                   CovarianceMatrix & innerMatrix,
                                   CovarianceMatrix & outerMatrix,
                                   bool useLastResults = false,
                                   Spel & lastInnerSpel = defaultInnerSpel,
                                   Spel & lastOuterSpel = defaultOuterSpel,
                                   Quantity * lastInnerMoments = defaultInnerMoments,
                                   Quantity * lastOuterMoments = defaultOuterMoments ) const;
 
 
 
  // ------------------------- Private Datas --------------------------------
 
private:
 
  const Dimension dimension; 
 
  const Functor & myFFunctor; 
 
  const KernelFunctor & myGFunctor; 
 
 
  const KSpace & myKSpace; 
 
  Embedder myEmbedder; 
 
  bool isInitFullMasks; 
 
  bool isInitKernelAndMasks; 
 
  const std::vector< PairIterators > * myMasks; 
 
  const DigitalKernel * myKernel; 
  const PairIterators * myKernelMask; 
 
  Spel myKernelSpelOrigin; 
 
  // ------------------------- Hidden services ------------------------------
 
protected:
  DigitalSurfaceConvolver ();
 
private:
 
  DigitalSurfaceConvolver & operator= ( const DigitalSurfaceConvolver & other );
 
  // ------------------------- Internals ------------------------------------
 
private:
 
}; // end of class DigitalSurfaceConvolver
 
template< typename TFunctor, typename TKernelFunctor, typename TKSpace, typename TDigitalKernel >
class DigitalSurfaceConvolver< TFunctor, TKernelFunctor, TKSpace, TDigitalKernel, 3 >
{
  // ----------------------- Types ------------------------------------------
 
public:
 
  typedef TFunctor Functor;
  typedef TKSpace KSpace;
  typedef TKernelFunctor KernelFunctor;
  typedef TDigitalKernel DigitalKernel;
 
  typedef Z3i::Domain Domain;
 
  typedef double Quantity;
  typedef PointVector< 3, Quantity > VectorQuantity;
  typedef SimpleMatrix< Quantity, 3, 3 > MatrixQuantity;
  typedef SimpleMatrix< double, 3, 3 > CovarianceMatrix;
 
  typedef typename KSpace::SCell Spel;
  typedef typename KSpace::Point Point;
  typedef typename KSpace::Space::RealPoint RealPoint;
  typedef Z3i::DigitalSet::ConstIterator KernelConstIterator;
 
 
  typedef std::pair< KernelConstIterator, KernelConstIterator > PairIterators;
  typedef CanonicSCellEmbedder< KSpace > Embedder;
 
  BOOST_CONCEPT_ASSERT (( concepts::CCellFunctor< Functor > ));
  BOOST_CONCEPT_ASSERT (( concepts::CCellFunctor< KernelFunctor > ));
 
  // ----------------------- Standard services ------------------------------
 
public:
 
  DigitalSurfaceConvolver ( ConstAlias< Functor > f,
                            ConstAlias< KernelFunctor > g,
                            ConstAlias< KSpace > space );
 
  DigitalSurfaceConvolver ( const DigitalSurfaceConvolver & other );
 
  ~DigitalSurfaceConvolver() {}
 
  // ----------------------- Interface --------------------------------------
 
public:
 
  void init ( const Point & pOrigin,
              ConstAlias< PairIterators > fullKernel,
              ConstAlias< std::vector< PairIterators > > masks );
 
  void init ( const Point & pOrigin,
              ConstAlias< DigitalKernel > fullKernel,
              ConstAlias< std::vector< PairIterators > > masks );
 
  template< typename SurfelIterator >
  Quantity eval ( const SurfelIterator & it ) const;
 
 
  template< typename SurfelIterator, typename EvalFunctor >
  typename EvalFunctor::Value eval ( const SurfelIterator & it,
                                     EvalFunctor functor ) const;
 
 
  template< typename SurfelIterator, typename OutputIterator >
  void eval ( const SurfelIterator & itbegin,
              const SurfelIterator & itend,
              OutputIterator & result ) const;
 
  template< typename SurfelIterator, typename OutputIterator, typename EvalFunctor >
  void eval ( const SurfelIterator & itbegin,
              const SurfelIterator & itend,
              OutputIterator & result,
              EvalFunctor functor ) const;
 
 
  template< typename SurfelIterator >
  CovarianceMatrix evalCovarianceMatrix ( const SurfelIterator & it ) const;
 
  template< typename SurfelIterator, typename EvalFunctor >
  typename EvalFunctor::Value evalCovarianceMatrix ( const SurfelIterator & it,
                                                     EvalFunctor functor ) const;
 
  template< typename SurfelIterator, typename OutputIterator >
  void evalCovarianceMatrix ( const SurfelIterator & itbegin,
                              const SurfelIterator & itend,
                              OutputIterator & result ) const;
 
  template< typename SurfelIterator, typename OutputIterator, typename EvalFunctor >
  void evalCovarianceMatrix ( const SurfelIterator & itbegin,
                              const SurfelIterator & itend,
                              OutputIterator & result,
                              EvalFunctor functor ) const;
 
  bool isValid() const;
 
protected:
 
  void computeCovarianceMatrix ( const Quantity * aMomentMatrix, CovarianceMatrix & aCovarianceMatrix ) const;
 
  void fillMoments ( Quantity * aMomentMatrix, const Spel & aSpel, double direction ) const;
 
#ifdef _MSC_VER
  // For Visual Studio, to be defined as a static const, it has to be intialized into the header file
  static const int nbMoments = 10; 
#else
  static const int nbMoments; 
#endif //_MSC_VER
  static Spel defaultInnerSpel; 
  static Spel defaultOuterSpel; 
  static Quantity defaultInnerMoments[ 10 ]; 
  static Quantity defaultOuterMoments[ 10 ]; 
  static Quantity defaultInnerSum; 
  static Quantity defaultOuterSum; 
 
  template< typename SurfelIterator >
  bool core_eval ( const SurfelIterator & it,
                   Quantity & innerSum,
                   Quantity & outerSum,
                   bool useLastResults = false,
                   Spel & lastInnerSpel = defaultInnerSpel,
                   Spel & lastOuterSpel = defaultOuterSpel,
                   Quantity & lastInnerSum = defaultInnerSum,
                   Quantity & lastOuterSum = defaultOuterSum ) const;
 
  template< typename SurfelIterator >
  bool core_evalCovarianceMatrix ( const SurfelIterator & it,
                                   CovarianceMatrix & innerMatrix,
                                   CovarianceMatrix & outerMatrix,
                                   bool useLastResults = false,
                                   Spel & lastInnerSpel = defaultInnerSpel,
                                   Spel & lastOuterSpel = defaultOuterSpel,
                                   Quantity * lastInnerMoments = defaultInnerMoments,
                                   Quantity * lastOuterMoments = defaultOuterMoments ) const;
 
 
  // ------------------------- Private Datas --------------------------------
 
private:
 
  const Dimension dimension; 
 
  const Functor & myFFunctor; 
 
  const KernelFunctor & myGFunctor; 
 
 
  const KSpace & myKSpace; 
 
  Embedder myEmbedder; 
 
  bool isInitFullMasks; 
 
  bool isInitKernelAndMasks; 
 
  const std::vector< PairIterators > * myMasks; 
 
  const DigitalKernel * myKernel; 
  const PairIterators * myKernelMask; 
 
  Spel myKernelSpelOrigin; 
 
  // ------------------------- Hidden services ------------------------------
 
protected:
  DigitalSurfaceConvolver ();
 
private:
 
  DigitalSurfaceConvolver & operator= ( const DigitalSurfaceConvolver & other );
 
  // ------------------------- Internals ------------------------------------
 
private:
 
}; // end of class DigitalSurfaceConvolver
 
 
 
template< typename TF,  typename TKF, typename TKS, typename TDK, Dimension dimension >
std::ostream&
operator<< ( std::ostream & out, const DGtal::DigitalSurfaceConvolver< TF, TKF, TKS, TDK, dimension > & object );
 
template< typename TF,  typename TKF, typename TKS, typename TDK >
std::ostream&
operator<< ( std::ostream & out, const DGtal::DigitalSurfaceConvolver< TF, TKF, TKS, TDK, 2 > & object );
 
template< typename TF,  typename TKF, typename TKS, typename TDK >
std::ostream&
operator<< ( std::ostream & out, const DGtal::DigitalSurfaceConvolver<TF, TKF, TKS, TDK, 3 > & object );
 
 
} // namespace DGtal
 
 
// Includes inline functions.
#include "DGtal/geometry/surfaces/DigitalSurfaceConvolver.ih"
 
 
//                                                                           //
 
#endif // !defined DigitalSurfaceConvolver_h
 
#undef DigitalSurfaceConvolver_RECURSES
#endif // else defined(DigitalSurfaceConvolver_RECURSES)