itkCurvatureFlowFunction.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 itkCurvatureFlowFunction_h
#define itkCurvatureFlowFunction_h

#include "itkFiniteDifferenceFunction.h"
#include "itkMacro.h"

namespace itk
{
template< typename TImage >
class ITK_TEMPLATE_EXPORT CurvatureFlowFunction:
  public FiniteDifferenceFunction< TImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(CurvatureFlowFunction);

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

  itkNewMacro(Self);

  itkTypeMacro(CurvatureFlowFunction,
               FiniteDifferenceFunction);

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

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  TimeStepType ComputeGlobalTimeStep(void *GlobalData) const override;

  void * GetGlobalDataPointer() const override
  {
    auto * ans = new GlobalDataStruct();

    ans->m_MaxChange   = NumericTraits< ScalarValueType >::ZeroValue();
    return ans;
  }

  void ReleaseGlobalDataPointer(void *GlobalData) const override
  { delete (GlobalDataStruct *)GlobalData; }

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

  const TimeStepType & GetTimeStep() const
  { return m_TimeStep; }

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

protected:

  struct GlobalDataStruct {
    GlobalDataStruct()
    {
      m_MaxChange = NumericTraits< ScalarValueType >::ZeroValue();
    }

    ~GlobalDataStruct() = default;

    ScalarValueType m_MaxChange;
  };

  CurvatureFlowFunction();
  ~CurvatureFlowFunction() override = default;

private:
  TimeStepType m_TimeStep;
};
} // end namespace itk

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

#endif