itkLevelSetFunctionWithRefitTerm.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 itkLevelSetFunctionWithRefitTerm_h
#define itkLevelSetFunctionWithRefitTerm_h
 
#include "itkLevelSetFunction.h"
#include "itkSparseImage.h"
#include "itkNumericTraits.h"
 
namespace itk
{
template <typename TImageType, typename TSparseImageType>
class ITK_TEMPLATE_EXPORT LevelSetFunctionWithRefitTerm : public LevelSetFunction<TImageType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LevelSetFunctionWithRefitTerm);

  using Self = LevelSetFunctionWithRefitTerm;
  using Superclass = LevelSetFunction<TImageType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(LevelSetFunctionWithRefitTerm);

  itkNewMacro(Self);

  using typename Superclass::ImageType;
  using typename Superclass::FloatOffsetType;
  using typename Superclass::ScalarValueType;
  using typename Superclass::GlobalDataStruct;
  using typename Superclass::NeighborhoodType;
  using typename Superclass::NeighborhoodScalesType;
  using typename Superclass::TimeStepType;
 
  using NeighborhoodSizeValueType = typename NeighborhoodType::SizeValueType;

  using IndexType = typename ImageType::IndexType;

  using SparseImageType = TSparseImageType;

  using NodeType = typename SparseImageType::NodeType;

  using NormalVectorType = typename NodeType::NodeDataType;

  void
  SetRefitWeight(const ScalarValueType w)
  {
    m_RefitWeight = w;
  }

  void
  SetOtherPropagationWeight(const ScalarValueType w)
  {
    m_OtherPropagationWeight = w;
  }

  void
  SetSparseTargetImage(SparseImageType * im)
  {
    m_SparseTargetImage = im;
  }

  SparseImageType *
  GetSparseTargetImage() const
  {
    return m_SparseTargetImage;
  }

  TimeStepType
  ComputeGlobalTimeStep(void * GlobalData) const override;
 
protected:
  ScalarValueType m_RefitWeight{};

  ScalarValueType m_OtherPropagationWeight{};
 
  LevelSetFunctionWithRefitTerm();
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  ScalarValueType
  ComputeCurvature(const NeighborhoodType &) const;

  ScalarValueType
  PropagationSpeed(const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct * = 0) const override;

  virtual ScalarValueType
  OtherPropagationSpeed(const NeighborhoodType &, const FloatOffsetType &, GlobalDataStruct * = 0) const
  {
    return ScalarValueType{};
  }
 
private:
  typename SparseImageType::Pointer m_SparseTargetImage{};

  ScalarValueType m_MinVectorNorm{};

  static const NeighborhoodSizeValueType m_NumVertex;
  static const ScalarValueType           m_DimConst;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelSetFunctionWithRefitTerm.hxx"
#endif
 
#endif