itkLevelSetEquationTermBase.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 itkLevelSetEquationTermBase_h
#define itkLevelSetEquationTermBase_h
 
#include "itkObject.h"
#include "itkHeavisideStepFunctionBase.h"
#include <unordered_set>
 
namespace itk
{
template <typename TInputImage, // Input image
          typename TLevelSetContainer>
class ITK_TEMPLATE_EXPORT LevelSetEquationTermBase : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LevelSetEquationTermBase);
 
  using Self = LevelSetEquationTermBase;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using Superclass = Object;

  itkOverrideGetNameOfClassMacro(LevelSetEquationTermBase);
 
  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputPixelType = typename InputImageType::PixelType;
  using InputPixelRealType = typename NumericTraits<InputPixelType>::RealType;

  using LevelSetContainerType = TLevelSetContainer;
  using LevelSetIdentifierType = typename LevelSetContainerType::LevelSetIdentifierType;
  using LevelSetContainerPointer = typename LevelSetContainerType::Pointer;
  using LevelSetType = typename LevelSetContainerType::LevelSetType;
  using LevelSetPointer = typename LevelSetContainerType::LevelSetPointer;
  using LevelSetOutputPixelType = typename LevelSetContainerType::OutputType;
  using LevelSetOutputRealType = typename LevelSetContainerType::OutputRealType;
  using LevelSetInputIndexType = typename LevelSetContainerType::InputIndexType;
  using LevelSetGradientType = typename LevelSetContainerType::GradientType;
  using LevelSetHessianType = typename LevelSetContainerType::HessianType;
  using LevelSetDataType = typename LevelSetContainerType::LevelSetDataType;
 
  using DomainMapImageFilterType = typename LevelSetContainerType::DomainMapImageFilterType;
  using CacheImageType = typename LevelSetContainerType::CacheImageType;
 
  using HeavisideType = HeavisideStepFunctionBase<LevelSetOutputRealType, LevelSetOutputRealType>;
  //  using HeavisidePointer = typename HeavisideType::Pointer;
  using HeavisideConstPointer = typename HeavisideType::ConstPointer;

  itkSetObjectMacro(Input, InputImageType);
  itkGetModifiableObjectMacro(Input, InputImageType);
 
  itkSetMacro(Coefficient, LevelSetOutputRealType);
  itkGetMacro(Coefficient, LevelSetOutputRealType);
 
  itkSetMacro(CurrentLevelSetId, LevelSetIdentifierType);
  itkGetMacro(CurrentLevelSetId, LevelSetIdentifierType);
 
  itkGetModifiableObjectMacro(CurrentLevelSetPointer, LevelSetType);
 
  virtual void
  SetLevelSetContainer(LevelSetContainerType * iContainer);
  itkGetModifiableObjectMacro(LevelSetContainer, LevelSetContainerType);

  virtual LevelSetOutputRealType
  Evaluate(const LevelSetInputIndexType & iP);
 
  virtual LevelSetOutputRealType
  Evaluate(const LevelSetInputIndexType & iP, const LevelSetDataType & iData);

  virtual void
  Initialize(const LevelSetInputIndexType & iP) = 0;

  virtual void
  InitializeParameters() = 0;

  virtual void
  UpdatePixel(const LevelSetInputIndexType & iP,
              const LevelSetOutputRealType & oldValue,
              const LevelSetOutputRealType & newValue) = 0;

  itkGetConstMacro(CFLContribution, LevelSetOutputRealType);

  itkSetStringMacro(TermName);
  itkGetStringMacro(TermName);

  virtual void
  Update() = 0;
 
  using RequiredDataType = std::unordered_set<std::string>;
 
  const RequiredDataType &
  GetRequiredData() const;
 
protected:
  LevelSetEquationTermBase();

  ~LevelSetEquationTermBase() override = default;
 
  void
  SetUp();

  virtual LevelSetOutputRealType
  Value(const LevelSetInputIndexType & iP) = 0;
 
  virtual LevelSetOutputRealType
  Value(const LevelSetInputIndexType & iP, const LevelSetDataType & iData) = 0;

  InputImagePointer m_Input{};

  LevelSetContainerPointer m_LevelSetContainer{};

  LevelSetIdentifierType m_CurrentLevelSetId{};
 
  LevelSetPointer m_CurrentLevelSetPointer{};

  LevelSetOutputRealType m_Coefficient{};

  LevelSetOutputRealType m_CFLContribution{};

  HeavisideConstPointer m_Heaviside{};

  std::string m_TermName{};
 
  RequiredDataType m_RequiredData{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelSetEquationTermBase.hxx"
#endif
 
#endif