itkScaleVectorFieldFilter.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 itkScaleVectorFieldFilter_h
#define itkScaleVectorFieldFilter_h

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


namespace itk {
template <
    class TScalarType = double,          // Data type for scalars
    unsigned int NDimensions = 3>        // Number of Dimensions i.e. 2D or 3D
class ITK_EXPORT ScaleVectorFieldFilter :
  public ImageToImageFilter< Image< Vector<TScalarType, NDimensions>,  NDimensions>, // Input image
                             Image< Vector<TScalarType, NDimensions>,  NDimensions>  // Output image
                           >
{
public:

  typedef ScaleVectorFieldFilter                                                        Self;
  typedef ImageToImageFilter< Image< Vector<TScalarType, NDimensions>,  NDimensions>,
                              Image< Vector<TScalarType, NDimensions>,  NDimensions>
                            >                                                           Superclass;
  typedef SmartPointer<Self>                                                            Pointer;
  typedef SmartPointer<const Self>                                                      ConstPointer;
  
  itkNewMacro(Self);

  itkTypeMacro(ScaleVectorFieldFilter, ImageToImageFilter);

  itkStaticConstMacro(Dimension, unsigned int, NDimensions);

  typedef Vector< TScalarType, itkGetStaticConstMacro(Dimension) >                    OutputPixelType;
  typedef Image< OutputPixelType, itkGetStaticConstMacro(Dimension) >                 OutputImageType;
  typedef typename Superclass::InputImageType                                         InputImageType;
  typedef typename Superclass::InputImagePointer                                      InputImagePointer;
  typedef typename Superclass::InputImageRegionType                                   InputImageRegionType;
  typedef typename InputImageType::PixelType                                          InputImagePixelType;
  
  virtual void SetImageThatWillBeScaled(const InputImageType *image) { this->SetNthInput(0, image); }

  virtual void SetImageThatDeterminesTheAmountOfScaling(const InputImageType *image) { this->SetNthInput(1, image); }

  virtual void SetNthInput(unsigned int idx, const InputImageType *);
  
  itkSetMacro(ScaleByComponents, bool);
  itkGetMacro(ScaleByComponents, bool);

  void WriteVectorImage(std::string filename);
  
protected:
  ScaleVectorFieldFilter();
  ~ScaleVectorFieldFilter() {};
  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);
  
  bool m_ScaleByComponents;
  
private:
  
  ScaleVectorFieldFilter(const Self&); 
  void operator=(const Self&); 

};

} // end namespace

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

#endif