itkScalarChanAndVeseLevelSetFunction.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
 *
 *         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 itkScalarChanAndVeseLevelSetFunction_h
#define itkScalarChanAndVeseLevelSetFunction_h
 
#include "itkScalarRegionBasedLevelSetFunction.h"
#include "itkScalarChanAndVeseLevelSetFunctionData.h"
#include "itkConstrainedRegionBasedLevelSetFunctionSharedData.h"
 
namespace itk
{
template <typename TInputImage,
          typename TFeatureImage,
          typename TSharedData = ConstrainedRegionBasedLevelSetFunctionSharedData<
            TInputImage,
            TFeatureImage,
            ScalarChanAndVeseLevelSetFunctionData<TInputImage, TFeatureImage>>>
class ITK_TEMPLATE_EXPORT ScalarChanAndVeseLevelSetFunction
  : public ScalarRegionBasedLevelSetFunction<TInputImage, TFeatureImage, TSharedData>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ScalarChanAndVeseLevelSetFunction);
 
  using Self = ScalarChanAndVeseLevelSetFunction;
  using Superclass = ScalarRegionBasedLevelSetFunction<TInputImage, TFeatureImage, TSharedData>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ScalarChanAndVeseLevelSetFunction, ScalarLevelSetFunction);
 
  static constexpr unsigned int ImageDimension = TFeatureImage::ImageDimension;
 
  using InputImageType = TInputImage;
  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
  using InputImagePointer = typename Superclass::InputImagePointer;
  using InputPixelType = typename Superclass::InputPixelType;
  using InputIndexType = typename Superclass::InputIndexType;
  using InputIndexValueType = typename Superclass::InputIndexValueType;
  using InputSizeType = typename Superclass::InputSizeType;
  using InputSizeValueType = typename Superclass::InputSizeValueType;
  using InputRegionType = typename Superclass::InputRegionType;
  using InputPointType = typename Superclass::InputPointType;
 
  using FeatureImageType = TFeatureImage;
  using FeatureImageConstPointer = typename FeatureImageType::ConstPointer;
  using FeaturePixelType = typename Superclass::FeaturePixelType;
  using FeatureIndexType = typename Superclass::FeatureIndexType;
  using FeatureOffsetType = typename Superclass::FeatureOffsetType;
 
  using ScalarValueType = typename Superclass::ScalarValueType;
  using NeighborhoodType = typename Superclass::NeighborhoodType;
  using FloatOffsetType = typename Superclass::FloatOffsetType;
  using RadiusType = typename Superclass::RadiusType;
  using TimeStepType = typename Superclass::TimeStepType;
  using GlobalDataStruct = typename Superclass::GlobalDataStruct;
  using PixelType = typename Superclass::PixelType;
  using VectorType = typename Superclass::VectorType;
 
  using SharedDataType = typename Superclass::SharedDataType;
  using SharedDataPointer = typename Superclass::SharedDataPointer;
 
  using ImageIteratorType = typename Superclass::ImageIteratorType;
  using ConstImageIteratorType = typename Superclass::ConstImageIteratorType;
  using FeatureImageIteratorType = typename Superclass::FeatureImageIteratorType;
  using ConstFeatureIteratorType = typename Superclass::ConstFeatureIteratorType;
 
  using ListPixelType = typename Superclass::ListPixelType;
  using ListPixelConstIterator = typename Superclass::ListPixelConstIterator;
  using ListPixelIterator = typename Superclass::ListPixelIterator;
  using ListImageType = typename Superclass::ListImageType;
 
protected:
  ScalarChanAndVeseLevelSetFunction()
    : Superclass()
  {}
  ~ScalarChanAndVeseLevelSetFunction() override = default;
 
  void
  ComputeParameters() override;
 
  void
  UpdateSharedDataParameters() override;
 
  ScalarValueType
  ComputeInternalTerm(const FeaturePixelType & iValue, const FeatureIndexType & iIdx) override;
 
  ScalarValueType
  ComputeExternalTerm(const FeaturePixelType & iValue, const FeatureIndexType & iIdx) override;
 
  void
  UpdateSharedDataInsideParameters(const unsigned int &     iId,
                                   const FeaturePixelType & iVal,
                                   const ScalarValueType &  iChange) override;
 
  void
  UpdateSharedDataOutsideParameters(const unsigned int &     iId,
                                    const FeaturePixelType & iVal,
                                    const ScalarValueType &  iChange) override;
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkScalarChanAndVeseLevelSetFunction.hxx"
#endif
 
#endif