otbLabelImageSmallRegionMergingFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbLabelImageSmallRegionMergingFilter_h
#define otbLabelImageSmallRegionMergingFilter_h
 
#include "otbPersistentImageFilter.h"
#include "otbPersistentFilterStreamingDecorator.h"
 
#include <unordered_map>
 
namespace otb
{
 
template <class TInputLabelImage>
class ITK_EXPORT PersistentLabelImageSmallRegionMergingFilter : public PersistentImageFilter<TInputLabelImage, TInputLabelImage>
{
public:
  typedef PersistentLabelImageSmallRegionMergingFilter Self;
  typedef PersistentImageFilter<TInputLabelImage, TInputLabelImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkTypeMacro(PersistentLabelImageSmallRegionMergingFilter, PersistentImageFilter);
  itkNewMacro(Self);
 
  typedef TInputLabelImage                    InputImageType;
  typedef typename InputImageType::Pointer    InputImagePointerType;
  typedef typename InputImageType::PixelType  InputLabelType;
  typedef typename InputImageType::SizeType   InputSizeType;
  typedef typename InputImageType::PointType  PointType;
  typedef typename InputImageType::RegionType RegionType;
 
  typedef itk::VariableLengthVector<double> RealVectorPixelType;
 
  typedef std::unordered_map<InputLabelType, std::set<InputLabelType>> NeighboursMapType;
 
  typedef std::unordered_map<InputLabelType, RealVectorPixelType> LabelStatisticType;
  typedef std::unordered_map<InputLabelType, double>              LabelPopulationType;
  typedef std::unordered_map<InputLabelType, InputLabelType>      LUTType;
 
  itkGetMacro(Size, unsigned int);
  itkSetMacro(Size, unsigned int);
 
  void SetLabelPopulation(LabelPopulationType const& labelPopulation);
 
  LabelPopulationType const& GetLabelPopulation() const;
 
  void SetLabelStatistic(LabelStatisticType const& labelStatistic);
 
  LabelStatisticType const& GetLabelStatistic() const;
 
  LUTType const& GetLUT() const;
 
  virtual void Reset(void) override;
  virtual void Synthetize(void) override;
 
protected:
  void GenerateInputRequestedRegion() override;
 
  void ThreadedGenerateData(const RegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
 
 
  InputLabelType FindCorrespondingLabel(InputLabelType label);
 
  PersistentLabelImageSmallRegionMergingFilter();
 
  ~PersistentLabelImageSmallRegionMergingFilter() override = default;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  PersistentLabelImageSmallRegionMergingFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  unsigned int m_Size;
 
  LabelPopulationType m_LabelPopulation;
 
  LabelStatisticType m_LabelStatistic;
 
  std::vector<NeighboursMapType> m_NeighboursMapsTmp;
 
  LUTType m_LUT;
};
 
template <class TInputLabelImage>
class ITK_EXPORT LabelImageSmallRegionMergingFilter : public itk::ProcessObject
{
public:
  typedef LabelImageSmallRegionMergingFilter Self;
  typedef itk::ProcessObject                 Superclass;
  typedef itk::SmartPointer<Self>            Pointer;
  typedef itk::SmartPointer<const Self>      ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(LabelImageSmallRegionMergingFilter, itk::ProcessObject);
 
  // Small region merging filter typedefs
  typedef PersistentLabelImageSmallRegionMergingFilter<TInputLabelImage>                       PersistentLabelImageSmallRegionMergingFilterType;
  typedef PersistentFilterStreamingDecorator<PersistentLabelImageSmallRegionMergingFilterType> LabelImageSmallRegionMergingFilterType;
 
  typedef typename PersistentLabelImageSmallRegionMergingFilterType::LabelPopulationType LabelPopulationType;
 
  typedef typename PersistentLabelImageSmallRegionMergingFilterType::LabelStatisticType LabelStatisticType;
 
  typedef typename PersistentLabelImageSmallRegionMergingFilterType::LUTType LUTType;
 
 
  itkGetMacro(MinSize, unsigned int);
  itkSetMacro(MinSize, unsigned int);
 
  void SetInputLabelImage(const TInputLabelImage* labelImage);
 
  void SetLabelPopulation(LabelPopulationType const& labelPopulation);
 
  LabelPopulationType const& GetLabelPopulation() const;
 
  void SetLabelStatistic(LabelStatisticType const& labelStatistic);
 
  LabelStatisticType const& GetLabelStatistic() const;
 
  LUTType const& GetLUT() const;
 
  void Update() override;
 
protected:
  LabelImageSmallRegionMergingFilter();
 
  ~LabelImageSmallRegionMergingFilter() override = default;
 
  void GenerateData() override;
 
private:
  LabelImageSmallRegionMergingFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  // Filter used recursively to build the equivalence table
  typename LabelImageSmallRegionMergingFilterType::Pointer m_SmallRegionMergingFilter;
 
  // All segments with size < m_MinSize will be merged to bigger segments.
  unsigned int m_MinSize;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbLabelImageSmallRegionMergingFilter.hxx"
#endif
 
#endif