itkOrderedTraversalStreamlinesFilter.h

Go to the documentation of this file.

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

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

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

#ifndef itkOrderedTraversalStreamlinesFilter_h
#define itkOrderedTraversalStreamlinesFilter_h

#include <itkImage.h>
#include <itkVector.h>
#include "itkBaseCTEStreamlinesFilter.h"
#include <itkVectorInterpolateImageFunction.h>
#include <itkInterpolateImageFunction.h>

#include <queue>

namespace itk {
template <  class TImageType, typename TScalarType=double, unsigned int NDimensions=3 > 
class ITK_EXPORT OrderedTraversalStreamlinesFilter :
  public BaseCTEStreamlinesFilter< TImageType, TScalarType, NDimensions>
{
public:

  typedef OrderedTraversalStreamlinesFilter                               Self;
  typedef BaseCTEStreamlinesFilter<TImageType, TScalarType, NDimensions>  Superclass;
  typedef SmartPointer<Self>                                              Pointer;
  typedef SmartPointer<const Self>                                        ConstPointer;
  
  itkNewMacro(Self);

  itkTypeMacro(OrderedTraversalStreamlinesFilter, BaseStreamlinesFilter);

  itkStaticConstMacro(Dimension, unsigned int, NDimensions);

  typedef Vector< TScalarType, NDimensions >                     InputVectorImagePixelType;
  typedef Image< InputVectorImagePixelType, NDimensions >        InputVectorImageType;
  typedef typename InputVectorImageType::Pointer                 InputVectorImagePointer;
  typedef typename InputVectorImageType::ConstPointer            InputVectorImageConstPointer;
  typedef typename InputVectorImageType::IndexType               InputVectorImageIndexType; 
  typedef TScalarType                                            InputScalarImagePixelType;
  typedef Image< InputScalarImagePixelType, NDimensions >        InputScalarImageType;
  typedef typename InputScalarImageType::PointType               InputScalarImagePointType;
  typedef typename InputScalarImageType::Pointer                 InputScalarImagePointer;
  typedef typename InputScalarImageType::IndexType               InputScalarImageIndexType;
  typedef typename InputScalarImageType::ConstPointer            InputScalarImageConstPointer;
  typedef typename InputScalarImageType::RegionType              InputScalarImageRegionType;
  typedef typename InputScalarImageType::SizeType                InputScalarImageSizeType;
  typedef InputScalarImageType                                   OutputImageType;
  typedef typename OutputImageType::PixelType                    OutputImagePixelType;
  typedef typename OutputImageType::Pointer                      OutputImagePointer;
  typedef typename OutputImageType::ConstPointer                 OutputImageConstPointer;
  typedef typename OutputImageType::IndexType                    OutputImageIndexType;
  typedef typename OutputImageType::SpacingType                  OutputImageSpacingType;
  
  typedef VectorInterpolateImageFunction<InputVectorImageType
                                         ,TScalarType
                                        >                        VectorInterpolatorType;
  typedef typename VectorInterpolatorType::Pointer               VectorInterpolatorPointer;
  typedef typename VectorInterpolatorType::PointType             VectorInterpolatorPointType;
  typedef InterpolateImageFunction< InputScalarImageType
                                    ,TScalarType >               ScalarInterpolatorType;
  typedef typename ScalarInterpolatorType::Pointer               ScalarInterpolatorPointer;
  typedef typename ScalarInterpolatorType::PointType             ScalarInterpolatorPointType;
  typedef Image<unsigned char, Dimension>                        StatusImageType;

  void SetScalarImage(const InputScalarImageType *image) {this->SetNthInput(0, const_cast<InputScalarImageType *>(image)); }

  void SetVectorImage(const InputVectorImageType* image) { this->SetNthInput(1, const_cast<InputVectorImageType *>(image)); }

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

  // The main filter method. Note, single threaded.
  virtual void GenerateData();

  // Typedefs used internally.
  typedef std::pair<TScalarType, InputScalarImageIndexType> Pair;
  typedef std::multimap<TScalarType, InputScalarImageIndexType> MinMap;
  typedef typename MinMap::iterator MinMapIterator;
  typedef typename MinMap::reverse_iterator MinMapReverseIterator;
  
private:
  
  OrderedTraversalStreamlinesFilter(const Self&); 
  void operator=(const Self&); 

  OutputImagePixelType GetLaplacian(const InputScalarImageIndexType& index,
                                    const int& offset,
                                    const typename InputScalarImageType::Pointer& scalarImage);
  OutputImagePixelType Solve(const InputScalarImageIndexType& index, 
                             const int& offset, 
                             const typename InputVectorImageType::Pointer& vectorImage,
                             const typename OutputImageType::Pointer& distanceImage);

  bool IsNextToBoundary(const InputScalarImageIndexType& index, 
                        const typename InputScalarImageType::Pointer& scalarImage,
                        const typename StatusImageType::Pointer& statusImage,
                        const InputScalarImagePixelType& threshold);

  void DoOrderedTraversal(const int& offset,
                          const InputScalarImagePixelType& threshold,
                          const typename InputScalarImageType::Pointer& scalarImage,
                          const typename InputVectorImageType::Pointer& vectorImage,
                          const typename OutputImageType::Pointer& distanceImage);
                          
  // TODO: Sort these out, make them const static.
  unsigned char BOUNDARY;
  unsigned char FIRST_PASS;
  unsigned char UNVISITED;
  unsigned char VISITED;
  unsigned char SOLVED;

};

} // end namespace

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

#endif