otbLabelImageRegionPruningFilter.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 otbLabelImageRegionPruningFilter_h
#define otbLabelImageRegionPruningFilter_h
 
#include "otbImage.h"
#include "otbVectorImage.h"
#include "itkImageToImageFilter.h"
#include "itkNumericTraits.h"
 
#include <set>
 
namespace otb
{
 
template <class TInputLabelImage, class TInputSpectralImage, class TOutputLabelImage = TInputLabelImage, class TOutputClusteredImage = TInputSpectralImage>
class ITK_EXPORT LabelImageRegionPruningFilter : public itk::ImageToImageFilter<TInputLabelImage, TOutputLabelImage>
{
public:
  typedef LabelImageRegionPruningFilter Self;
  typedef itk::ImageToImageFilter<TInputLabelImage, TOutputLabelImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
  typedef double                        RealType;
 
  itkTypeMacro(LabelImageRegionPruningFilter, ImageToImageFilter);
  itkNewMacro(Self);
 
  typedef TInputLabelImage                        InputLabelImageType;
  typedef typename InputLabelImageType::PixelType InputLabelType;
 
  typedef TInputLabelImage                        InputImageType;
  typedef typename InputImageType::Pointer        InputImagePointerType;
  typedef typename InputImageType::PixelType      InputPixelType;
  typedef typename InputImageType::IndexType      InputIndexType;
  typedef typename InputImageType::SizeType       InputSizeType;
  typedef typename InputImageType::IndexValueType InputIndexValueType;
  typedef typename InputImageType::PointType      PointType;
  typedef typename InputImageType::RegionType     RegionType;
  typedef typename InputImageType::SizeType       SizeType;
 
  typedef TInputSpectralImage                     InputSpectralImageType;
  typedef typename TInputSpectralImage::PixelType SpectralPixelType;
 
  typedef TOutputLabelImage                        OutputLabelImageType;
  typedef typename OutputLabelImageType::PixelType OutputLabelType;
 
  typedef TOutputLabelImage                    OutputImageType;
  typedef typename OutputImageType::Pointer    OutputImagePointerType;
  typedef typename OutputImageType::PixelType  OutputPixelType;
  typedef typename OutputImageType::RegionType OutputRegionType;
 
  typedef TOutputClusteredImage OutputClusteredImageType;
 
  itkStaticConstMacro(ImageDimension, unsigned int, InputLabelImageType::ImageDimension);
 
  typedef InputLabelType                           LabelType;
  typedef std::set<LabelType>                      AdjacentLabelsContainerType;
  typedef std::vector<AdjacentLabelsContainerType> RegionAdjacencyMapType;
 
  itkSetMacro(MinRegionSize, RealType);
  itkGetConstMacro(MinRegionSize, RealType);
 
  const OutputLabelImageType* GetLabelOutput() const;
 
  OutputLabelImageType* GetLabelOutput();
 
  const OutputClusteredImageType* GetClusteredOutput() const;
 
  OutputClusteredImageType* GetClusteredOutput();
 
  void SetInputLabelImage(const InputLabelImageType* labelImage);
 
  void SetInputSpectralImage(const InputSpectralImageType* spectralImage);
 
  InputLabelImageType* GetInputLabelImage();
 
  InputSpectralImageType* GetInputSpectralImage();
 
protected:
  void EnlargeOutputRequestedRegion(itk::DataObject* output) override;
 
  void GenerateOutputInformation(void) override;
 
  void GenerateData() override;
 
  LabelImageRegionPruningFilter();
 
  ~LabelImageRegionPruningFilter() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  RegionAdjacencyMapType LabelImageToRegionAdjacencyMap(typename OutputLabelImageType::Pointer inputLabelImage);
 
private:
  LabelImageRegionPruningFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  unsigned int m_NumberOfComponentsPerPixel;
  unsigned int m_MinRegionSize;
 
  std::vector<LabelType> m_CanonicalLabels;
 
  std::vector<SpectralPixelType> m_Modes;
 
  std::vector<unsigned int> m_PointCounts;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbLabelImageRegionPruningFilter.hxx"
#endif
 
#endif