itkLevelSetEquationAdvectionTerm.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 itkLevelSetEquationAdvectionTerm_h
#define itkLevelSetEquationAdvectionTerm_h
 
#include "itkLevelSetEquationTermBase.h"
#include "itkZeroFluxNeumannBoundaryCondition.h"
#include "itkConstNeighborhoodIterator.h"
#include "itkVector.h"
#include "vnl/vnl_matrix_fixed.h"
 
namespace itk
{
template <typename TInput, // Input image or mesh
          typename TLevelSetContainer>
class ITK_TEMPLATE_EXPORT LevelSetEquationAdvectionTerm : public LevelSetEquationTermBase<TInput, TLevelSetContainer>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LevelSetEquationAdvectionTerm);
 
  using Self = LevelSetEquationAdvectionTerm;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using Superclass = LevelSetEquationTermBase<TInput, TLevelSetContainer>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(LevelSetEquationAdvectionTerm);
 
  using typename Superclass::InputImageType;
  using typename Superclass::InputImagePointer;
  using typename Superclass::InputPixelType;
  using typename Superclass::InputPixelRealType;
 
  using typename Superclass::LevelSetContainerType;
  using typename Superclass::LevelSetContainerPointer;
  using typename Superclass::LevelSetType;
  using typename Superclass::LevelSetPointer;
  using typename Superclass::LevelSetOutputPixelType;
  using typename Superclass::LevelSetOutputRealType;
  using typename Superclass::LevelSetInputIndexType;
  using typename Superclass::LevelSetGradientType;
  using typename Superclass::LevelSetHessianType;
  using typename Superclass::LevelSetIdentifierType;
  using typename Superclass::LevelSetDataType;
 
  using typename Superclass::HeavisideType;
  using typename Superclass::HeavisideConstPointer;
 
  static constexpr unsigned int ImageDimension = InputImageType::ImageDimension;
 
  using VectorType = LevelSetGradientType;
 
  using AdvectionImageType = Image<VectorType, Self::ImageDimension>;
  using AdvectionImagePointer = typename AdvectionImageType::Pointer;
 
 
  void
  SetAdvectionImage(AdvectionImageType * iImage);
  itkGetModifiableObjectMacro(AdvectionImage, AdvectionImageType);
 
  itkSetMacro(DerivativeSigma, LevelSetOutputRealType);
  itkGetMacro(DerivativeSigma, LevelSetOutputRealType);

  using DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<InputImageType>;
  using RadiusType = typename ConstNeighborhoodIterator<InputImageType>::RadiusType;
  using NeighborhoodType = ConstNeighborhoodIterator<InputImageType, DefaultBoundaryConditionType>;
 
  using NeighborhoodScalesType = Vector<LevelSetOutputRealType, Self::ImageDimension>;

  void
  Update() override
  {}

  void
  InitializeParameters() override;

  void
  Initialize(const LevelSetInputIndexType &) override
  {}

  void
  UpdatePixel(const LevelSetInputIndexType & itkNotUsed(iP),
              const LevelSetOutputRealType & itkNotUsed(oldValue),
              const LevelSetOutputRealType & itkNotUsed(newValue)) override
  {}
 
protected:
  LevelSetEquationAdvectionTerm();
 
  ~LevelSetEquationAdvectionTerm() override = default;
 
  AdvectionImagePointer m_AdvectionImage{};

  VectorType
  AdvectionSpeed(const LevelSetInputIndexType & iP) const;

  LevelSetOutputRealType
  Value(const LevelSetInputIndexType & iP) override;
  LevelSetOutputRealType
  Value(const LevelSetInputIndexType & iP, const LevelSetDataType & iData) override;
 
  LevelSetOutputRealType m_NeighborhoodScales[ImageDimension]{};
 
private:
  LevelSetOutputRealType m_DerivativeSigma{};
 
  bool m_AutoGenerateAdvectionImage{};
 
  void
  GenerateAdvectionImage();
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelSetEquationAdvectionTerm.hxx"
#endif
 
#endif