itkLevelSetBase.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 itkLevelSetBase_h
#define itkLevelSetBase_h
 
#include <utility>
 
#include "itkIntTypes.h"
#include "itkCovariantVector.h"
#include "itkMatrix.h"
#include "itkNumericTraits.h"
#include "itkDataObject.h"
 
namespace itk
{
template <typename TInput, unsigned int VDimension, typename TOutput, typename TDomain>
class ITK_TEMPLATE_EXPORT LevelSetBase : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LevelSetBase);
 
  using Self = LevelSetBase;
  using Superclass = DataObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkOverrideGetNameOfClassMacro(LevelSetBase);
 
  static constexpr unsigned int Dimension = VDimension;
 
  using InputType = TInput;
  using OutputType = TOutput;
  using DomainType = TDomain;
  using OutputRealType = typename NumericTraits<OutputType>::RealType;
  using GradientType = CovariantVector<OutputRealType, VDimension>;
  using HessianType = Matrix<OutputRealType, VDimension, VDimension>;
 
  using RegionType = IdentifierType;
 
  virtual OutputType
  Evaluate(const InputType & iP) const = 0;
 
  virtual GradientType
  EvaluateGradient(const InputType & iP) const = 0;
 
  virtual HessianType
  EvaluateHessian(const InputType & iP) const = 0;
 
  virtual OutputRealType
  EvaluateLaplacian(const InputType & iP) const = 0;
  virtual OutputRealType
  EvaluateGradientNorm(const InputType & iP) const;
  virtual OutputRealType
  EvaluateMeanCurvature(const InputType & iP) const = 0;
 
  template <typename T>
  class ITK_TEMPLATE_EXPORT DataType
  {
  public:
    DataType() = delete;
 
    DataType(std::string iName)
      : m_Name(std::move(iName))
      , m_Computed(false)
    {}
    DataType(const DataType & iData)
      : m_Name(iData.m_Name)
      , m_Value(iData.m_Value)
      , m_Computed(iData.m_Computed)
    {}
 
    ~DataType() = default;
 
    std::string m_Name;
    T           m_Value;
    bool        m_Computed;
 
    void
    operator=(const DataType & iData)
    {
      this->m_Name = iData.m_Name;
      this->m_Value = iData.m_Value;
      this->m_Computed = iData.m_Computed;
    }
  };
 
  struct LevelSetDataType
  {
    LevelSetDataType()
      : Value("Value")
      , Gradient("Gradient")
      , Hessian("Hessian")
      , Laplacian("Laplacian")
      , GradientNorm("GradientNorm")
      , MeanCurvature("MeanCurvature")
      , ForwardGradient("ForwardGradient")
      , BackwardGradient("BackwardGradient")
    {
      Value.m_Value = OutputType{};
      Gradient.m_Value.Fill(OutputRealType{});
      Hessian.m_Value.Fill(OutputRealType{});
      Laplacian.m_Value = OutputRealType{};
      GradientNorm.m_Value = OutputRealType{};
      MeanCurvature.m_Value = OutputRealType{};
      ForwardGradient.m_Value.Fill(OutputRealType{});
      BackwardGradient.m_Value.Fill(OutputRealType{});
    }
    LevelSetDataType(const LevelSetDataType & iData)
      : Value(iData.Value)
      , Gradient(iData.Gradient)
      , Hessian(iData.Hessian)
      , Laplacian(iData.Laplacian)
      , GradientNorm(iData.GradientNorm)
      , MeanCurvature(iData.MeanCurvature)
      , ForwardGradient(iData.ForwardGradient)
      , BackwardGradient(iData.BackwardGradient)
    {}
 
    ~LevelSetDataType() = default;
 
    void
    operator=(const LevelSetDataType & iData)
    {
      Value = iData.Value;
      Gradient = iData.Gradient;
      Hessian = iData.Hessian;
      Laplacian = iData.Laplacian;
      GradientNorm = iData.GradientNorm;
      MeanCurvature = iData.MeanCurvature;
      ForwardGradient = iData.ForwardGradient;
      BackwardGradient = iData.BackwardGradient;
    }
 
    DataType<OutputType>     Value;
    DataType<GradientType>   Gradient;
    DataType<HessianType>    Hessian;
    DataType<OutputRealType> Laplacian;
    DataType<OutputRealType> GradientNorm;
    DataType<OutputRealType> MeanCurvature;
    DataType<GradientType>   ForwardGradient;
    DataType<GradientType>   BackwardGradient;
  };
 
  virtual void
  Evaluate(const InputType & iP, LevelSetDataType & ioData) const = 0;
  virtual void
  EvaluateGradient(const InputType & iP, LevelSetDataType & ioData) const = 0;
  virtual void
  EvaluateHessian(const InputType & iP, LevelSetDataType & ioData) const = 0;
  virtual void
  EvaluateLaplacian(const InputType & iP, LevelSetDataType & ioData) const = 0;
  virtual void
  EvaluateGradientNorm(const InputType & iP, LevelSetDataType & ioData) const;
  virtual void
  EvaluateMeanCurvature(const InputType & iP, LevelSetDataType & ioData) const;
  virtual void
  EvaluateForwardGradient(const InputType & iP, LevelSetDataType & ioData) const = 0;
  virtual void
  EvaluateBackwardGradient(const InputType & iP, LevelSetDataType & ioData) const = 0;
 
  virtual bool
  IsInside(const InputType & iP) const;
 
  itkGetConstMacro(MaximumNumberOfRegions, RegionType);
 
  void
  Initialize() override;
 
  void
  UpdateOutputInformation() override;
 
  void
  SetRequestedRegionToLargestPossibleRegion() override;
 
  void
  CopyInformation(const DataObject * data) override;
 
  void
  Graft(const DataObject * data) override;
 
  bool
  RequestedRegionIsOutsideOfTheBufferedRegion() override;
 
  bool
  VerifyRequestedRegion() override;
 
  void
  SetRequestedRegion(const DataObject * data) override;
 
  virtual void
  SetRequestedRegion(const RegionType & region);
 
  itkGetConstMacro(RequestedRegion, RegionType);
 
  virtual void
  SetBufferedRegion(const RegionType & region);
 
  itkGetConstMacro(BufferedRegion, RegionType);
 
protected:
  LevelSetBase();
  ~LevelSetBase() override = default;
 
  // If the RegionType is ITK_UNSTRUCTURED_REGION, then the following
  // variables represent the maximum number of region that the data
  // object can be broken into, which region out of how many is
  // currently in the buffered region, and the number of regions and
  // the specific region requested for the update. Data objects that
  // do not support any division of the data can simply leave the
  // MaximumNumberOfRegions as 1. The RequestedNumberOfRegions and
  // RequestedRegion are used to define the currently requested
  // region. The LargestPossibleRegion is always requested region = 0
  // and number of regions = 1;
  RegionType m_MaximumNumberOfRegions{ 0 };
  RegionType m_NumberOfRegions{ 0 };
  RegionType m_RequestedNumberOfRegions{ 0 };
  RegionType m_BufferedRegion{ 0 };
  RegionType m_RequestedRegion{ 0 };
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelSetBase.hxx"
#endif
 
#endif // itkLevelSetBase_h