itkIterativeDeconvolutionImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkIterativeDeconvolutionImageFilter_h
#define __itkIterativeDeconvolutionImageFilter_h

#include "itkFFTConvolutionImageFilter.h"
#include "itkProgressAccumulator.h"

namespace itk
{
template< class TInputImage, class TKernelImage=TInputImage, class TOutputImage=TInputImage >
class ITK_EXPORT IterativeDeconvolutionImageFilter :
    public FFTConvolutionImageFilter< TInputImage, TKernelImage, TOutputImage >
{
public:
  typedef IterativeDeconvolutionImageFilter                      Self;
  typedef FFTConvolutionImageFilter< TInputImage, TOutputImage > Superclass;
  typedef SmartPointer< Self >                                   Pointer;
  typedef SmartPointer< const Self >                             ConstPointer;

  typedef TInputImage                                          InputImageType;
  typedef TKernelImage                                         KernelImageType;
  typedef TOutputImage                                         OutputImageType;

  typedef typename Superclass::InternalImageType               InternalImageType;
  typedef typename Superclass::InternalImagePointerType        InternalImagePointerType;
  typedef typename Superclass::InternalComplexType             InternalComplexType;
  typedef typename Superclass::InternalComplexImageType        InternalComplexImageType;
  typedef typename Superclass::InternalComplexImagePointerType InternalComplexImagePointerType;

  itkTypeMacro(IterativeDeconvolutionImageFilter, ConvolutionImageFilterBase);

  itkSetMacro(NumberOfIterations, unsigned int);
  itkGetMacro(NumberOfIterations, unsigned int);

  itkGetConstObjectMacro(CurrentEstimate, InternalImageType);

  void SetStopIteration(bool stop)
  {
    // Don't call Modified() to avoid triggering a new update.
    m_StopIteration = stop;
  }
  itkGetConstMacro(StopIteration, bool);

  itkGetConstMacro(Iteration, unsigned int);

protected:
  IterativeDeconvolutionImageFilter();
  virtual ~IterativeDeconvolutionImageFilter();

  virtual void Initialize(ProgressAccumulator * progress,
                          float progressWeight,
                          float iterationProgressWeight);

  virtual void Iteration(ProgressAccumulator * itkNotUsed(progress),
                         float itkNotUsed(iterationProgressWeight)) = 0;

  virtual void Finish(ProgressAccumulator * progress,
                      float progressWeight);

  virtual void GenerateInputRequestedRegion();

  virtual void GenerateData();

  InternalComplexImagePointerType m_TransferFunction;

  InternalImagePointerType m_CurrentEstimate;

  typedef typename Superclass::FFTFilterType  FFTFilterType;
  typedef typename Superclass::IFFTFilterType IFFTFilterType;

  virtual void PrintSelf(std::ostream & os, Indent indent) const;

private:
  IterativeDeconvolutionImageFilter(const Self &); // purposely not implemented
  void operator=(const Self &);                    // purposely not implemented

  unsigned int m_NumberOfIterations;

  unsigned int m_Iteration;

  bool m_StopIteration;

  unsigned long m_InputMTime;
  unsigned long m_KernelMTime;

};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkIterativeDeconvolutionImageFilter.hxx"
#endif

#endif