itkLevelSetSparseImage.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 itkLevelSetSparseImage_h
#define itkLevelSetSparseImage_h
 
#include "itkDiscreteLevelSetImage.h"
#include "itkObjectFactory.h"
 
#include "itkLabelObject.h"
#include "itkLabelMap.h"
#include "itkLexicographicCompare.h"
 
namespace itk
{

template <typename TOutput, unsigned int VDimension>
class ITK_TEMPLATE_EXPORT LevelSetSparseImage : public DiscreteLevelSetImage<TOutput, VDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(LevelSetSparseImage);
 
  using Self = LevelSetSparseImage;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using Superclass = DiscreteLevelSetImage<TOutput, VDimension>;

  itkOverrideGetNameOfClassMacro(LevelSetSparseImage);
 
  static constexpr unsigned int Dimension = Superclass::Dimension;
 
  using typename Superclass::InputType;
  using typename Superclass::OutputType;
  using typename Superclass::OutputRealType;
  using typename Superclass::GradientType;
  using typename Superclass::HessianType;
  using typename Superclass::LevelSetDataType;
 
  using LayerIdType = int8_t;
  using LayerIdListType = std::list<LayerIdType>;
 
  using LabelObjectType = LabelObject<LayerIdType, VDimension>;
  using LabelObjectPointer = typename LabelObjectType::Pointer;
  using LabelObjectLengthType = typename LabelObjectType::LengthType;
  using LabelObjectLineType = typename LabelObjectType::LineType;
 
  using LabelMapType = LabelMap<LabelObjectType>;
  using LabelMapPointer = typename LabelMapType::Pointer;
  using LabelMapConstPointer = typename LabelMapType::ConstPointer;
  using RegionType = typename LabelMapType::RegionType;
 
  using LayerType = std::map<InputType, OutputType, Functor::LexicographicCompare>;
  using LayerIterator = typename LayerType::iterator;
  using LayerConstIterator = typename LayerType::const_iterator;
 
  using LayerMapType = std::map<LayerIdType, LayerType>;
  using LayerMapIterator = typename LayerMapType::iterator;
  using LayerMapConstIterator = typename LayerMapType::const_iterator;

  virtual LayerIdType
  Status(const InputType & inputIndex) const;

  const LayerType &
  GetLayer(LayerIdType value) const;

  LayerType &
  GetLayer(LayerIdType value);

  void
  SetLayer(LayerIdType value, const LayerType & layer);

  virtual void
  SetLabelMap(LabelMapType * labelMap);
  itkGetModifiableObjectMacro(LabelMap, LabelMapType);

  void
  Graft(const DataObject * data) override;

  template <typename TLabel>
  typename LabelObject<TLabel, VDimension>::Pointer
  GetAsLabelObject();
 
protected:
  LevelSetSparseImage() = default;
  ~LevelSetSparseImage() override = default;
 
  LayerMapType    m_Layers{};
  LabelMapPointer m_LabelMap{};
  LayerIdListType m_InternalLabelList{};

  virtual void
  InitializeLayers() = 0;
 
  virtual void
  InitializeInternalLabelList() = 0;
 
  bool
  IsInsideDomain(const InputType & inputIndex) const override;

  void
  Initialize() override;

  void
  CopyInformation(const DataObject * data) override;
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkLevelSetSparseImage.hxx"
#endif
 
#endif // itkLevelSetSparseImage_h