otbStreamingShrinkImageFilter.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 otbStreamingShrinkImageFilter_h
#define otbStreamingShrinkImageFilter_h
 
#include "otbPersistentImageFilter.h"
#include "otbPersistentFilterStreamingDecorator.h"
#include "OTBImageManipulationExport.h"
#include "otbStreamingManager.h"
#include "otbMacro.h"
 
namespace otb
{
 
class OTBImageManipulation_EXPORT StreamingShrinkImageRegionSplitter : public itk::ImageRegionSplitter<2>
{
public:
  typedef StreamingShrinkImageRegionSplitter Self;
  typedef itk::ImageRegionSplitter<2>        Superclass;
  typedef itk::SmartPointer<Self>            Pointer;
  typedef itk::SmartPointer<const Self>      ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingShrinkImageRegionSplitter, itk::Object);
 
  itkStaticConstMacro(ImageDimension, unsigned int, 2);
 
  static unsigned int GetImageDimension()
  {
    return ImageDimension;
  }
 
  typedef itk::Index<ImageDimension> IndexType;
  typedef IndexType::IndexValueType  IndexValueType;
 
  typedef itk::Size<ImageDimension> SizeType;
  typedef SizeType::SizeValueType   SizeValueType;
 
  typedef itk::ImageRegion<ImageDimension> RegionType;
 
  unsigned int GetNumberOfSplits(const RegionType& region, unsigned int requestedNumber) override;
 
  RegionType GetSplit(unsigned int i, unsigned int numberOfPieces, const RegionType& region) override;
 
  itkGetMacro(TileSizeAlignment, unsigned int);
 
  itkGetMacro(TileDimension, unsigned int);
 
  itkSetMacro(ShrinkFactor, unsigned int);
  itkGetMacro(ShrinkFactor, unsigned int);
 
protected:
  StreamingShrinkImageRegionSplitter() : m_SplitsPerDimension(0U), m_TileDimension(0), m_TileSizeAlignment(0), m_ShrinkFactor(10)
  {
  }
  ~StreamingShrinkImageRegionSplitter() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  StreamingShrinkImageRegionSplitter(const StreamingShrinkImageRegionSplitter&) = delete;
  void operator=(const StreamingShrinkImageRegionSplitter&) = delete;
 
  itk::FixedArray<unsigned int, ImageDimension> m_SplitsPerDimension;
  unsigned int m_TileDimension;
  unsigned int m_TileSizeAlignment;
  unsigned int m_ShrinkFactor;
};
 
 
template <class TInputImage>
class ITK_EXPORT StreamingShrinkStreamingManager : public StreamingManager<TInputImage>
{
public:
  typedef StreamingShrinkStreamingManager Self;
  typedef StreamingManager<TInputImage>   Superclass;
  typedef itk::SmartPointer<Self>         Pointer;
  typedef itk::SmartPointer<const Self>   ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingShrinkStreamingManager, StreamingManager);
 
  typedef TInputImage                           ImageType;
  typedef typename ImageType::Pointer           ImagePointerType;
  typedef typename ImageType::RegionType        RegionType;
  typedef typename RegionType::IndexType        IndexType;
  typedef typename RegionType::SizeType         SizeType;
  typedef typename ImageType::InternalPixelType PixelType;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, TInputImage::ImageDimension);
 
  void PrepareStreaming(itk::DataObject* input, const RegionType& region) override;
 
  void SetShrinkFactor(unsigned int val)
  {
    m_ShrinkFactor = val;
  }
 
  unsigned int GetShrinkFactor() const
  {
    return m_ShrinkFactor;
  }
 
protected:
  StreamingShrinkStreamingManager();
  ~StreamingShrinkStreamingManager() override;
 
private:
  StreamingShrinkStreamingManager(const StreamingShrinkStreamingManager&) = delete;
  void operator=(const StreamingShrinkStreamingManager&) = delete;
 
  unsigned int m_ShrinkFactor;
};
 
 
template <class TInputImage, class TOutputImage = TInputImage>
class ITK_EXPORT PersistentShrinkImageFilter : public PersistentImageFilter<TInputImage, TOutputImage>
{
public:
  typedef PersistentShrinkImageFilter Self;
  typedef PersistentImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(PersistentShrinkImageFilter, PersistentImageFilter);
 
  typedef TInputImage                      InputImageType;
  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 TOutputImage                   OutputImageType;
  typedef typename TOutputImage::Pointer OutputImagePointer;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, TInputImage::ImageDimension);
 
  typedef typename itk::DataObject::Pointer DataObjectPointer;
 
  OutputImageType* GetShrunkOutput()
  {
    return m_ShrunkOutput;
  }
 
  void Synthetize(void) override;
 
  void Reset(void) override;
 
  itkSetMacro(ShrinkFactor, unsigned int);
  itkGetMacro(ShrinkFactor, unsigned int);
 
protected:
  PersistentShrinkImageFilter();
 
  ~PersistentShrinkImageFilter() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void BeforeThreadedGenerateData() override;
 
  void DynamicThreadedGenerateData(const RegionType& outputRegionForThread) override;
 
  void AfterThreadedGenerateData() override;
 
  void AllocateOutputs() override;
 
  void GenerateOutputInformation() override;
 
 
private:
  PersistentShrinkImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  /* the output shrunk image */
  OutputImagePointer m_ShrunkOutput;
 
  unsigned int m_ShrinkFactor;
 
  IndexType m_Offset;
}; // end of class PersistentStatisticsVectorImageFilter
 
 
template <class TInputImage, class TOutputImage = TInputImage>
class ITK_EXPORT StreamingShrinkImageFilter : public PersistentFilterStreamingDecorator<PersistentShrinkImageFilter<TInputImage, TOutputImage>>
{
public:
  typedef StreamingShrinkImageFilter Self;
  typedef PersistentFilterStreamingDecorator<PersistentShrinkImageFilter<TInputImage, TOutputImage>> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingShrinkImageFilter, PersistentFilterStreamingDecorator);
 
  typedef TInputImage                     InputImageType;
  typedef TOutputImage                    OutputImageType;
  typedef typename Superclass::FilterType PersistentFilterType;
 
  typedef StreamingShrinkStreamingManager<InputImageType>       StreamingShrinkStreamingManagerType;
  typedef typename StreamingShrinkStreamingManagerType::Pointer StreamingShrinkStreamingManagerPointerType;
 
  using Superclass::SetInput;
  void SetInput(InputImageType* input)
  {
    this->GetFilter()->SetInput(input);
  }
 
  const InputImageType* GetInput()
  {
    return this->GetFilter()->GetInput();
  }
 
  OutputImageType* GetOutput()
  {
    return this->GetFilter()->GetShrunkOutput();
  }
 
  otbSetObjectMemberMacro(Filter, ShrinkFactor, unsigned int);
  otbGetObjectMemberMacro(Filter, ShrinkFactor, unsigned int);
 
  void Update(void) override
  {
    m_StreamingManager->SetShrinkFactor(this->GetFilter()->GetShrinkFactor());
    Superclass::Update();
  }
 
protected:
  StreamingShrinkImageFilter()
  {
    // Use a specific StreamingManager implementation
    m_StreamingManager = StreamingShrinkStreamingManagerType::New();
    this->GetStreamer()->SetStreamingManager(m_StreamingManager);
  }
 
  ~StreamingShrinkImageFilter() override
  {
  }
 
private:
  StreamingShrinkImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  StreamingShrinkStreamingManagerPointerType m_StreamingManager;
};
 
} // End namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingShrinkImageFilter.hxx"
#endif
 
#endif