otbPipelineMemoryPrintCalculator.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 otbPipelineMemoryPrintCalculator_h
#define otbPipelineMemoryPrintCalculator_h
 
#include "itkProcessObject.h"
#include <set>
#include <iosfwd>
 
#include "OTBStreamingExport.h"
 
namespace otb
{
class OTBStreaming_EXPORT PipelineMemoryPrintCalculator : public itk::Object
{
public:
  using Self         = PipelineMemoryPrintCalculator;
  using Superclass   = itk::Object;
  using Pointer      = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;
 
  using ProcessObjectType           = itk::ProcessObject;
  using ProcessObjectPointerType    = ProcessObjectType::Pointer;
  using DataObjectType              = itk::DataObject;
  using DataObjectPointerType       = DataObjectType::Pointer;
  using MemoryPrintType             = std::uint64_t;
  using ProcessObjectPointerSetType = std::set<const ProcessObjectType*> ;
 
  itkTypeMacro(PipelineMemoryPrintCalculator, itk::Object);
 
  itkNewMacro(Self);
 
  itkGetMacro(MemoryPrint, MemoryPrintType);
 
  itkSetMacro(BiasCorrectionFactor, double);
  itkGetMacro(BiasCorrectionFactor, double);
 
  static unsigned long EstimateOptimalNumberOfStreamDivisions(MemoryPrintType memoryPrint, MemoryPrintType availableMemory);
 
  itkSetObjectMacro(DataToWrite, DataObjectType);
 
  void Compute(bool propagate = true);
 
  static const double ByteToMegabyte;
  static const double MegabyteToByte;
 
  MemoryPrintType EvaluateDataObjectPrint(DataObjectType* data);
 
protected:
  PipelineMemoryPrintCalculator();
 
  ~PipelineMemoryPrintCalculator() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  MemoryPrintType EvaluateProcessObjectPrintRecursive(ProcessObjectType* process);
 
private:
  PipelineMemoryPrintCalculator(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  MemoryPrintType m_MemoryPrint;
 
  DataObjectPointerType m_DataToWrite;
 
  double m_BiasCorrectionFactor;
 
  ProcessObjectPointerSetType m_VisitedProcessObjects;
};
} // end of namespace otb
 
#endif