itkLewisGriffinRecursiveGaussianImageFilter.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 itkLewisGriffinRecursiveGaussianImageFilter_h
#define itkLewisGriffinRecursiveGaussianImageFilter_h

#include <itkImageToImageFilter.h>
#include <itkNumericTraits.h>

namespace itk
{
  
template <typename TInputImage, typename TOutputImage=TInputImage>
class ITK_EXPORT LewisGriffinRecursiveGaussianImageFilter :
    public ImageToImageFilter<TInputImage,TOutputImage> 
{
public:
  typedef LewisGriffinRecursiveGaussianImageFilter       Self;
  typedef ImageToImageFilter<TInputImage,TOutputImage>   Superclass;
  typedef SmartPointer<Self>                             Pointer;
  typedef SmartPointer<const Self>                       ConstPointer;

  itkNewMacro(Self);
  
  itkTypeMacro( LewisGriffinRecursiveGaussianImageFilter, ImageToImageFilter );

  itkStaticConstMacro(ImageDimension, unsigned int, TInputImage::ImageDimension);

  typedef typename TInputImage::Pointer       InputImagePointer;
  typedef typename TInputImage::ConstPointer  InputImageConstPointer;

  typedef typename TInputImage::PixelType                        InputPixelType;
  typedef typename NumericTraits<InputPixelType>::RealType       RealType;
  typedef typename NumericTraits<InputPixelType>::ScalarRealType ScalarRealType;

  typedef typename TOutputImage::RegionType                      OutputImageRegionType;

  typedef TInputImage      InputImageType;

  typedef TOutputImage      OutputImageType;

  itkGetConstMacro(Direction, unsigned int);

  itkSetMacro(Direction, unsigned int);

  void SetInputImage( const TInputImage * );
    
  const TInputImage * GetInputImage( void );

  typedef unsigned char                                      MaskPixelType;
  typedef typename itk::Image<MaskPixelType, ImageDimension> MaskImageType;
  typedef typename MaskImageType::Pointer                    MaskImagePointer;

  itkSetObjectMacro( Mask, MaskImageType );


  itkGetConstMacro( Sigma, ScalarRealType );
  itkSetMacro( Sigma, ScalarRealType );

  typedef  enum { ZeroOrder, FirstOrder, SecondOrder } OrderEnumType;
 
  itkSetMacro( Order, OrderEnumType );
  itkGetConstMacro( Order, OrderEnumType );

  void SetZeroOrder();

  void SetFirstOrder();

  void SetSecondOrder();

  void SetSingleThreadedExecution(void) {m_FlagMultiThreadedExecution = false;}

protected:
  LewisGriffinRecursiveGaussianImageFilter();
  virtual ~LewisGriffinRecursiveGaussianImageFilter();

  LewisGriffinRecursiveGaussianImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

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

  struct LewisGriffinRecursiveGaussianImageFilterStruct
  {
    LewisGriffinRecursiveGaussianImageFilter *Filter;
  };

  bool m_FlagMultiThreadedExecution;

  void BeforeThreadedGenerateData();
  void GenerateData(void);
  void ThreadedGenerateData(const OutputImageRegionType& outputRegionForThread, ThreadIdType threadId );

  int SplitRequestedRegion(int i, int num, OutputImageRegionType& splitRegion);

  void EnlargeOutputRequestedRegion(DataObject *output);

  virtual void SetUp(ScalarRealType spacing);

  void FilterDataArray(RealType *outs, RealType *data, int ln);

  RealType GaussianZeroOrder(RealType x, RealType sigma);
  RealType GaussianFirstOrder(RealType x, RealType sigma);
  RealType GaussianSecondOrder(RealType x, RealType sigma);

  unsigned int m_Direction;

  ScalarRealType m_Sigma;

  OrderEnumType m_Order;

  RealType *m_Kernel;

  unsigned int m_KernelSize;

  MaskImagePointer m_Mask;
};


} // end namespace itk

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


#endif