itkFiniteDifferenceImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkFiniteDifferenceImageFilter_h
#define itkFiniteDifferenceImageFilter_h
 
#include "itkBooleanStdVector.h"
#include "itkInPlaceImageFilter.h"
#include "itkFiniteDifferenceFunction.h"
 
namespace itk
{
template <typename TInputImage, typename TOutputImage>
class ITK_TEMPLATE_EXPORT FiniteDifferenceImageFilter : public InPlaceImageFilter<TInputImage, TOutputImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FiniteDifferenceImageFilter);

  using Self = FiniteDifferenceImageFilter;
  using Superclass = InPlaceImageFilter<TInputImage, TOutputImage>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(FiniteDifferenceImageFilter);

  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 = FiniteDifferenceFunction<TOutputImage>;
  using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType;
 
  using RadiusType = typename FiniteDifferenceFunctionType::RadiusType;
  using NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType;

  itkGetConstReferenceMacro(ElapsedIterations, IdentifierType);

  itkGetConstReferenceObjectMacro(DifferenceFunction, FiniteDifferenceFunctionType);

  itkSetObjectMacro(DifferenceFunction, FiniteDifferenceFunctionType);

  itkSetMacro(NumberOfIterations, IdentifierType);
  itkGetConstReferenceMacro(NumberOfIterations, IdentifierType);

  itkSetMacro(UseImageSpacing, bool);
  itkBooleanMacro(UseImageSpacing);
  itkGetConstReferenceMacro(UseImageSpacing, bool);

  itkSetMacro(MaximumRMSError, double);
  itkGetConstReferenceMacro(MaximumRMSError, double);

  itkSetMacro(RMSChange, double);
  itkGetConstReferenceMacro(RMSChange, double);

  itkSetMacro(ManualReinitialization, bool);
  itkGetConstReferenceMacro(ManualReinitialization, bool);
  itkBooleanMacro(ManualReinitialization);
 
  itkSetMacro(IsInitialized, bool);
  itkGetMacro(IsInitialized, bool);
 
  void
  SetStateToUninitialized()
  {
    this->SetIsInitialized(false);
  }
  void
  SetStateToInitialized()
  {
    this->SetIsInitialized(true);
  }
 
  itkConceptMacro(OutputPixelIsFloatingPointCheck, (Concept::IsFloatingPoint<OutputPixelValueType>));
 
protected:
  FiniteDifferenceImageFilter();
  ~FiniteDifferenceImageFilter() override = default;

  bool m_IsInitialized{};
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  virtual void
  AllocateUpdateBuffer() = 0;

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

  virtual TimeStepType
  CalculateChange() = 0;

  virtual void
  CopyInputToOutput() = 0;

  void
  GenerateData() override;

  void
  GenerateInputRequestedRegion() override;

  virtual bool
  Halt();

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

  virtual void
  Initialize()
  {}

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

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

  itkSetMacro(ElapsedIterations, IdentifierType);

  virtual void
  PostProcessOutput()
  {}

  IdentifierType m_NumberOfIterations{};

  IdentifierType m_ElapsedIterations{};

  bool m_ManualReinitialization{};
 
  double m_RMSChange{};
  double m_MaximumRMSError{};
 
private:
  void
  InitializeFunctionCoefficients();

  bool m_UseImageSpacing{ true };

  typename FiniteDifferenceFunctionType::Pointer m_DifferenceFunction{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFiniteDifferenceImageFilter.hxx"
#endif
 
#endif