itkGPUFiniteDifferenceImageFilter.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 itkGPUFiniteDifferenceImageFilter_h
#define itkGPUFiniteDifferenceImageFilter_h

#include "itkGPUInPlaceImageFilter.h"
#include "itkGPUFiniteDifferenceFunction.h"
#include "itkFiniteDifferenceImageFilter.h"
#include "itkTimeProbe.h"

namespace itk
{
template< typename TInputImage, typename TOutputImage, typename TParentImageFilter =
            FiniteDifferenceImageFilter< TInputImage, TOutputImage > >
class ITK_TEMPLATE_EXPORT GPUFiniteDifferenceImageFilter :
  public GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(GPUFiniteDifferenceImageFilter);

  using Self = GPUFiniteDifferenceImageFilter;
  using GPUSuperclass = GPUInPlaceImageFilter< TInputImage, TOutputImage, TParentImageFilter >;
  using CPUSuperclass = TParentImageFilter;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(GPUFiniteDifferenceImageFilter, GPUInPlaceImageFilter);

  using InputImageType = TInputImage;
  using OutputImageType = TOutputImage;

  static constexpr unsigned int ImageDimension = OutputImageType::ImageDimension;

  using OutputPixelType = typename TOutputImage::PixelType;
  using InputPixelType = typename TInputImage::PixelType;
  using PixelType = OutputPixelType;

  using OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType;
  using InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType;

  using FiniteDifferenceFunctionType = typename GPUFiniteDifferenceFunction< TOutputImage >::DifferenceFunctionType;
  using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType;
  using RadiusType = typename FiniteDifferenceFunctionType::RadiusType;
  using NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType;

  const typename FiniteDifferenceFunctionType::Pointer &GetDifferenceFunction() const override
    {
    return this->m_DifferenceFunction;
    }

  void SetDifferenceFunction ( FiniteDifferenceFunctionType *differenceFunction ) override
    {
    itkDebugMacro("setting m_DifferenceFunction to " << differenceFunction);
    if ( this->m_DifferenceFunction != differenceFunction )
      {
      this->m_DifferenceFunction = differenceFunction;
      this->Modified();
      }
    }

  typedef enum { UNINITIALIZED = 0, INITIALIZED = 1 } FilterStateType;

  void SetStateToInitialized()
  {
    this->SetState(INITIALIZED);
  }

  void SetStateToUninitialized()
  {
    this->SetState(UNINITIALIZED);
  }

#if !defined( ITK_WRAPPING_PARSER )
  itkSetMacro(State, FilterStateType);
  itkGetConstReferenceMacro(State, FilterStateType);
#endif


#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( OutputPixelIsFloatingPointCheck,
                   ( Concept::IsFloatingPoint< OutputPixelValueType > ) );
  // End concept checking
#endif

  itkGetConstReferenceMacro(InitTime,           TimeProbe);
  itkGetConstReferenceMacro(ComputeUpdateTime,  TimeProbe);
  itkGetConstReferenceMacro(ApplyUpdateTime,    TimeProbe);
  itkGetConstReferenceMacro(SmoothFieldTime,    TimeProbe);

protected:
  GPUFiniteDifferenceImageFilter();
  ~GPUFiniteDifferenceImageFilter() override;

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

  void AllocateUpdateBuffer() override = 0;

  virtual void GPUApplyUpdate(const TimeStepType& dt) = 0;

  virtual TimeStepType GPUCalculateChange() = 0;

  void CopyInputToOutput() override = 0;

  void GPUGenerateData() override;

  void GenerateInputRequestedRegion() override;

  bool Halt() override;

  bool ThreadedHalt( void *itkNotUsed(threadInfo) ) override {
    return this->Halt();
  }

  void Initialize() override {
  }

  void InitializeIteration() override
  {
    m_DifferenceFunction->InitializeIteration();
  }

  virtual TimeStepType ResolveTimeStep(const std::vector<TimeStepType >& timeStepList,
                                     const std::vector< bool >& valid) const override;

  void PostProcessOutput()  override {
  }

  //unsigned int m_NumberOfIterations;

  //unsigned int m_ElapsedIterations;

  bool m_ManualReinitialization;

  double m_RMSChange;
  double m_MaximumRMSError;

  TimeProbe m_InitTime, m_ComputeUpdateTime, m_ApplyUpdateTime, m_SmoothFieldTime;

private:

  void InitializeFunctionCoefficients();

  typename FiniteDifferenceFunctionType::Pointer m_DifferenceFunction;

  bool m_UseImageSpacing;

  FilterStateType m_State;
};
} // end namespace itk

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

#endif