itkFiniteDifferenceFunction.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 itkFiniteDifferenceFunction_h
#define itkFiniteDifferenceFunction_h
 
#include "itkLightObject.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkVector.h"
 
namespace itk
{
template <typename TImageType>
class ITK_TEMPLATE_EXPORT FiniteDifferenceFunction : public LightObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FiniteDifferenceFunction);

  using Self = FiniteDifferenceFunction;
  using Superclass = LightObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(FiniteDifferenceFunction);

  using ImageType = TImageType;
  using PixelType = typename ImageType::PixelType;
  using PixelRealType = double;

  static constexpr unsigned int ImageDimension = ImageType::ImageDimension;

  using TimeStepType = double;

  using DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<ImageType>;

  using RadiusType = typename ConstNeighborhoodIterator<TImageType>::RadiusType;

  using NeighborhoodType = ConstNeighborhoodIterator<TImageType, DefaultBoundaryConditionType>;

  using NeighborhoodScalesType = Vector<PixelRealType, Self::ImageDimension>;

  using FloatOffsetType = Vector<float, Self::ImageDimension>;

  virtual void
  InitializeIteration()
  {}

  virtual PixelType
  ComputeUpdate(const NeighborhoodType & neighborhood,
                void *                   globalData,
                const FloatOffsetType &  offset = FloatOffsetType(0.0)) = 0;
 

  void
  SetRadius(const RadiusType & r);

  const RadiusType &
  GetRadius() const;

  void
  SetScaleCoefficients(const PixelRealType vals[ImageDimension]);

  void
  GetScaleCoefficients(PixelRealType vals[ImageDimension]) const;

  const NeighborhoodScalesType
  ComputeNeighborhoodScales() const;

  virtual TimeStepType
  ComputeGlobalTimeStep(void * GlobalData) const = 0;

  virtual void *
  GetGlobalDataPointer() const = 0;

  virtual void
  ReleaseGlobalDataPointer(void * GlobalData) const = 0;
 
protected:
  FiniteDifferenceFunction();
  ~FiniteDifferenceFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  RadiusType    m_Radius{};
  PixelRealType m_ScaleCoefficients[ImageDimension]{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFiniteDifferenceFunction.hxx"
#endif
 
#endif