otbStreamingImageVirtualWriter.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 otbStreamingImageVirtualWriter_h
#define otbStreamingImageVirtualWriter_h
 
#include "itkMacro.h"
#include "itkImageToImageFilter.h"
#include "otbStreamingManager.h"
#include <mutex>
 
namespace otb
{
 
template <class TInputImage>
class ITK_EXPORT StreamingImageVirtualWriter : public itk::ImageToImageFilter<TInputImage, TInputImage>
{
public:
  typedef StreamingImageVirtualWriter Self;
  typedef itk::ImageToImageFilter<TInputImage, TInputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingImageVirtualWriter, itk::ImageToImageFilter);
 
  typedef TInputImage                         InputImageType;
  typedef typename InputImageType::Pointer    InputImagePointer;
  typedef typename InputImageType::RegionType InputImageRegionType;
  typedef typename InputImageType::PixelType  InputImagePixelType;
 
  typedef StreamingManager<InputImageType>       StreamingManagerType;
  typedef typename StreamingManagerType::Pointer StreamingManagerPointerType;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, InputImageType::ImageDimension);
 
  StreamingManagerType* GetStreamingManager(void)
  {
    return m_StreamingManager;
  }
 
  void SetStreamingManager(StreamingManagerType* streamingManager)
  {
    m_StreamingManager = streamingManager;
  }
 
  void SetNumberOfDivisionsStrippedStreaming(unsigned int nbDivisions);
 
  void SetNumberOfDivisionsTiledStreaming(unsigned int nbDivisions);
 
  void SetNumberOfLinesStrippedStreaming(unsigned int nbLinesPerStrip);
 
  void SetAutomaticStrippedStreaming(unsigned int availableRAM = 0, double bias = 1.0);
 
  void SetTileDimensionTiledStreaming(unsigned int tileDimension);
 
  void SetAutomaticTiledStreaming(unsigned int availableRAM = 0, double bias = 1.0);
 
  void SetAutomaticAdaptativeStreaming(unsigned int availableRAM = 0, double bias = 1.0);
 
  void Update() override;
 
  const bool& GetAbortGenerateData() const override;
 
  void SetAbortGenerateData(const bool val) override;
 
protected:
  StreamingImageVirtualWriter();
 
  ~StreamingImageVirtualWriter() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateData(void) override;
 
  void GenerateInputRequestedRegion(void) override;
 
private:
  StreamingImageVirtualWriter(const StreamingImageVirtualWriter&) = delete;
  void operator=(const StreamingImageVirtualWriter&) = delete;
 
  void ObserveSourceFilterProgress(itk::Object* object, const itk::EventObject& event)
  {
    if (typeid(event) != typeid(itk::ProgressEvent))
    {
      return;
    }
 
    itk::ProcessObject* processObject = dynamic_cast<itk::ProcessObject*>(object);
    if (processObject)
    {
      m_DivisionProgress = processObject->GetProgress();
    }
 
    this->UpdateFilterProgress();
  }
 
  void UpdateFilterProgress()
  {
    this->UpdateProgress((m_DivisionProgress + m_CurrentDivision) / m_NumberOfDivisions);
  }
 
  unsigned int m_NumberOfDivisions;
  unsigned int m_CurrentDivision;
  float        m_DivisionProgress;
 
  StreamingManagerPointerType m_StreamingManager;
 
  bool          m_IsObserving;
  unsigned long m_ObserverID;
 
  mutable std::mutex m_Lock;
 
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingImageVirtualWriter.hxx"
#endif
 
#endif