itkFastMarchingImageFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkFastMarchingImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2008-12-21 19:13:11 $
  Version:   $Revision: 1.39 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkFastMarchingImageFilter_h
#define __itkFastMarchingImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkLevelSet.h"
#include "itkIndex.h"
#include "vnl/vnl_math.h"

#include <functional>
#include <queue>

namespace itk
{

template <
  class TLevelSet, 
  class TSpeedImage = Image<float,::itk::GetImageDimension<TLevelSet>::ImageDimension> >
class ITK_EXPORT FastMarchingImageFilter :
    public ImageToImageFilter<TSpeedImage,TLevelSet>
{
public:
  typedef FastMarchingImageFilter   Self;
  typedef ImageSource<TLevelSet>    Superclass;
  typedef SmartPointer<Self>        Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(FastMarchingImageFilter, ImageSource);

  typedef LevelSetTypeDefault<TLevelSet>              LevelSetType;
  typedef typename LevelSetType::LevelSetImageType    LevelSetImageType;
  typedef typename LevelSetType::LevelSetPointer      LevelSetPointer;
  typedef typename LevelSetType::PixelType            PixelType;
  typedef typename LevelSetType::NodeType             NodeType;
  typedef typename LevelSetType::NodeContainer        NodeContainer;
  typedef typename LevelSetType::NodeContainerPointer NodeContainerPointer;
  typedef typename LevelSetImageType::SizeType        OutputSizeType;
  typedef typename LevelSetImageType::RegionType      OutputRegionType;
  typedef typename LevelSetImageType::SpacingType     OutputSpacingType;
  typedef typename LevelSetImageType::DirectionType   OutputDirectionType;
  typedef typename LevelSetImageType::PointType       OutputPointType;

  class AxisNodeType : public NodeType
    {
    public:
      int GetAxis() const { return m_Axis; }
      void SetAxis( int axis ) { m_Axis = axis; }
      const AxisNodeType & operator=(const NodeType & node)
      { this->NodeType::operator=(node); return *this; }
    private:
      int m_Axis;
  };

  typedef TSpeedImage SpeedImageType;

  typedef typename SpeedImageType::Pointer        SpeedImagePointer;
  typedef typename SpeedImageType::ConstPointer   SpeedImageConstPointer;

  itkStaticConstMacro(SetDimension, unsigned int,
                      LevelSetType::SetDimension);
  itkStaticConstMacro(SpeedImageDimension, unsigned int,
                      SpeedImageType::ImageDimension);

  typedef Index<itkGetStaticConstMacro(SetDimension)> IndexType;

  enum LabelType { FarPoint, AlivePoint, TrialPoint };

  typedef Image<unsigned char, itkGetStaticConstMacro(SetDimension)> LabelImageType;

  typedef typename LabelImageType::Pointer LabelImagePointer;

  void SetAlivePoints( NodeContainer * points )
    { 
    m_AlivePoints = points; 
    this->Modified(); 
    }

  NodeContainerPointer GetAlivePoints( )
    {
    return m_AlivePoints;
    }

  void SetTrialPoints( NodeContainer * points )
    { 
    m_TrialPoints = points;
    this->Modified();
    }

  NodeContainerPointer GetTrialPoints( )
    {
    return m_TrialPoints;
    }

  LabelImagePointer GetLabelImage() const
    {
    return m_LabelImage;
    }

  void SetSpeedConstant( double value )
    {
    m_SpeedConstant = value;
    m_InverseSpeed = -1.0 * vnl_math_sqr( 1.0 / m_SpeedConstant );
    this->Modified();
    }

  itkGetConstReferenceMacro( SpeedConstant, double );

  itkSetMacro( NormalizationFactor, double );
  itkGetMacro( NormalizationFactor, double );

  itkSetMacro( StoppingValue, double );

  itkGetConstReferenceMacro( StoppingValue, double );

  itkSetMacro( CollectPoints, bool );

  itkGetConstReferenceMacro( CollectPoints, bool );
  itkBooleanMacro( CollectPoints );

  NodeContainerPointer GetProcessedPoints() const
    {
    return m_ProcessedPoints;
    }

  virtual void SetOutputSize( const OutputSizeType& size )
  { m_OutputRegion = size; }
  virtual OutputSizeType GetOutputSize() const
  { return m_OutputRegion.GetSize(); }
  itkSetMacro( OutputRegion, OutputRegionType );
  itkGetConstReferenceMacro( OutputRegion, OutputRegionType );
  itkSetMacro( OutputSpacing, OutputSpacingType );
  itkGetConstReferenceMacro( OutputSpacing, OutputSpacingType );
  itkSetMacro( OutputDirection, OutputDirectionType );
  itkGetConstReferenceMacro( OutputDirection, OutputDirectionType );
  itkSetMacro( OutputOrigin, OutputPointType );
  itkGetConstReferenceMacro( OutputOrigin, OutputPointType );
  itkSetMacro( OverrideOutputInformation, bool );
  itkGetConstReferenceMacro( OverrideOutputInformation, bool );
  itkBooleanMacro( OverrideOutputInformation );

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro(SameDimensionCheck,
    (Concept::SameDimension<SetDimension, SpeedImageDimension>));
  itkConceptMacro(SpeedConvertibleToDoubleCheck,
    (Concept::Convertible<typename TSpeedImage::PixelType, double>));
  itkConceptMacro(DoubleConvertibleToLevelSetCheck,
    (Concept::Convertible<double, PixelType>));
  itkConceptMacro(LevelSetOStreamWritableCheck,
    (Concept::OStreamWritable<PixelType>));

#endif

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

  virtual void Initialize( LevelSetImageType * );
  virtual void UpdateNeighbors( const IndexType& index, 
                                const SpeedImageType *, LevelSetImageType * );
  virtual double UpdateValue( const IndexType& index, 
                              const SpeedImageType *, LevelSetImageType * );


  const AxisNodeType& GetNodeUsedInCalculation(unsigned int idx) const
  { return m_NodesUsed[idx]; }

  void GenerateData();

  virtual void GenerateOutputInformation();
  virtual void EnlargeOutputRequestedRegion(DataObject *output);

  itkGetConstReferenceMacro( LargeValue, PixelType );

  OutputRegionType                              m_BufferedRegion;
  typedef typename LevelSetImageType::IndexType LevelSetIndexType;
  LevelSetIndexType                             m_StartIndex;
  LevelSetIndexType                             m_LastIndex;

  itkGetConstReferenceMacro( StartIndex, LevelSetIndexType );
  itkGetConstReferenceMacro( LastIndex, LevelSetIndexType );

private:
  FastMarchingImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  NodeContainerPointer                          m_AlivePoints;
  NodeContainerPointer                          m_TrialPoints;

  LabelImagePointer                             m_LabelImage;
  
  double                                        m_SpeedConstant;
  double                                        m_InverseSpeed;
  double                                        m_StoppingValue;
    
  bool                                          m_CollectPoints;
  NodeContainerPointer                          m_ProcessedPoints;

  OutputRegionType                              m_OutputRegion;
  OutputPointType                               m_OutputOrigin;
  OutputSpacingType                             m_OutputSpacing;
  OutputDirectionType                           m_OutputDirection;
  bool                                          m_OverrideOutputInformation;


  typename LevelSetImageType::PixelType         m_LargeValue;
  AxisNodeType                                  m_NodesUsed[SetDimension];

  typedef std::vector<AxisNodeType>  HeapContainer;
  typedef std::greater<AxisNodeType> NodeComparer;
  typedef std::priority_queue< AxisNodeType, HeapContainer, NodeComparer >
                                     HeapType;

  HeapType    m_TrialHeap;

  double    m_NormalizationFactor;
};

} // namespace itk


#ifndef ITK_MANUAL_INSTANTIATION
#include "itkFastMarchingImageFilter.txx"
#endif

#endif