itkLaplacianSolverImageFilter.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 itkLaplacianSolverImageFilter_h
#define itkLaplacianSolverImageFilter_h

#include <itkImage.h>
#include "itkBaseCTEFilter.h"


namespace itk
{
template <class TInputImage, typename TScalarType=double>
class ITK_EXPORT LaplacianSolverImageFilter : 
    public BaseCTEFilter< TInputImage >
{
public:
  typedef LaplacianSolverImageFilter   Self;
  typedef BaseCTEFilter< TInputImage > Superclass;
  typedef SmartPointer<Self>           Pointer;
  typedef SmartPointer<const Self>     ConstPointer;

  itkTypeMacro(LaplacianSolverImageFilter, BaseCTEFilter);
  
  itkNewMacro(Self);

  typedef typename TInputImage::PixelType                     InputPixelType;
  typedef InputPixelType                                      OutputPixelType;
  
  typedef TInputImage                                         InputImageType;
  typedef typename InputImageType::Pointer                    InputImagePointer;
  typedef typename InputImageType::IndexType                  InputImageIndexType;
  typedef Image<OutputPixelType, TInputImage::ImageDimension> OutputImageType;
  typedef typename OutputImageType::Pointer                   OutputImagePointer;
  typedef typename OutputImageType::SpacingType               OutputImageSpacing;

  void SetSegmentedImage(const InputImageType *image) {this->SetNthInput(0, const_cast<InputImageType *>(image)); }
  
  itkGetMacro(CurrentIteration, unsigned long int);
  itkSetMacro(CurrentIteration, unsigned long int);
  
  itkSetMacro(LowVoltage, OutputPixelType);
  itkGetMacro(LowVoltage, OutputPixelType);

  itkSetMacro(HighVoltage, OutputPixelType);
  itkGetMacro(HighVoltage, OutputPixelType);

  itkSetMacro(EpsilonConvergenceThreshold, OutputPixelType);
  itkGetMacro(EpsilonConvergenceThreshold, OutputPixelType);

  itkSetMacro(MaximumNumberOfIterations, unsigned long int );
  itkGetMacro(MaximumNumberOfIterations, unsigned long int );

  itkSetMacro(UseGaussSeidel, bool);
  itkGetMacro(UseGaussSeidel, bool);
  
protected:
  LaplacianSolverImageFilter();
  virtual ~LaplacianSolverImageFilter()  {}

  virtual void PrintSelf(std::ostream&, Indent) const;

  // The main filter method. Note, single threaded.
  virtual void GenerateData();
  
private:
  LaplacianSolverImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  
  OutputPixelType m_LowVoltage;
  
  OutputPixelType m_HighVoltage;
  
  OutputPixelType m_EpsilonConvergenceThreshold;
 
  unsigned long int m_MaximumNumberOfIterations;
  
  unsigned long int m_CurrentIteration;
  
  bool m_UseGaussSeidel;
  
};
  
} // end namespace itk

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

#endif