otbStreamingHistogramVectorImageFilter.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 otbStreamingHistogramVectorImageFilter_h
#define otbStreamingHistogramVectorImageFilter_h
 
#include "otbPersistentImageFilter.h"
#include "otbPersistentFilterStreamingDecorator.h"
 
#include "otbObjectList.h"
#include "itkStatisticsAlgorithm.h"
#include "itkNumericTraits.h"
#include "itkHistogram.h"
 
namespace otb
{
 
template <class TInputImage>
class ITK_EXPORT PersistentHistogramVectorImageFilter : public PersistentImageFilter<TInputImage, TInputImage>
{
public:
  typedef PersistentHistogramVectorImageFilter Self;
  typedef PersistentImageFilter<TInputImage, TInputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PersistentHistogramVectorImageFilter, PersistentImageFilter);
 
  typedef TInputImage                             ImageType;
  typedef typename TInputImage::Pointer           InputImagePointer;
  typedef typename TInputImage::RegionType        RegionType;
  typedef typename TInputImage::SizeType          SizeType;
  typedef typename TInputImage::IndexType         IndexType;
  typedef typename TInputImage::PixelType         PixelType;
  typedef typename TInputImage::InternalPixelType InternalPixelType;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, TInputImage::ImageDimension);
 
  itkStaticConstMacro(ImageDimension, unsigned int, TInputImage::ImageDimension);
 
  typedef typename itk::NumericTraits<InternalPixelType>::RealType RealType;
  typedef itk::VariableLengthVector<RealType>                      RealPixelType;
 
  typedef typename itk::DataObject::Pointer                  DataObjectPointer;
  typedef itk::ProcessObject::DataObjectPointerArraySizeType DataObjectPointerArraySizeType;
 
  typedef itk::Statistics::DenseFrequencyContainer2 DFContainerType;
 
  typedef typename itk::NumericTraits<InternalPixelType>::RealType HistogramMeasurementRealType;
 
  typedef itk::Statistics::Histogram<HistogramMeasurementRealType, DFContainerType> HistogramType;
 
  typedef itk::VariableLengthVector<unsigned int> CountVectorType;
 
  typedef PixelType                                      MeasurementVectorType;
  typedef ObjectList<HistogramType>                      HistogramListType;
  typedef typename HistogramListType::Pointer            HistogramListPointerType;
  typedef typename std::vector<HistogramListPointerType> ArrayHistogramListType;
 
 
  itkSetMacro(NoDataValue, InternalPixelType);
 
  itkGetConstReferenceMacro(NoDataValue, InternalPixelType);
 
  itkSetMacro(NoDataFlag, bool);
 
  itkGetMacro(NoDataFlag, bool);
 
  itkBooleanMacro(NoDataFlag);
 
  inline void SetNumberOfBins(unsigned int i, CountVectorType::ValueType size)
  {
    m_Size[i] = size;
  }
 
  inline void SetNumberOfBins(const CountVectorType& size)
  {
    m_Size = size;
  }
 
  HistogramListType*       GetHistogramListOutput();
  const HistogramListType* GetHistogramListOutput() const;
 
  itkGetConstReferenceMacro(HistogramMin, MeasurementVectorType);
 
  itkSetMacro(HistogramMin, MeasurementVectorType);
 
  itkGetConstReferenceMacro(HistogramMax, MeasurementVectorType);
 
  itkSetMacro(HistogramMax, MeasurementVectorType);
 
  itkSetMacro(SubSamplingRate, unsigned int);
 
  itkGetMacro(SubSamplingRate, unsigned int);
 
  DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) override;
  using Superclass::MakeOutput;
 
  void AllocateOutputs() override;
  void GenerateOutputInformation() override;
  void Synthetize(void) override;
  void Reset(void) override;
 
protected:
  PersistentHistogramVectorImageFilter();
  ~PersistentHistogramVectorImageFilter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
  void ThreadedGenerateData(const RegionType& outputRegionForThread, itk::ThreadIdType threadId) override;
 
private:
  PersistentHistogramVectorImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  ArrayHistogramListType m_ThreadHistogramList;
  CountVectorType        m_Size;
  MeasurementVectorType  m_HistogramMin;
  MeasurementVectorType  m_HistogramMax;
  bool                   m_NoDataFlag;
  InternalPixelType      m_NoDataValue;
 
  unsigned int m_SubSamplingRate;
 
}; // end of class PersistentStatisticsVectorImageFilter
 
template <class TInputImage>
class ITK_EXPORT StreamingHistogramVectorImageFilter : public PersistentFilterStreamingDecorator<PersistentHistogramVectorImageFilter<TInputImage>>
{
public:
  typedef StreamingHistogramVectorImageFilter                                                   Self;
  typedef PersistentFilterStreamingDecorator<PersistentHistogramVectorImageFilter<TInputImage>> Superclass;
  typedef itk::SmartPointer<Self>                                                               Pointer;
  typedef itk::SmartPointer<const Self>                                                         ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingHistogramVectorImageFilter, PersistentFilterStreamingDecorator);
 
  typedef TInputImage                     InputImageType;
  typedef typename Superclass::FilterType InternalFilterType;
 
  typedef typename InternalFilterType::HistogramType     HistogramType;
  typedef typename InternalFilterType::HistogramListType HistogramListType;
 
  using Superclass::SetInput;
  void SetInput(InputImageType* input)
  {
    this->GetFilter()->SetInput(input);
  }
  const InputImageType* GetInput()
  {
    return this->GetFilter()->GetInput();
  }
 
  HistogramListType* GetHistogramList()
  {
    return this->GetFilter()->GetHistogramListOutput();
  }
 
 
protected:
  StreamingHistogramVectorImageFilter(){};
 
  ~StreamingHistogramVectorImageFilter() override
  {
  }
 
private:
  StreamingHistogramVectorImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingHistogramVectorImageFilter.hxx"
#endif
 
#endif