itkCurvatureFlowImageFilter.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 itkCurvatureFlowImageFilter_h
#define itkCurvatureFlowImageFilter_h

#include "itkDenseFiniteDifferenceImageFilter.h"
#include "itkCurvatureFlowFunction.h"

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

  using Self = CurvatureFlowImageFilter;
  using Superclass = DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(CurvatureFlowImageFilter,
               DenseFiniteDifferenceImageFilter);

  using InputImageType = typename Superclass::InputImageType;

  using OutputImageType = typename Superclass::OutputImageType;
  using OutputImagePointer = typename OutputImageType::Pointer;

  using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType;

  using CurvatureFlowFunctionType = CurvatureFlowFunction<OutputImageType>;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using PixelType = typename Superclass::PixelType;

  using TimeStepType = typename Superclass::TimeStepType;

  itkSetMacro(TimeStep, TimeStepType);

  itkGetConstMacro(TimeStep, TimeStepType);

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( DoubleConvertibleToOutputCheck,
                   ( Concept::Convertible< double, PixelType > ) );
  itkConceptMacro( OutputConvertibleToDoubleCheck,
                   ( Concept::Convertible< PixelType, double > ) );
  itkConceptMacro( OutputDivisionOperatorsCheck,
                   ( Concept::DivisionOperators< PixelType > ) );
  itkConceptMacro( DoubleOutputMultiplyOperatorCheck,
                   ( Concept::MultiplyOperator< double, PixelType, PixelType > ) );
  itkConceptMacro( IntOutputMultiplyOperatorCheck,
                   ( Concept::MultiplyOperator< int, PixelType, PixelType > ) );
  itkConceptMacro( OutputLessThanDoubleCheck,
                   ( Concept::LessThanComparable< PixelType, double > ) );
  itkConceptMacro( OutputDoubleAdditiveOperatorsCheck,
                   ( Concept::AdditiveOperators< PixelType, double > ) );
  // End concept checking
#endif

protected:
  CurvatureFlowImageFilter();
  ~CurvatureFlowImageFilter() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  bool Halt() override
  {
    if ( this->GetElapsedIterations() == this->GetNumberOfIterations() )
      {
      return true;
      }
    else
      {
      return false;
      }
  }

  void InitializeIteration() override;

  void EnlargeOutputRequestedRegion(DataObject *) override;

  void GenerateInputRequestedRegion() override;

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

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

#endif