itkAnisotropicDiffusionFunction.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 itkAnisotropicDiffusionFunction_h
#define itkAnisotropicDiffusionFunction_h
 
#include "itkFiniteDifferenceFunction.h"
 
namespace itk
{
template <typename TImage>
class ITK_TEMPLATE_EXPORT AnisotropicDiffusionFunction : public FiniteDifferenceFunction<TImage>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(AnisotropicDiffusionFunction);

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

  itkOverrideGetNameOfClassMacro(AnisotropicDiffusionFunction);

  using typename Superclass::ImageType;
  using typename Superclass::PixelType;
  using PixelrealType = typename Superclass::PixelRealType;
  using typename Superclass::RadiusType;
  using typename Superclass::NeighborhoodType;
  using typename Superclass::TimeStepType;
  using typename Superclass::FloatOffsetType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  virtual void
  CalculateAverageGradientMagnitudeSquared(ImageType *) = 0;

  void
  SetTimeStep(const TimeStepType & t)
  {
    m_TimeStep = t;
  }
 
  const TimeStepType &
  GetTimeStep() const
  {
    return m_TimeStep;
  }

  void
  SetConductanceParameter(const double c)
  {
    m_ConductanceParameter = c;
  }
 
  const double &
  GetConductanceParameter() const
  {
    return m_ConductanceParameter;
  }

  const double &
  GetAverageGradientMagnitudeSquared() const
  {
    return m_AverageGradientMagnitudeSquared;
  }
 
  void
  SetAverageGradientMagnitudeSquared(const double c)
  {
    m_AverageGradientMagnitudeSquared = c;
  }

  TimeStepType
  ComputeGlobalTimeStep(void * itkNotUsed(GlobalData)) const override
  {
    return this->GetTimeStep();
  }

  void *
  GetGlobalDataPointer() const override
  {
    return nullptr;
  }

  void
  ReleaseGlobalDataPointer(void * itkNotUsed(GlobalData)) const override
  {
    /* do nothing */
  }
 
protected:
  AnisotropicDiffusionFunction()
  {
    m_AverageGradientMagnitudeSquared = 0.0;
    m_ConductanceParameter = 1.0; // default value
    m_TimeStep = 0.125f;          // default value
  }
 
  ~AnisotropicDiffusionFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
    os << indent << "TimeStep: " << m_TimeStep << std::endl;
    os << indent << "ConductanceParameter: " << m_ConductanceParameter << std::endl;
  }
 
private:
  double       m_AverageGradientMagnitudeSquared{};
  double       m_ConductanceParameter{};
  TimeStepType m_TimeStep{};
};
} // end namespace itk
 
#endif