itkCuberilleImageToMeshFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkCuberilleImageToMeshFilter_h
#define itkCuberilleImageToMeshFilter_h

#define DEBUG_PRINT 0
#define USE_GRADIENT_RECURSIVE_GAUSSIAN 0
#define USE_ADVANCED_PROJECTION 0
#define USE_LINESEARCH_PROJECTION 0

#include "itkMacro.h"
#include "itkMesh.h"
#include "itkImageToMeshFilter.h"
#include "itkCellInterface.h"
#include "itkTriangleCell.h"
#include "itkQuadrilateralCell.h"
#include "itkDefaultStaticMeshTraits.h"
#include "itkConstShapedNeighborhoodIterator.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkGradientImageFilter.h"
#include "itkGradientRecursiveGaussianImageFilter.h"
#include "itkVectorLinearInterpolateImageFunction.h"

namespace itk
{

template < class TInputImage, class TOutputMesh, class TInterpolator=itk::LinearInterpolateImageFunction<TInputImage> >
class CuberilleImageToMeshFilter : public ImageToMeshFilter< TInputImage, TOutputMesh >
{
public:
  typedef CuberilleImageToMeshFilter                    Self;
  typedef ImageToMeshFilter< TInputImage, TOutputMesh > Superclass;
  typedef SmartPointer<Self>                            Pointer;
  typedef SmartPointer<const Self>                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(CuberilleImageToMeshFilter, ImageToMeshFilter);

  typedef TOutputMesh                                     OutputMeshType;
  typedef typename OutputMeshType::Pointer                OutputMeshPointer;
  typedef typename OutputMeshType::MeshTraits             OutputMeshTraits;
  typedef typename OutputMeshType::PointType              OutputPointType;
  typedef typename OutputMeshTraits::PixelType            OutputPixelType;
  typedef typename OutputMeshType::CellTraits             CellTraits;
  typedef typename OutputMeshType::PointsContainerPointer PointsContainerPointer;
  typedef typename OutputMeshType::PointsContainer        PointsContainer;
  typedef typename OutputMeshType::CellsContainerPointer  CellsContainerPointer;
  typedef typename OutputMeshType::CellsContainer         CellsContainer;
  typedef typename OutputMeshType::PointIdentifier        PointIdentifier;
  typedef typename OutputMeshType::CellIdentifier         CellIdentifier;
  typedef CellInterface<OutputPixelType, CellTraits>      CellInterfaceType;
  typedef TriangleCell<CellInterfaceType>                 TriangleCellType;
  typedef typename TriangleCellType::SelfAutoPointer      TriangleAutoPointer;
  typedef typename TriangleCellType::CellAutoPointer      TriangleCellAutoPointer;
  typedef QuadrilateralCell<CellInterfaceType>            QuadrilateralCellType;
  typedef typename QuadrilateralCellType::SelfAutoPointer QuadrilateralAutoPointer;
  typedef typename QuadrilateralCellType::CellAutoPointer QuadrilateralCellAutoPointer;

  typedef TInputImage                               InputImageType;
  typedef typename InputImageType::Pointer          InputImagePointer;
  typedef typename InputImageType::ConstPointer     InputImageConstPointer;
  typedef typename InputImageType::PixelType        InputPixelType;
  typedef typename InputImageType::SizeType         SizeType;
  typedef typename InputImageType::SpacingType      SpacingType;
  typedef typename InputImageType::SpacingValueType SpacingValueType;
  typedef typename InputImageType::IndexType        IndexType;
  typedef typename OutputMeshType::PointType        PointType;

  typedef TInterpolator                         InterpolatorType;
  typedef typename InterpolatorType::Pointer    InterpolatorPointer;
  typedef typename InterpolatorType::OutputType InterpolatorOutputType;

  typedef ConstShapedNeighborhoodIterator< InputImageType >              InputImageIteratorType;
#if USE_GRADIENT_RECURSIVE_GAUSSIAN
  typedef GradientRecursiveGaussianImageFilter< InputImageType >         GradientFilterType;
#else
  typedef GradientImageFilter< InputImageType >                          GradientFilterType;
#endif
  typedef typename GradientFilterType::Pointer                           GradientFilterPointer;
  typedef typename GradientFilterType::OutputImageType                   GradientImageType;
  typedef typename GradientImageType::Pointer                            GradientImagePointer;
  typedef typename GradientFilterType::OutputPixelType                   GradientPixelType;
  typedef itk::VectorLinearInterpolateImageFunction< GradientImageType > GradientInterpolatorType;
  typedef typename GradientInterpolatorType::Pointer                     GradientInterpolatorPointer;

  itkGetMacro( IsoSurfaceValue, InputPixelType );
  itkSetMacro( IsoSurfaceValue, InputPixelType );

  using Superclass::SetInput;
  virtual void SetInput( const InputImageType * inputImage );

  itkGetObjectMacro( Interpolator, InterpolatorType );
  itkSetObjectMacro( Interpolator, InterpolatorType );

  itkGetMacro( GenerateTriangleFaces, bool );
  itkSetMacro( GenerateTriangleFaces, bool );
  itkBooleanMacro( GenerateTriangleFaces );

  itkGetMacro( ProjectVerticesToIsoSurface, bool );
  itkSetMacro( ProjectVerticesToIsoSurface, bool );
  itkBooleanMacro( ProjectVerticesToIsoSurface );

  itkGetMacro( ProjectVertexSurfaceDistanceThreshold, double );
  itkSetClampMacro( ProjectVertexSurfaceDistanceThreshold, double, 0.0, NumericTraits<InputPixelType>::max() );

  itkGetMacro( ProjectVertexStepLength, double );
  itkSetClampMacro( ProjectVertexStepLength, double, 0.0, 100000.0 );

  itkGetMacro( ProjectVertexStepLengthRelaxationFactor, double );
  itkSetClampMacro( ProjectVertexStepLengthRelaxationFactor, double, 0.0, 1.0 );

  itkGetMacro( ProjectVertexMaximumNumberOfSteps, unsigned int );
  itkSetMacro( ProjectVertexMaximumNumberOfSteps, unsigned int );

protected:
  CuberilleImageToMeshFilter();
  ~CuberilleImageToMeshFilter();
  void PrintSelf(std::ostream& os, Indent indent) const;

  void GenerateData();
  virtual void GenerateOutputInformation(){ }; // do nothing

private:
  CuberilleImageToMeshFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  class VertexLookupNode
    {
    public:
      typedef VertexLookupNode Self;

      VertexLookupNode() : m_X( 0 ), m_Y( 0 ) { }
      VertexLookupNode(unsigned long x, unsigned long y) : m_X( x ), m_Y( y ) { }

      unsigned long GetX() { return m_X; }
      unsigned long GetY() { return m_Y; }

      bool operator> ( const Self& node ) const
        { return (m_Y > node.m_Y) || ( (m_Y == node.m_Y) && (m_X > node.m_X) ); }
      bool operator>= ( const Self& node ) const
        { return (m_Y >= node.m_Y) || ( (m_Y == node.m_Y) && (m_X >= node.m_X) ); }
      bool operator< ( const Self& node ) const
        { return (m_Y < node.m_Y) || ( (m_Y == node.m_Y) && (m_X < node.m_X) ); }
      bool operator<= ( const Self& node ) const
        { return (m_Y <= node.m_Y) || ( (m_Y == node.m_Y) && (m_X <= node.m_X) ); }

    private:
      unsigned long m_X;
      unsigned long m_Y;
  };

  template< class TMeshType >
  class VertexLookupMap
    {
    public:
      typedef VertexLookupMap                               Self;
      typedef typename TMeshType::PointIdentifier           PointIdentifier;
      typedef std::map< VertexLookupNode, PointIdentifier > MapType;

      VertexLookupMap() { }

      void Clear() { m_Map.clear(); }

      void AddVertex( unsigned int x, unsigned int y, PointIdentifier id )
        {
          VertexLookupNode node( x, y );
          m_Map.insert( typename MapType::value_type(node, id) );
        }

      bool GetVertex( unsigned int x, unsigned int y, PointIdentifier &id )
        {
        bool result = false;
        VertexLookupNode node( x, y );
        typename MapType::iterator it = m_Map.find( node );
        if ( it != m_Map.end() )
          {
          result = true;
          id = it->second;
          }
        return result;
        }

    private:
      MapType m_Map;
  };

  typedef VertexLookupMap< OutputMeshType > VertexLookupMapType;

  inline void ComputeGradientImage();
  inline void SetVerticesFromFace( unsigned int face, bool *vertexHasQuad );
  inline IndexType GetVertexLookupIndex( unsigned int vertex, IndexType index );
  inline void ProjectVertexToIsoSurface( PointType &vertex );
  inline void AddVertex( PointIdentifier &id, IndexType index, const InputImageType* image, OutputMeshType* mesh );
  inline void AddQuadFace( CellIdentifier &id, PointIdentifier f[4], OutputMeshType* mesh );

  InputPixelType              m_IsoSurfaceValue;
  InterpolatorPointer         m_Interpolator;
  GradientInterpolatorPointer m_GradientInterpolator;
  SpacingValueType            m_MaxSpacing;
  bool                        m_GenerateTriangleFaces;
  bool                        m_ProjectVerticesToIsoSurface;
  double                      m_ProjectVertexSurfaceDistanceThreshold;
  double                      m_ProjectVertexStepLength;
  double                      m_ProjectVertexStepLengthRelaxationFactor;
  unsigned int                m_ProjectVertexMaximumNumberOfSteps;
#if DEBUG_PRINT
  unsigned int m_ProjectVertexTerminate[3];
#endif
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkCuberilleImageToMeshFilter.hxx"
#endif

#endif