itkLevelSetEvolution.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkLevelSetEvolution_h
#define itkLevelSetEvolution_h

#include "itkLevelSetEvolutionBase.h"
#include "itkLevelSetDenseImage.h"

#include "itkWhitakerSparseLevelSetImage.h"
#include "itkUpdateWhitakerSparseLevelSet.h"

#include "itkShiSparseLevelSetImage.h"
#include "itkUpdateShiSparseLevelSet.h"

#include "itkMalcolmSparseLevelSetImage.h"
#include "itkUpdateMalcolmSparseLevelSet.h"

#include "itkLevelSetEvolutionComputeIterationThreader.h"
#include "itkLevelSetEvolutionUpdateLevelSetsThreader.h"

namespace itk
{
template< typename TEquationContainer, typename TLevelSet >
class ITK_TEMPLATE_EXPORT LevelSetEvolution
{};

template< typename TEquationContainer, typename TImage >
class ITK_TEMPLATE_EXPORT LevelSetEvolution<  TEquationContainer,
                          LevelSetDenseImage< TImage > > :
  public LevelSetEvolutionBase< TEquationContainer, LevelSetDenseImage< TImage > >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(LevelSetEvolution);

  using LevelSetType = LevelSetDenseImage< TImage >;

  using Self = LevelSetEvolution;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using Superclass = LevelSetEvolutionBase< TEquationContainer, LevelSetType >;

  itkNewMacro( Self );

  itkTypeMacro( LevelSetEvolution, LevelSetEvolutionBase );

  using EquationContainerType = typename Superclass::EquationContainerType;
  using EquationContainerPointer = typename Superclass::EquationContainerPointer;
  using TermContainerType = typename Superclass::TermContainerType;
  using TermContainerPointer = typename Superclass::TermContainerPointer;

  using TermType = typename Superclass::TermType;
  using TermPointer = typename Superclass::TermPointer;

  using InputImageType = typename Superclass::InputImageType;
  using InputImagePixelType = typename Superclass::InputImagePixelType;
  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
  using InputImageRegionType = typename Superclass::InputImageRegionType;
  using InputPixelRealType = typename Superclass::InputPixelRealType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using LevelSetContainerType = typename Superclass::LevelSetContainerType;

  using LevelSetIdentifierType = typename Superclass::LevelSetIdentifierType;

  using LevelSetImageType = typename LevelSetType::ImageType;

  using LevelSetOutputType = typename Superclass::LevelSetOutputType;
  using LevelSetOutputRealType = typename Superclass::LevelSetOutputRealType;
  using LevelSetDataType = typename Superclass::LevelSetDataType;

  using IdListType = typename Superclass::IdListType;
  using IdListIterator = typename Superclass::IdListIterator;
  using IdListConstIterator = typename Superclass::IdListConstIterator;
  using IdListImageType = typename Superclass::IdListImageType;
  using CacheImageType = typename Superclass::CacheImageType;
  using DomainMapImageFilterType = typename Superclass::DomainMapImageFilterType;

  using StoppingCriterionType = typename Superclass::StoppingCriterionType;
  using StoppingCriterionPointer = typename Superclass::StoppingCriterionPointer;

  using ThresholdFilterType = BinaryThresholdImageFilter< LevelSetImageType, LevelSetImageType >;
  using ThresholdFilterPointer = typename ThresholdFilterType::Pointer;

  using MaurerType = SignedMaurerDistanceMapImageFilter< LevelSetImageType, LevelSetImageType >;
  using MaurerPointer = typename MaurerType::Pointer;

  using LevelSetImageIteratorType = ImageRegionIteratorWithIndex< LevelSetImageType >;

  using LevelSetImageConstIteratorType = ImageRegionConstIteratorWithIndex< LevelSetImageType >;

  using InputImageConstIteratorType = ImageRegionConstIteratorWithIndex< InputImageType >;

  void SetNumberOfWorkUnits( const ThreadIdType threads );

  ThreadIdType GetNumberOfWorkUnits() const;

  ~LevelSetEvolution() override = default;

protected:
  LevelSetEvolution();

  void AllocateUpdateBuffer() override;

  void ComputeIteration() override;

  void ComputeTimeStepForNextIteration() override;

  void UpdateLevelSets() override;

  void UpdateEquations() override;

  void ReinitializeToSignedDistance();

  typename LevelSetContainerType::Pointer    m_UpdateBuffer;

  friend class LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >;
  using SplitLevelSetComputeIterationThreaderType = LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >;
  typename SplitLevelSetComputeIterationThreaderType::Pointer m_SplitLevelSetComputeIterationThreader;

  using DomainMapConstIteratorType = typename DomainMapImageFilterType::DomainMapType::const_iterator;
  using ThreadedDomainMapPartitionerType = ThreadedIteratorRangePartitioner< DomainMapConstIteratorType >;
  friend class LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedDomainMapPartitionerType, Self >;
  using SplitDomainMapComputeIterationThreaderType = LevelSetEvolutionComputeIterationThreader< LevelSetType, ThreadedDomainMapPartitionerType, Self >;
  typename SplitDomainMapComputeIterationThreaderType::Pointer m_SplitDomainMapComputeIterationThreader;

  friend class LevelSetEvolutionUpdateLevelSetsThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >;
  using SplitLevelSetUpdateLevelSetsThreaderType = LevelSetEvolutionUpdateLevelSetsThreader< LevelSetType, ThreadedImageRegionPartitioner< TImage::ImageDimension >, Self >;
  typename SplitLevelSetUpdateLevelSetsThreaderType::Pointer m_SplitLevelSetUpdateLevelSetsThreader;

  const IdListType * m_IdListToProcessWhenThreading;
};


template< typename TEquationContainer, typename TOutput, unsigned int VDimension >
class ITK_TEMPLATE_EXPORT LevelSetEvolution< TEquationContainer, WhitakerSparseLevelSetImage< TOutput, VDimension > > :
  public LevelSetEvolutionBase< TEquationContainer, WhitakerSparseLevelSetImage< TOutput, VDimension > >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(LevelSetEvolution);

  using LevelSetType = WhitakerSparseLevelSetImage< TOutput, VDimension >;

  using Self = LevelSetEvolution;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using Superclass = LevelSetEvolutionBase< TEquationContainer, LevelSetType >;

  itkNewMacro( Self );

  itkTypeMacro( LevelSetEvolution, LevelSetEvolutionBase );

  using EquationContainerType = typename Superclass::EquationContainerType;
  using EquationContainerPointer = typename Superclass::EquationContainerPointer;
  using TermContainerType = typename Superclass::TermContainerType;
  using TermContainerPointer = typename Superclass::TermContainerPointer;

  using TermType = typename Superclass::TermType;
  using TermPointer = typename Superclass::TermPointer;

  using InputImageType = typename Superclass::InputImageType;
  using InputImagePixelType = typename Superclass::InputImagePixelType;
  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
  using InputImageRegionType = typename Superclass::InputImageRegionType;
  using InputPixelRealType = typename Superclass::InputPixelRealType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using LevelSetContainerType = typename Superclass::LevelSetContainerType;
  using LevelSetIdentifierType = typename Superclass::LevelSetIdentifierType;

  using LevelSetInputType = typename Superclass::LevelSetInputType;
  using LevelSetOutputType = typename Superclass::LevelSetOutputType;
  using LevelSetOutputRealType = typename Superclass::LevelSetOutputRealType;
  using LevelSetDataType = typename Superclass::LevelSetDataType;

  using LevelSetLayerType = typename LevelSetType::LayerType;

  using LevelSetLabelMapType = typename LevelSetType::LabelMapType;
  using LevelSetLabelMapPointer = typename LevelSetType::LabelMapPointer;


  using IdListType = typename Superclass::IdListType;
  using IdListIterator = typename Superclass::IdListIterator;
  using IdListImageType = typename Superclass::IdListImageType;
  using CacheImageType = typename Superclass::CacheImageType;
  using DomainMapImageFilterType = typename Superclass::DomainMapImageFilterType;

  using StoppingCriterionType = typename Superclass::StoppingCriterionType;
  using StoppingCriterionPointer = typename Superclass::StoppingCriterionPointer;

  using InputImageConstIteratorType = ImageRegionConstIteratorWithIndex< InputImageType >;

  using UpdateLevelSetFilterType = UpdateWhitakerSparseLevelSet< ImageDimension, LevelSetOutputType, EquationContainerType >;
  using UpdateLevelSetFilterPointer = typename UpdateLevelSetFilterType::Pointer;

  void SetNumberOfWorkUnits( const ThreadIdType threads );

  ThreadIdType GetNumberOfWorkUnits() const;

protected:
  LevelSetEvolution();
  ~LevelSetEvolution() override;

  using NodePairType = std::pair< LevelSetInputType, LevelSetOutputType >;

  // For sparse case, the update buffer needs to be the size of the active layer
  std::map< IdentifierType, LevelSetLayerType* >  m_UpdateBuffer;

  void AllocateUpdateBuffer() override;

  void ComputeIteration() override;

  void ComputeTimeStepForNextIteration() override;

  void UpdateLevelSets() override;

  void UpdateEquations() override;

  using SplitLevelSetPartitionerType = ThreadedIteratorRangePartitioner< typename LevelSetType::LayerConstIterator >;
  friend class LevelSetEvolutionComputeIterationThreader< LevelSetType, SplitLevelSetPartitionerType, Self >;
  using SplitLevelSetComputeIterationThreaderType = LevelSetEvolutionComputeIterationThreader< LevelSetType, SplitLevelSetPartitionerType, Self >;
  typename SplitLevelSetComputeIterationThreaderType::Pointer m_SplitLevelSetComputeIterationThreader;
};


// Shi
template< typename TEquationContainer, unsigned int VDimension >
class ITK_TEMPLATE_EXPORT LevelSetEvolution<
    TEquationContainer,
    ShiSparseLevelSetImage< VDimension > > :
public LevelSetEvolutionBase< TEquationContainer, ShiSparseLevelSetImage< VDimension > >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(LevelSetEvolution);

  using LevelSetType = ShiSparseLevelSetImage< VDimension >;

  using Self = LevelSetEvolution;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using Superclass = LevelSetEvolutionBase< TEquationContainer, LevelSetType >;

  itkNewMacro( Self );

  itkTypeMacro( LevelSetEvolution, LevelSetEvolutionBase );

  using EquationContainerType = typename Superclass::EquationContainerType;
  using EquationContainerPointer = typename Superclass::EquationContainerPointer;
  using TermContainerType = typename Superclass::TermContainerType;
  using TermContainerPointer = typename Superclass::TermContainerPointer;

  using TermType = typename Superclass::TermType;
  using TermPointer = typename Superclass::TermPointer;

  using InputImageType = typename Superclass::InputImageType;
  using InputImagePixelType = typename Superclass::InputImagePixelType;
  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
  using InputImageRegionType = typename Superclass::InputImageRegionType;
  using InputPixelRealType = typename Superclass::InputPixelRealType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using LevelSetContainerType = typename Superclass::LevelSetContainerType;
  using LevelSetIdentifierType = typename Superclass::LevelSetIdentifierType;

  using LevelSetInputType = typename Superclass::LevelSetInputType;
  using LevelSetOutputType = typename Superclass::LevelSetOutputType;
  using LevelSetOutputRealType = typename Superclass::LevelSetOutputRealType;
  using LevelSetDataType = typename Superclass::LevelSetDataType;

  using LevelSetLayerType = typename LevelSetType::LayerType;

  using LevelSetLabelMapType = typename LevelSetType::LabelMapType;
  using LevelSetLabelMapPointer = typename LevelSetType::LabelMapPointer;


  using IdListType = typename Superclass::IdListType;
  using IdListIterator = typename Superclass::IdListIterator;
  using IdListImageType = typename Superclass::IdListImageType;
  using CacheImageType = typename Superclass::CacheImageType;
  using DomainMapImageFilterType = typename Superclass::DomainMapImageFilterType;

  using StoppingCriterionType = typename Superclass::StoppingCriterionType;
  using StoppingCriterionPointer = typename Superclass::StoppingCriterionPointer;

  using InputImageConstIteratorType = ImageRegionConstIteratorWithIndex< InputImageType >;

  using UpdateLevelSetFilterType = UpdateShiSparseLevelSet< ImageDimension, EquationContainerType >;
  using UpdateLevelSetFilterPointer = typename UpdateLevelSetFilterType::Pointer;

  LevelSetEvolution() = default;
  ~LevelSetEvolution() override = default;

protected:

  void UpdateLevelSets() override;

  void UpdateEquations() override;
};

// Malcolm
template< typename TEquationContainer, unsigned int VDimension >
class ITK_TEMPLATE_EXPORT LevelSetEvolution< TEquationContainer,
    MalcolmSparseLevelSetImage< VDimension > > :
public LevelSetEvolutionBase< TEquationContainer, MalcolmSparseLevelSetImage< VDimension > >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(LevelSetEvolution);

  using LevelSetType = MalcolmSparseLevelSetImage< VDimension >;

  using Self = LevelSetEvolution;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using Superclass = LevelSetEvolutionBase< TEquationContainer, LevelSetType >;

  itkNewMacro( Self );

  itkTypeMacro( LevelSetEvolution, LevelSetEvolutionBase );

  using EquationContainerType = typename Superclass::EquationContainerType;
  using EquationContainerPointer = typename Superclass::EquationContainerPointer;
  using TermContainerType = typename Superclass::TermContainerType;
  using TermContainerPointer = typename Superclass::TermContainerPointer;

  using TermType = typename Superclass::TermType;
  using TermPointer = typename Superclass::TermPointer;

  using InputImageType = typename Superclass::InputImageType;
  using InputImagePixelType = typename Superclass::InputImagePixelType;
  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
  using InputImageRegionType = typename Superclass::InputImageRegionType;
  using InputPixelRealType = typename Superclass::InputPixelRealType;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using LevelSetContainerType = typename Superclass::LevelSetContainerType;
  using LevelSetIdentifierType = typename Superclass::LevelSetIdentifierType;

  using LevelSetInputType = typename Superclass::LevelSetInputType;
  using LevelSetOutputType = typename Superclass::LevelSetOutputType;
  using LevelSetOutputRealType = typename Superclass::LevelSetOutputRealType;
  using LevelSetDataType = typename Superclass::LevelSetDataType;

  using LevelSetLayerType = typename LevelSetType::LayerType;
  using LevelSetLayerIterator = typename LevelSetType::LayerIterator;

  using LevelSetLabelMapType = typename LevelSetType::LabelMapType;
  using LevelSetLabelMapPointer = typename LevelSetType::LabelMapPointer;


  using IdListType = typename Superclass::IdListType;
  using IdListIterator = typename Superclass::IdListIterator;
  using IdListImageType = typename Superclass::IdListImageType;
  using CacheImageType = typename Superclass::CacheImageType;
  using DomainMapImageFilterType = typename Superclass::DomainMapImageFilterType;

  using StoppingCriterionType = typename Superclass::StoppingCriterionType;
  using StoppingCriterionPointer = typename Superclass::StoppingCriterionPointer;

  using InputImageConstIteratorType = ImageRegionConstIteratorWithIndex< InputImageType >;

  using UpdateLevelSetFilterType = UpdateMalcolmSparseLevelSet< ImageDimension, EquationContainerType >;
  using UpdateLevelSetFilterPointer = typename UpdateLevelSetFilterType::Pointer;

  LevelSetEvolution() = default;
  ~LevelSetEvolution() override = default;

protected:
  void UpdateLevelSets() override;
  void UpdateEquations() override;
};
}

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkLevelSetEvolution.hxx"
#endif

#endif // itkLevelSetEvolution_h