otbStreamingStatisticsMapFromLabelImageFilter.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * 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 otbStreamingStatisticsMapFromLabelImageFilter_h
#define otbStreamingStatisticsMapFromLabelImageFilter_h
 
#include "otbPersistentImageFilter.h"
#include "itkNumericTraits.h"
#include "itkArray.h"
#include "itkSimpleDataObjectDecorator.h"
#include "otbPersistentFilterStreamingDecorator.h"
#include <unordered_map>
 
namespace otb
{
 
template <class TRealVectorPixelType>
class StatisticsAccumulator
{
public:
  using RealValueType        = typename TRealVectorPixelType::ValueType;
  using PixelCountType       = std::uint64_t;
  using PixelCountVectorType = itk::VariableLengthVector<PixelCountType>;
 
  // Constructor (default)
  StatisticsAccumulator() : m_Count(), m_NoDataValue(), m_UseNoDataValue()
  {
  }
 
  // Constructor (initialize the accumulator with the given pixel)
  StatisticsAccumulator(RealValueType noDataValue, bool useNoDataValue, const TRealVectorPixelType& pixel)
    : m_NoDataValue(noDataValue), m_Count(1), m_UseNoDataValue(useNoDataValue)
  {
    m_Count = 1;
    m_BandCount.SetSize(pixel.GetSize());
    m_Sum.SetSize(pixel.GetSize());
    m_Min.SetSize(pixel.GetSize());
    m_Max.SetSize(pixel.GetSize());
    m_SqSum.SetSize(pixel.GetSize());
    for (unsigned int band = 0; band < pixel.GetSize(); band++)
    {
      auto val = pixel[band];
      if (!m_UseNoDataValue || val != m_NoDataValue)
      {
        m_BandCount[band] = 1;
        m_Sum[band]       = val;
        m_Min[band]       = val;
        m_Max[band]       = val;
        m_SqSum[band]     = val * val;
      }
      else
      {
        m_BandCount[band] = 0;
        m_Sum[band]       = itk::NumericTraits<RealValueType>::ZeroValue();
        m_Min[band]       = itk::NumericTraits<RealValueType>::max();
        m_Max[band]       = itk::NumericTraits<RealValueType>::min();
        m_SqSum[band]     = itk::NumericTraits<RealValueType>::ZeroValue();
      }
    }
  }
 
  // Function update (pixel)
  void Update(const TRealVectorPixelType& pixel)
  {
    m_Count++;
    const unsigned int nBands = pixel.GetSize();
    for (unsigned int band = 0; band < nBands; band++)
    {
      const RealValueType value   = pixel[band];
      const RealValueType sqValue = value * value;
 
      if (!m_UseNoDataValue || value != m_NoDataValue)
      {
        UpdateValues(1, value, sqValue, value, value, m_BandCount[band], m_Sum[band], m_SqSum[band], m_Min[band], m_Max[band]);
      }
    }
  }
 
  // Function update (self)
  void Update(const StatisticsAccumulator& other)
  {
    m_Count += other.m_Count;
    const unsigned int nBands = other.m_Sum.GetSize();
    for (unsigned int band = 0; band < nBands; band++)
    {
      UpdateValues(other.m_BandCount[band], other.m_Sum[band], other.m_SqSum[band], other.m_Min[band], other.m_Max[band], m_BandCount[band], m_Sum[band],
                   m_SqSum[band], m_Min[band], m_Max[band]);
    }
  }
 
  // Accessors
  itkGetMacro(BandCount, PixelCountVectorType);
  itkGetMacro(Sum, TRealVectorPixelType);
  itkGetMacro(SqSum, TRealVectorPixelType);
  itkGetMacro(Min, TRealVectorPixelType);
  itkGetMacro(Max, TRealVectorPixelType);
  itkGetMacro(Count, double);
 
private:
  void UpdateValues(PixelCountType otherCount, RealValueType otherSum, RealValueType otherSqSum, RealValueType otherMin, RealValueType otherMax,
                    PixelCountType& count, RealValueType& sum, RealValueType& sqSum, RealValueType& min, RealValueType& max)
  {
    count += otherCount;
    sum += otherSum;
    sqSum += otherSqSum;
    if (otherMin < min)
      min = otherMin;
    if (otherMax > max)
      max = otherMax;
  }
 
protected:
  PixelCountVectorType m_BandCount;
  TRealVectorPixelType m_Sum;
  TRealVectorPixelType m_SqSum;
  TRealVectorPixelType m_Min;
  TRealVectorPixelType m_Max;
  RealValueType        m_NoDataValue;
  PixelCountType       m_Count;
  bool                 m_UseNoDataValue;
};
 
template <class TInputVectorImage, class TLabelImage>
class ITK_EXPORT PersistentStreamingStatisticsMapFromLabelImageFilter : public PersistentImageFilter<TInputVectorImage, TInputVectorImage>
{
public:
  typedef PersistentStreamingStatisticsMapFromLabelImageFilter        Self;
  typedef PersistentImageFilter<TInputVectorImage, TInputVectorImage> Superclass;
  typedef itk::SmartPointer<Self>                                     Pointer;
  typedef itk::SmartPointer<const Self>                               ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PersistentStreamingStatisticsMapFromLabelImageFilter, PersistentImageFilter);
 
  typedef TInputVectorImage                   VectorImageType;
  typedef typename TInputVectorImage::Pointer InputVectorImagePointer;
  typedef TLabelImage                         LabelImageType;
  typedef typename TLabelImage::Pointer       LabelImagePointer;
 
  typedef typename VectorImageType::RegionType                    RegionType;
  typedef typename VectorImageType::PixelType                     VectorPixelType;
  typedef typename VectorImageType::PixelType::ValueType          VectorPixelValueType;
  typedef typename LabelImageType::PixelType                      LabelPixelType;
  typedef itk::VariableLengthVector<double>                       RealVectorPixelType;
  typedef StatisticsAccumulator<RealVectorPixelType>              AccumulatorType;
  typedef std::unordered_map<LabelPixelType, AccumulatorType>     AccumulatorMapType;
  typedef std::vector<AccumulatorMapType>                         AccumulatorMapCollectionType;
  typedef std::unordered_map<LabelPixelType, RealVectorPixelType> PixelValueMapType;
  typedef std::unordered_map<LabelPixelType, double>              LabelPopulationMapType;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, TInputVectorImage::ImageDimension);
 
  itkStaticConstMacro(ImageDimension, unsigned int, TInputVectorImage::ImageDimension);
 
  itkGetMacro(NoDataValue, VectorPixelValueType);
  itkSetMacro(NoDataValue, VectorPixelValueType);
  itkGetMacro(UseNoDataValue, bool);
  itkSetMacro(UseNoDataValue, bool);
 
  typedef typename itk::DataObject::Pointer                  DataObjectPointer;
  typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
 
  typedef itk::ImageBase<InputImageDimension> ImageBaseType;
  typedef typename ImageBaseType::RegionType  InputImageRegionType;
 
  typedef itk::SimpleDataObjectDecorator<PixelValueMapType> PixelValueMapObjectType;
 
  virtual void SetInputLabelImage(const LabelImageType* image);
 
  virtual const LabelImageType* GetInputLabelImage();
 
  PixelValueMapType GetMeanValueMap() const;
 
  PixelValueMapType GetStandardDeviationValueMap() const;
 
  PixelValueMapType GetMinValueMap() const;
 
  PixelValueMapType GetMaxValueMap() const;
 
  LabelPopulationMapType GetLabelPopulationMap() const;
 
  DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) override;
  using Superclass::MakeOutput;
 
  void AllocateOutputs() override;
 
  void GenerateOutputInformation() override;
 
  void Synthetize(void) override;
 
  void Reset(void) override;
 
  void GenerateInputRequestedRegion() override;
 
protected:
  PersistentStreamingStatisticsMapFromLabelImageFilter();
  ~PersistentStreamingStatisticsMapFromLabelImageFilter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void ThreadedGenerateData(const RegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
 
private:
  PersistentStreamingStatisticsMapFromLabelImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  VectorPixelValueType m_NoDataValue;
  bool                 m_UseNoDataValue;
 
  AccumulatorMapCollectionType m_AccumulatorMaps;
 
  PixelValueMapType m_MeanRadiometricValue;
  PixelValueMapType m_StDevRadiometricValue;
  PixelValueMapType m_MinRadiometricValue;
  PixelValueMapType m_MaxRadiometricValue;
 
  LabelPopulationMapType m_LabelPopulation;
 
}; // end of class PersistentStreamingStatisticsMapFromLabelImageFilter
 
 
/*===========================================================================*/
 
template <class TInputVectorImage, class TLabelImage>
class ITK_EXPORT StreamingStatisticsMapFromLabelImageFilter
  : public PersistentFilterStreamingDecorator<PersistentStreamingStatisticsMapFromLabelImageFilter<TInputVectorImage, TLabelImage>>
{
public:
  typedef StreamingStatisticsMapFromLabelImageFilter                                                                               Self;
  typedef PersistentFilterStreamingDecorator<PersistentStreamingStatisticsMapFromLabelImageFilter<TInputVectorImage, TLabelImage>> Superclass;
  typedef itk::SmartPointer<Self>                                                                                                  Pointer;
  typedef itk::SmartPointer<const Self>                                                                                            ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingStatisticsMapFromLabelImageFilter, PersistentFilterStreamingDecorator);
 
  typedef TInputVectorImage VectorImageType;
  typedef TLabelImage       LabelImageType;
 
  typedef typename VectorImageType::PixelType            VectorPixelType;
  typedef typename VectorImageType::PixelType::ValueType VectorPixelValueType;
 
  typedef typename Superclass::FilterType::PixelValueMapType       PixelValueMapType;
  typedef typename Superclass::FilterType::PixelValueMapObjectType PixelValueMapObjectType;
 
  typedef typename Superclass::FilterType::LabelPopulationMapType LabelPopulationMapType;
 
  using Superclass::SetInput;
  void SetInput(const VectorImageType* input)
  {
    this->GetFilter()->SetInput(input);
  }
 
  const VectorImageType* GetInput()
  {
    return this->GetFilter()->GetInput();
  }
 
  void SetInputLabelImage(const LabelImageType* input)
  {
    this->GetFilter()->SetInputLabelImage(input);
  }
 
  const LabelImageType* GetInputLabelImage()
  {
    return this->GetFilter()->GetInputLabelImage();
  }
 
  PixelValueMapType GetMeanValueMap() const
  {
    return this->GetFilter()->GetMeanValueMap();
  }
 
  PixelValueMapType GetStandardDeviationValueMap() const
  {
    return this->GetFilter()->GetStandardDeviationValueMap();
  }
 
  PixelValueMapType GetMinValueMap() const
  {
    return this->GetFilter()->GetMinValueMap();
  }
 
  PixelValueMapType GetMaxValueMap() const
  {
    return this->GetFilter()->GetMaxValueMap();
  }
 
  LabelPopulationMapType GetLabelPopulationMap() const
  {
    return this->GetFilter()->GetLabelPopulationMap();
  }
 
  void SetNoDataValue(VectorPixelValueType value)
  {
    this->GetFilter()->SetNoDataValue(value);
  }
 
  VectorPixelValueType GetNoDataValue() const
  {
    return this->GetFilter()->GetNoDataValue();
  }
 
  void SetUseNoDataValue(bool useNoDataValue)
  {
    this->GetFilter()->SetUseNoDataValue(useNoDataValue);
  }
 
  bool GetUseNoDataValue() const
  {
    return this->GetFilter()->GetUseNoDataValue();
  }
 
protected:
  StreamingStatisticsMapFromLabelImageFilter()
  {
  }
 
  ~StreamingStatisticsMapFromLabelImageFilter() override
  {
  }
 
private:
  StreamingStatisticsMapFromLabelImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingStatisticsMapFromLabelImageFilter.hxx"
#endif
 
#endif