itkMultiphaseDenseFiniteDifferenceImageFilter.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 itkMultiphaseDenseFiniteDifferenceImageFilter_h
#define itkMultiphaseDenseFiniteDifferenceImageFilter_h
 
#include "itkMultiphaseFiniteDifferenceImageFilter.h"
#include "itkBinaryThresholdImageFilter.h"
#include "itkSignedMaurerDistanceMapImageFilter.h"
#include "itkNumericTraits.h"
#include "itkNeighborhoodAlgorithm.h"
 
#include <list>
 
namespace itk
{
template <typename TInputImage,
          typename TFeatureImage,
          typename TOutputImage,
          typename TFunction,
          typename TIdCell = unsigned int>
class ITK_TEMPLATE_EXPORT MultiphaseDenseFiniteDifferenceImageFilter
  : public MultiphaseFiniteDifferenceImageFilter<TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiphaseDenseFiniteDifferenceImageFilter);

  using Self = MultiphaseDenseFiniteDifferenceImageFilter;
  using Superclass =
    MultiphaseFiniteDifferenceImageFilter<TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(MultiphaseDenseFiniteDifferenceImageFilter);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using typename Superclass::InputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::InputRegionType;
  using typename Superclass::InputSizeType;
  using typename Superclass::InputSizeValueType;
  using typename Superclass::InputIndexType;
  using typename Superclass::InputIndexValueType;
  using typename Superclass::InputPixelType;
  using typename Superclass::InputPointType;
  using typename Superclass::InputSpacingType;
  using ValueType = typename InputImageType::ValueType;
 
  using typename Superclass::FeatureImageType;
  using typename Superclass::FeatureSizeType;
  using typename Superclass::FeatureImagePointer;
  using typename Superclass::FeatureRegionType;
  using typename Superclass::FeatureSpacingType;
  using typename Superclass::FeaturePointType;
  using typename Superclass::FeaturePixelType;
 
  using typename Superclass::OutputImageType;
  using typename Superclass::OutputImagePointer;
  using typename Superclass::OutputRegionType;
  using typename Superclass::OutputSizeType;
  using SizeValueType = typename Superclass::OutputSizeValueType;
  using typename Superclass::OutputIndexType;
  using typename Superclass::OutputIndexValueType;
  using OutputPixelType = typename OutputImageType::PixelType;
 
  using typename Superclass::IdCellType;
 
  using ThresholdFilterType = BinaryThresholdImageFilter<InputImageType, InputImageType>;
  using ThresholdFilterPointer = typename ThresholdFilterType::Pointer;
 
  using MaurerType = SignedMaurerDistanceMapImageFilter<InputImageType, InputImageType>;
  using MaurerPointer = typename MaurerType::Pointer;
 
  using typename Superclass::FiniteDifferenceFunctionType;
  using typename Superclass::FiniteDifferenceFunctionPointer;
  using NeighborhoodIteratorType = typename FiniteDifferenceFunctionType::NeighborhoodType;

  using typename Superclass::TimeStepType;
 
  using FaceCalculatorType = NeighborhoodAlgorithm::ImageBoundaryFacesCalculator<InputImageType>;
  using FaceListType = typename FaceCalculatorType::FaceListType;
 
  void
  SetFunctionCount(const IdCellType & n);
 
  itkConceptMacro(OutputTimesDoubleCheck, (Concept::MultiplyOperator<OutputPixelType, double>));
  itkConceptMacro(OutputAdditiveOperatorsCheck, (Concept::AdditiveOperators<OutputPixelType>));
  itkConceptMacro(InputConvertibleToOutputCheck, (Concept::Convertible<FeaturePixelType, OutputPixelType>));
 
  itkSetMacro(ReinitializeCounter, unsigned int);
  itkGetMacro(ReinitializeCounter, unsigned int);
 
protected:
  MultiphaseDenseFiniteDifferenceImageFilter()
  {
    this->m_ReinitializeCounter = 1;
    // FIXME: this->m_UpdateCounter really used?
    // this->m_UpdateCounter = 0;        // FIXME: Should this be a bool ?
  }
 
  ~MultiphaseDenseFiniteDifferenceImageFilter() override = default;
 
  void
  PrintSelf(std::ostream &, Indent indent) const override;

  void
  CopyInputToOutput() override;
 
  void
  PostProcessOutput() override;

  void
  ApplyUpdate(TimeStepType dt) override;
 
  unsigned int m_ReinitializeCounter{}; // FIXME: Should this be a boolean ?
  // unsigned int m_UpdateCounter;        // FIXME: Should this be a boolean ?
 
private:
  void
  AllocateUpdateBuffer() override;

  TimeStepType
  CalculateChange() override;

  std::vector<InputImagePointer> m_UpdateBuffers{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMultiphaseDenseFiniteDifferenceImageFilter.hxx"
#endif
 
#endif