itkUpdateShiSparseLevelSet.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 itkUpdateShiSparseLevelSet_h
#define itkUpdateShiSparseLevelSet_h
 
#include "itkImage.h"
#include "itkDiscreteLevelSetImage.h"
#include "itkShiSparseLevelSetImage.h"
#include "itkShapedNeighborhoodIterator.h"
#include "itkNeighborhoodAlgorithm.h"
#include "itkLabelMapToLabelImageFilter.h"
#include "itkLabelImageToLabelMapFilter.h"
 
namespace itk
{
template <unsigned int VDimension, typename TEquationContainer>
class ITK_TEMPLATE_EXPORT UpdateShiSparseLevelSet : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(UpdateShiSparseLevelSet);
 
  using Self = UpdateShiSparseLevelSet;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using Superclass = Object;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(UpdateShiSparseLevelSet);
 
  static constexpr unsigned int ImageDimension = VDimension;
 
  using LevelSetType = ShiSparseLevelSetImage<ImageDimension>;
  using LevelSetPointer = typename LevelSetType::Pointer;
  using LevelSetInputType = typename LevelSetType::InputType;
  using LevelSetOutputType = typename LevelSetType::OutputType;
  using LevelSetOffsetType = typename LevelSetType::OffsetType;
 
  using LevelSetLabelMapType = typename LevelSetType::LabelMapType;
  using LevelSetLabelMapPointer = typename LevelSetType::LabelMapPointer;
 
  using LevelSetLabelObjectType = typename LevelSetType::LabelObjectType;
  using LevelSetLabelObjectPointer = typename LevelSetType::LabelObjectPointer;
  using LevelSetLabelObjectLengthType = typename LevelSetType::LabelObjectLengthType;
  using LevelSetLabelObjectLineType = typename LevelSetType::LabelObjectLineType;
 
  using LevelSetLayerType = typename LevelSetType::LayerType;
  using LevelSetLayerIterator = typename LevelSetType::LayerIterator;
  using LevelSetLayerConstIterator = typename LevelSetType::LayerConstIterator;
  using LevelSetOutputRealType = typename LevelSetType::OutputRealType;
 
  using LevelSetLayerMapType = typename LevelSetType::LayerMapType;
  using LevelSetLayerMapIterator = typename LevelSetType::LayerMapIterator;
  using LevelSetLayerMapConstIterator = typename LevelSetType::LayerMapConstIterator;
 
  using EquationContainerType = TEquationContainer;
  using EquationContainerPointer = typename EquationContainerType::Pointer;
  using TermContainerPointer = typename EquationContainerType::TermContainerPointer;
 
  itkGetModifiableObjectMacro(OutputLevelSet, LevelSetType);

  void
  Update();

  itkSetObjectMacro(InputLevelSet, LevelSetType);
  itkGetModifiableObjectMacro(InputLevelSet, LevelSetType);
  itkGetMacro(RMSChangeAccumulator, LevelSetOutputRealType);

  itkSetObjectMacro(EquationContainer, EquationContainerType);
  itkGetModifiableObjectMacro(EquationContainer, EquationContainerType);
  itkSetMacro(CurrentLevelSetId, IdentifierType);
  itkGetMacro(CurrentLevelSetId, IdentifierType);
protected:
  UpdateShiSparseLevelSet();
  ~UpdateShiSparseLevelSet() override = default;
 
  // output
  LevelSetPointer m_OutputLevelSet{};
 
  IdentifierType           m_CurrentLevelSetId{};
  LevelSetOutputRealType   m_RMSChangeAccumulator{};
  EquationContainerPointer m_EquationContainer{};
 
  using LabelImageType = Image<int8_t, ImageDimension>;
  using LabelImagePointer = typename LabelImageType::Pointer;
 
  LabelImagePointer m_InternalImage{};
 
  using NeighborhoodIteratorType = ShapedNeighborhoodIterator<LabelImageType>;

  // this is the same as Procedure 2
  // Input is a update image point m_UpdateImage
  // Input is also ShiSparseLevelSetImagePointer
  void
  UpdateLayerPlusOne();

  void
  UpdateLayerMinusOne();

  bool
  Con(const LevelSetInputType &      idx,
      const LevelSetOutputType &     currentStatus,
      const LevelSetOutputRealType & currentUpdate) const;
 
private:
  // input
  LevelSetPointer    m_InputLevelSet{};
  LevelSetOffsetType m_Offset{};
 
  using NodePairType = std::pair<LevelSetInputType, LevelSetOutputType>;
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkUpdateShiSparseLevelSet.hxx"
#endif
 
#endif // itkUpdateShiSparseLevelSet_h