itkLevelSetEquationOverlapPenaltyTerm.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 itkLevelSetEquationOverlapPenaltyTerm_h
#define itkLevelSetEquationOverlapPenaltyTerm_h
 
#include "itkLevelSetEquationTermBase.h"
#include "itkCompensatedSummation.h"
 
namespace itk
{
template <typename TInput, // Input image or mesh
          typename TLevelSetContainer>
class ITK_TEMPLATE_EXPORT LevelSetEquationOverlapPenaltyTerm
  : public LevelSetEquationTermBase<TInput, TLevelSetContainer>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LevelSetEquationOverlapPenaltyTerm);
 
  using Self = LevelSetEquationOverlapPenaltyTerm;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using Superclass = LevelSetEquationTermBase<TInput, TLevelSetContainer>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(LevelSetEquationOverlapPenaltyTerm);
 
  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::HeavisideType;
  using typename Superclass::HeavisideConstPointer;
 
  using typename Superclass::LevelSetDataType;
 
  using typename Superclass::DomainMapImageFilterType;
  using typename Superclass::CacheImageType;
 
  using IdListType = typename LevelSetContainerType::IdListType;
  using IdListIterator = typename LevelSetContainerType::IdListIterator;
  using IdListConstIterator = typename LevelSetContainerType::IdListConstIterator;
 
  using CompensatedSummationType = CompensatedSummation<LevelSetOutputRealType>;
 

  void
  Update() override
  {}

  void
  InitializeParameters() override;

  void
  Initialize(const LevelSetInputIndexType & itkNotUsed(index)) override
  {}

  virtual void
  ComputeSumTerm(const LevelSetInputIndexType & index, LevelSetOutputRealType & sum);

  void
  UpdatePixel(const LevelSetInputIndexType & itkNotUsed(index),
              const LevelSetOutputRealType & itkNotUsed(oldValue),
              const LevelSetOutputRealType & itkNotUsed(newValue)) override
  {}
 
 
protected:
  LevelSetEquationOverlapPenaltyTerm();
 
  ~LevelSetEquationOverlapPenaltyTerm() override = default;

  LevelSetOutputRealType
  Value(const LevelSetInputIndexType & index) override;

  LevelSetOutputRealType
  Value(const LevelSetInputIndexType & index, const LevelSetDataType & data) override;
 
private:
  DomainMapImageFilterType * m_DomainMapImageFilter{};
  CacheImageType *           m_CacheImage{};
};
 
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelSetEquationOverlapPenaltyTerm.hxx"
#endif
 
#endif