itkSmoothVectorFieldFilter.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 itkSmoothVectorFieldFilter_h
#define itkSmoothVectorFieldFilter_h
#include <itkImage.h>
#include <itkVector.h>
#include <itkInPlaceImageFilter.h>
#include <itkNeighborhoodOperator.h>
#include <itkVectorNeighborhoodOperatorImageFilter.h>

namespace itk {
template <
  class TScalarType,                      // Data type for the vectors
  unsigned int NumberImageDimensions = 3, // Number of image dimensions
  unsigned int NumberVectorDimensions = NumberImageDimensions>   // Number of dimensions in the vectors
class ITK_EXPORT SmoothVectorFieldFilter :
  public InPlaceImageFilter<Image< Vector<TScalarType, NumberVectorDimensions>,  NumberImageDimensions>, // Input image
                            Image< Vector<TScalarType, NumberVectorDimensions>,  NumberImageDimensions>  // Output image
                           >
{
public:

  typedef SmoothVectorFieldFilter                             Self;
  typedef ImageToImageFilter<
                             Image<
                               Vector<
                                 TScalarType,
                                 NumberVectorDimensions>,
                               NumberImageDimensions>,
                             Image<
                               Vector<
                                 TScalarType,
                                 NumberVectorDimensions>,
                             NumberImageDimensions>
                            >                                 Superclass;
  typedef SmartPointer<Self>                                  Pointer;
  typedef SmartPointer<const Self>                            ConstPointer;
  
  itkTypeMacro(SmoothVectorFieldFilter, ImageToImageFilter);

  itkStaticConstMacro(ImageDimensions, unsigned int, NumberImageDimensions);

  itkStaticConstMacro(VectorDimensions, unsigned int, NumberVectorDimensions);

  typedef TScalarType                                                                 OutputDataType;
  typedef Vector< OutputDataType, NumberVectorDimensions >                            OutputPixelType;
  typedef Image< OutputPixelType, NumberImageDimensions >                             OutputImageType;
  typedef typename OutputImageType::Pointer                                           OutputImagePointer;
  typedef typename Superclass::InputImageType                                         InputImageType;
  typedef typename InputImageType::Pointer                                            InputImagePointer;
  typedef typename Superclass::InputImageRegionType                                   RegionType;
  typedef NeighborhoodOperator<TScalarType,  NumberImageDimensions>                   NeighborhoodOperatorType;
  typedef VectorNeighborhoodOperatorImageFilter<InputImageType, OutputImageType>      SmootherFilterType;
  typedef typename SmootherFilterType::Pointer                                        SmootherFilterPointer;

  void WriteVectorImage(std::string filename);

protected:

  SmoothVectorFieldFilter();
  ~SmoothVectorFieldFilter() {};
  
  virtual void GenerateInputRequestedRegion() throw(InvalidRequestedRegionError);

  virtual void EnlargeOutputRequestedRegion(DataObject *output);

  virtual void GenerateData();

  virtual NeighborhoodOperatorType* CreateOperator(int dimension) = 0;

private:
  
  SmoothVectorFieldFilter(const Self&); 
  void operator=(const Self&); 

};

} // end namespace.

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

#endif