itkVectorVPlusLambdaUImageFilter.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 itkVectorVPlusLambdaUImageFilter_h
#define itkVectorVPlusLambdaUImageFilter_h

#include <itkVector.h>
#include <itkImage.h>
#include <itkImageToImageFilter.h>

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

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

    typedef Vector< TScalarType, NDimensions >                                          InputPixelType;
    typedef Image< InputPixelType, NDimensions >                                        InputImageType;
    typedef typename InputImageType::IndexType                                          InputImageIndexType;
    typedef typename InputImageType::RegionType                                         InputImageRegionType;
    typedef InputPixelType                                                              OutputPixelType;
    typedef InputImageType                                                              OutputImageType;

    itkNewMacro(Self);

    itkTypeMacro(VectorVPlusLambdaUImageFilter, ImageToImageFilter);

    itkStaticConstMacro(Dimension, unsigned int, NDimensions);

    itkSetMacro(Lambda, double);
    itkGetMacro(Lambda, double);

    itkSetMacro(IgnoreInputV, bool);
    itkGetMacro(IgnoreInputV, bool);
    
    itkSetMacro(SubtractSteps, bool);
    itkGetMacro(SubtractSteps, bool);

  protected:
    VectorVPlusLambdaUImageFilter();
    ~VectorVPlusLambdaUImageFilter() {};
    void PrintSelf(std::ostream& os, Indent indent) const;
    
    // Check before we start.
    virtual void BeforeThreadedGenerateData();
    
    // The main method to implement in derived classes, note, its threaded.
    virtual void ThreadedGenerateData( const InputImageRegionType &outputRegionForThread, ThreadIdType threadId);
    
  private:
    
    VectorVPlusLambdaUImageFilter(const Self&); 
    void operator=(const Self&); 

    bool m_IgnoreInputV;
    
    bool m_SubtractSteps;

    double m_Lambda;
    
}; // end class

} // end namespace

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

#endif