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 "itkMultiThreaderBase.h"

namespace itk
{
template< typename TInputImage, typename TOutputImage >
class ITK_TEMPLATE_EXPORT DenseFiniteDifferenceImageFilter:
  public FiniteDifferenceImageFilter< TInputImage, TOutputImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(DenseFiniteDifferenceImageFilter);

  using Self = DenseFiniteDifferenceImageFilter;
  using Superclass = FiniteDifferenceImageFilter<
    TInputImage, TOutputImage >;

  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(DenseFiniteDifferenceImageFilter, ImageToImageFilter);

  using InputImageType = typename Superclass::InputImageType;
  using OutputImageType = typename Superclass::OutputImageType;
  using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using PixelType = typename Superclass::PixelType;

  using TimeStepType = typename Superclass::TimeStepType;

  using UpdateBufferType = OutputImageType;

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin 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 > ) );
  // End concept checking
#endif

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

  void CopyInputToOutput() override;

  void ApplyUpdate(const TimeStepType& dt) override;

  virtual UpdateBufferType * GetUpdateBuffer()
  { return m_UpdateBuffer; }

  TimeStepType CalculateChange() override;

  void AllocateUpdateBuffer() override;

  using ThreadRegionType = typename UpdateBufferType::RegionType;

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

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

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

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ApplyUpdateThreaderCallback(void *arg);

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION CalculateChangeThreaderCallback(void *arg);

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

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

#endif