itkDenseFiniteDifferenceImageFilter.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 __itkDenseFiniteDifferenceImageFilter_h
#define __itkDenseFiniteDifferenceImageFilter_h

#include "itkFiniteDifferenceImageFilter.h"
#include "itkMultiThreader.h"

namespace itk
{
template< class TInputImage, class TOutputImage >
class ITK_EXPORT DenseFiniteDifferenceImageFilter:
  public FiniteDifferenceImageFilter< TInputImage, TOutputImage >
{
public:

  typedef DenseFiniteDifferenceImageFilter Self;
  typedef FiniteDifferenceImageFilter<
    TInputImage, TOutputImage >                 Superclass;

  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(DenseFiniteDifferenceImageFilter, ImageToImageFilter);

  typedef typename Superclass::InputImageType  InputImageType;
  typedef typename Superclass::OutputImageType OutputImageType;
  typedef typename Superclass::FiniteDifferenceFunctionType
  FiniteDifferenceFunctionType;

  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);

  typedef typename Superclass::PixelType PixelType;

  typedef typename Superclass::TimeStepType TimeStepType;

  typedef OutputImageType UpdateBufferType;

#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( OutputTimesDoubleCheck,
                   ( Concept::MultiplyOperator< PixelType, double > ) );
  itkConceptMacro( OutputAdditiveOperatorsCheck,
                   ( Concept::AdditiveOperators< PixelType > ) );
  itkConceptMacro( OutputAdditiveAndAssignOperatorsCheck,
                   ( Concept::AdditiveAndAssignOperators< PixelType > ) );
  itkConceptMacro( InputConvertibleToOutputCheck,
                   ( Concept::Convertible< typename TInputImage::PixelType, PixelType > ) );

#endif
protected:
  DenseFiniteDifferenceImageFilter()
  { m_UpdateBuffer = UpdateBufferType::New(); }
  ~DenseFiniteDifferenceImageFilter() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual void CopyInputToOutput();

  virtual void ApplyUpdate(const TimeStepType& dt);

  virtual UpdateBufferType * GetUpdateBuffer()
  { return m_UpdateBuffer; }

  virtual TimeStepType CalculateChange();

  virtual void AllocateUpdateBuffer();

  typedef typename UpdateBufferType::RegionType ThreadRegionType;

  virtual
  void ThreadedApplyUpdate(const TimeStepType& dt,
                           const ThreadRegionType & regionToProcess,
                           ThreadIdType threadId);

  virtual
  TimeStepType ThreadedCalculateChange(const ThreadRegionType & regionToProcess,
                                       ThreadIdType threadId);

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

  struct DenseFDThreadStruct {
    DenseFiniteDifferenceImageFilter *Filter;
    TimeStepType TimeStep;
    std::vector< TimeStepType > TimeStepList;
    std::vector< bool > ValidTimeStepList;
  };

  static ITK_THREAD_RETURN_TYPE ApplyUpdateThreaderCallback(void *arg);

  static ITK_THREAD_RETURN_TYPE CalculateChangeThreaderCallback(void *arg);

  typename UpdateBufferType::Pointer m_UpdateBuffer;
};
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_DenseFiniteDifferenceImageFilter(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                                    \
  {                                                                                \
  _( 2 ( class EXPORT DenseFiniteDifferenceImageFilter< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                                              \
  {                                                                                \
  typedef DenseFiniteDifferenceImageFilter< ITK_TEMPLATE_2 TypeX >                 \
  DenseFiniteDifferenceImageFilter##TypeY;                                       \
  }                                                                                \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkDenseFiniteDifferenceImageFilter+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkDenseFiniteDifferenceImageFilter.hxx"
#endif

#endif