otbStreamingManager.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 otbStreamingManager_h
#define otbStreamingManager_h
 
#include "otbMacro.h"
 
#include "itkDataObject.h"
#include "itkImageRegionSplitterBase.h"
#include "otbPipelineMemoryPrintCalculator.h"
 
namespace otb
{
 
template <class TImage>
class ITK_EXPORT StreamingManager : public itk::Object
{
public:
  typedef StreamingManager              Self;
  typedef itk::LightObject              Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef TImage                                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;
 
  typedef otb::PipelineMemoryPrintCalculator::MemoryPrintType MemoryPrintType;
  typedef itk::ImageRegionSplitterBase                        AbstractSplitterType;
 
  itkTypeMacro(StreamingManager, itk::LightObject);
 
  itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);
 
  const AbstractSplitterType* GetSplitter() const;
 
  virtual void PrepareStreaming(itk::DataObject* input, const RegionType& region) = 0;
 
  virtual unsigned int GetNumberOfSplits();
 
  virtual RegionType GetSplit(unsigned int i);
 
  itkSetMacro(DefaultRAM, MemoryPrintType);
  itkGetMacro(DefaultRAM, MemoryPrintType);
 
protected:
  StreamingManager();
  ~StreamingManager() override;
 
  virtual unsigned int EstimateOptimalNumberOfDivisions(itk::DataObject* input, const RegionType& region, MemoryPrintType availableRAMInMB, double bias = 1.0);
 
  unsigned int m_ComputedNumberOfSplits;
 
  RegionType m_Region;
 
  typedef typename AbstractSplitterType::Pointer AbstractSplitterPointerType;
  AbstractSplitterPointerType                    m_Splitter;
 
private:
  StreamingManager(const StreamingManager&) = delete;
  void operator=(const StreamingManager&) = delete;
 
  MemoryPrintType GetActualAvailableRAMInBytes(MemoryPrintType availableRAMInMB);
 
  MemoryPrintType m_DefaultRAM;
};
 
} // End namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingManager.hxx"
#endif
 
#endif