itkScalarChanAndVeseSparseLevelSetImageFilter.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 itkScalarChanAndVeseSparseLevelSetImageFilter_h
#define itkScalarChanAndVeseSparseLevelSetImageFilter_h
 
#include "itkMultiphaseSparseFiniteDifferenceImageFilter.h"
#include "itkRegionOfInterestImageFilter.h"
#include "itkScalarChanAndVeseLevelSetFunction.h"
 
namespace itk
{
template <typename TInputImage,
          typename TFeatureImage,
          typename TOutputImage,
          typename TFunction = ScalarChanAndVeseLevelSetFunction<TInputImage, TFeatureImage>,
          class TSharedData = typename TFunction::SharedDataType,
          typename TIdCell = unsigned int>
class ITK_TEMPLATE_EXPORT ScalarChanAndVeseSparseLevelSetImageFilter
  : public MultiphaseSparseFiniteDifferenceImageFilter<TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell>
{
public:
  using Self = ScalarChanAndVeseSparseLevelSetImageFilter;
  using Superclass =
    MultiphaseSparseFiniteDifferenceImageFilter<TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(ScalarChanAndVeseSparseLevelSetImageFilter);
 
  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
 
  using typename Superclass::InputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::InputPointType;
  using typename Superclass::ValueType;
  using typename Superclass::InputSpacingType;
 
  using FeatureImageType = TFeatureImage;
  using FeatureImagePointer = typename FeatureImageType::Pointer;
  using FeaturePixelType = typename FeatureImageType::PixelType;
  using FeatureIndexType = typename FeatureImageType::IndexType;
  using FeatureIndexValueType = typename FeatureIndexType::IndexValueType;
  using FeatureRegionType = typename FeatureImageType::RegionType;
 
  using OutputImageType = TOutputImage;
  using IndexType = typename OutputImageType::IndexType;
  using OutputPixelType = typename OutputImageType::PixelType;
 
  using typename Superclass::TimeStepType;
  using typename Superclass::FiniteDifferenceFunctionType;
 
  using typename Superclass::IdCellType;
 
  using FunctionType = TFunction;
  using FunctionPtr = typename FunctionType::Pointer;
 
  using SharedDataType = TSharedData;
  using SharedDataPointer = typename SharedDataType::Pointer;
 
  using ROIFilterType = RegionOfInterestImageFilter<FeatureImageType, FeatureImageType>;
  using ROIFilterPointer = typename ROIFilterType::Pointer;
 
#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<OutputPixelType>));
  // End concept checking
#endif
 
  virtual void
  SetFeatureImage(const FeatureImagePointer f)
  {
    this->SetInput(f);
  }
 
protected:
  ScalarChanAndVeseSparseLevelSetImageFilter()
  {
    this->SetNumberOfLayers(2); // Narrow-band usage
    this->m_SharedData = SharedDataType::New();
  }
 
  ~ScalarChanAndVeseSparseLevelSetImageFilter() override = default;
 
  SharedDataPointer m_SharedData{};
 
  void
  Initialize() override;
 
  void
  InitializeIteration() override;
 
  void
  UpdatePixel(unsigned int                           functionIndex,
              unsigned int                           idx,
              NeighborhoodIterator<InputImageType> & iterator,
              ValueType &                            newValue,
              bool &                                 status) override;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarChanAndVeseSparseLevelSetImageFilter.hxx"
#endif
 
#endif