itkDasGradientFilter.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 itkDasGradientFilter_h
#define itkDasGradientFilter_h

#include <itkVector.h>
#include <itkImage.h>
#include <itkImageToImageFilter.h>
#include <itkLinearInterpolateImageFunction.h>
#include <itkVectorLinearInterpolateImageFunction.h>
#include <itkImageFileWriter.h>
#include "itkDasTransformImageFilter.h"

namespace itk {
template < typename TScalarType, unsigned int NDimensions = 3>
class ITK_EXPORT DasGradientFilter : 
public ImageToImageFilter<
                           Image< TScalarType, NDimensions>,                      // Input image
                           Image< Vector<TScalarType, NDimensions>,  NDimensions> // Output image
                         >
{
  public:

    typedef DasGradientFilter                                                Self;
    typedef ImageToImageFilter<
                               Image< TScalarType, 
                                      NDimensions>,
                               Image< Vector<TScalarType, NDimensions>,  
                                      NDimensions>  
                              >                                              Superclass;
    typedef SmartPointer<Self>                                               Pointer;
    typedef SmartPointer<const Self>                                         ConstPointer;

    typedef Image< TScalarType, NDimensions >                                InputImageType;
    typedef typename InputImageType::IndexType                               InputImageIndexType;
    typedef typename InputImageType::RegionType                              InputImageRegionType;
    typedef Vector< TScalarType, NDimensions >                               VectorPixelType;
    typedef Image< VectorPixelType, NDimensions >                            VectorImageType;
    typedef VectorPixelType                                                  OutputPixelType;
    typedef VectorImageType                                                  OutputImageType;
    typedef VectorLinearInterpolateImageFunction <VectorImageType, 
                                                     TScalarType >           VectorInterpolatorType;
    typedef LinearInterpolateImageFunction< InputImageType, TScalarType >    LinearInterpolatorType;
    typedef ScalarImageToNormalizedGradientVectorImageFilter<InputImageType, 
                                                             TScalarType>    GradientFilterType;
    typedef DasTransformImageFilter<TScalarType, NDimensions>                TransformImageFilterType;
    
    itkNewMacro(Self);

    itkTypeMacro(DasGradientFilter, ImageToImageFilter);

    itkStaticConstMacro(Dimension, unsigned int, NDimensions);

    void SetTransformation(VectorImageType* image) { m_PhiTransformation = image; }
    
    itkSetMacro(ReverseGradient, bool);
    itkGetMacro(ReverseGradient, bool);

    itkSetMacro(UseGradientTransformedMovingImage, bool);
    itkGetMacro(UseGradientTransformedMovingImage, bool);
    
  protected:
    DasGradientFilter();
    ~DasGradientFilter() {};
    void PrintSelf(std::ostream& os, Indent indent) const;
    
    // Before we start multi-threaded section.
    virtual void BeforeThreadedGenerateData();

    // The main method to implement in derived classes, note, its threaded.
    virtual void ThreadedGenerateData( const InputImageRegionType &outputRegionForThread, ThreadIdType threadId);
    
  private:
    
    DasGradientFilter(const Self&); 
    void operator=(const Self&); 

    typename VectorImageType::Pointer m_PhiTransformation;

    typename LinearInterpolatorType::Pointer m_ThicknessInterpolator;

    typename LinearInterpolatorType::Pointer m_WhiteMatterInterpolator;

    typename VectorInterpolatorType::Pointer m_GradientInterpolator;

    typename GradientFilterType::Pointer m_GradientFilter;
    
    typename TransformImageFilterType::Pointer m_TransformImageFilter;
    
    bool m_ReverseGradient;

    bool m_UseGradientTransformedMovingImage;
    
    bool m_GradientFilterInitialized;

}; // end class

} // end namespace

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

#endif