itkAddUpdateToTimeVaryingVelocityFieldFilter.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 itkAddUpdateToTimeVaryingVelocityFieldFilter_h
#define itkAddUpdateToTimeVaryingVelocityFieldFilter_h

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

namespace itk {

template < typename TScalarType, unsigned int NDimensions = 3>
class ITK_EXPORT AddUpdateToTimeVaryingVelocityFieldFilter :
public InPlaceImageFilter<
                           Image< Vector<TScalarType, NDimensions>,  NDimensions + 1>, // Input image is time varying velocity field.
                           Image< Vector<TScalarType, NDimensions>,  NDimensions + 1>  // Output image is time varying velocity field.
                         >
{

public:

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

    itkNewMacro(Self);

    itkTypeMacro(AddUpdateToTimeVaryingVelocityFieldFilter, ImageToImageFilter);

    itkStaticConstMacro(Dimension, unsigned int, NDimensions);

    typedef Vector< TScalarType, NDimensions >                                            TimeVaryingVelocityPixelType;
    typedef Image< TimeVaryingVelocityPixelType, NDimensions + 1 >                        TimeVaryingVelocityImageType;
    typedef typename TimeVaryingVelocityImageType::RegionType                             TimeVaryingVelocityRegionType;
    typedef typename TimeVaryingVelocityImageType::IndexType                              TimeVaryingVelocityIndexType;
    typedef typename TimeVaryingVelocityImageType::SizeType                               TimeVaryingVelocitySizeType;
    typedef typename TimeVaryingVelocityImageType::PointType                              TimeVaryingVelocityPointType;
    typedef typename TimeVaryingVelocityImageType::SpacingType                            TimeVaryingVelocitySpacingType;
    typedef typename TimeVaryingVelocityImageType::DirectionType                          TimeVaryingVelocityDirectionType;

    typedef Vector< TScalarType, NDimensions >                                            UpdatePixelType;
    typedef Image< UpdatePixelType, NDimensions>                                          UpdateImageType;
    typedef typename UpdateImageType::Pointer                                             UpdateImagePointer;
    typedef typename UpdateImageType::RegionType                                          UpdateImageRegionType;
    typedef typename UpdateImageType::IndexType                                           UpdateImageIndexType;
    typedef typename UpdateImageType::SizeType                                            UpdateImageSizeType;
    typedef typename UpdateImageType::PointType                                           UpdateImagePointType;
    typedef typename UpdateImageType::SpacingType                                         UpdateImageSpacingType;
    typedef typename UpdateImageType::DirectionType                                       UpdateImageDirectionType;

    itkSetMacro(TimePoint, float);
    itkGetMacro(TimePoint, float);

    itkSetMacro(ScaleFactor, float);
    itkGetMacro(ScaleFactor, float);

    itkSetMacro(OverWrite, bool);
    itkGetMacro(OverWrite, bool);

    void SetUpdateImage(UpdateImageType* i) { m_UpdateImage = i; }

    void SetUpdateInverseImage(UpdateImageType *i) { m_UpdateInverseImage = i; }

    itkGetMacro(MaxDeformation, float);

protected:

    AddUpdateToTimeVaryingVelocityFieldFilter();
    ~AddUpdateToTimeVaryingVelocityFieldFilter() {};
    void PrintSelf(std::ostream& os, Indent indent) const;

    // Called before threaded bit.
    virtual void BeforeThreadedGenerateData();

    // Called after threaded bit.
    virtual void AfterThreadedGenerateData();

    // The main method to implement in derived classes, note, its threaded.
    virtual void ThreadedGenerateData(const TimeVaryingVelocityRegionType &regionForThread, ThreadIdType threadId);

private:

    bool m_OverWrite;

    float m_TimePoint;

    float m_ScaleFactor;

    float m_MaxDeformation;

    UpdateImagePointer m_UpdateImage;

    UpdateImagePointer m_UpdateInverseImage;

}; // end class

} // end namespace

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

#endif