otbMultiImageFileWriter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017-2019 CS Systemes d'Information (CS SI)
 *
 * 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 otbMultiImageFileWriter_h
#define otbMultiImageFileWriter_h
 
#include "otbImageFileWriter.h"
#include "otbImage.h"
#include "itkImageBase.h"
#include "itkProcessObject.h"
#include "itkImageIOBase.h"
#include "OTBImageIOExport.h"
 
#include <memory>
 
namespace otb
{
 
class OTBImageIO_EXPORT MultiImageFileWriter : public itk::ProcessObject
{
public:
  typedef MultiImageFileWriter          Self;
  typedef itk::ProcessObject            Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(MultiImageFileWriter, itk::ProcessObject);
 
  typedef itk::ImageBase<2>             ImageBaseType;
  typedef ImageBaseType::RegionType     RegionType;
  typedef ImageBaseType::IndexType      IndexType;
  typedef ImageBaseType::IndexValueType IndexValueType;
  typedef ImageBaseType::SizeType       SizeType;
  typedef ImageBaseType::SizeValueType  SizeValueType;
 
  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);
 
  virtual void UpdateOutputData(itk::DataObject* itkNotUsed(output)) override;
 
  template <class TImage>
  void AddInputImage(const TImage* inputPtr, const std::string& fileName);
 
 
  template <class TWriter>
  void AddInputWriter(typename TWriter::Pointer writer);
 
  virtual void UpdateOutputInformation() override;
 
  virtual void Update() override
  {
    this->UpdateOutputInformation();
    this->UpdateOutputData(NULL);
  }
 
protected:
  MultiImageFileWriter();
  virtual ~MultiImageFileWriter()
  {
  }
 
  virtual void GenerateData(void) override;
 
  virtual void GenerateInputRequestedRegion() override;
 
  virtual void InitializeStreaming();
 
  void ResetAllRequestedRegions(ImageBaseType* imagePtr);
 
  virtual RegionType GetStreamRegion(int inputIndex);
 
  void operator=(const MultiImageFileWriter&) = 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);
  }
 
private:
  typedef otb::Image<unsigned char, 2> FakeOutputType;
  typedef StreamingManager<FakeOutputType> StreamingManagerType;
  StreamingManagerType::Pointer m_StreamingManager;
 
  // Division parameters
  unsigned int m_NumberOfDivisions;
  unsigned int m_CurrentDivision;
  float        m_DivisionProgress;
 
  bool          m_IsObserving;
  unsigned long m_ObserverID;
 
  class SinkBase
  {
  public:
    SinkBase()
    {
    }
    SinkBase(ImageBaseType::ConstPointer inputImage) : m_InputImage(inputImage)
    {
    }
    virtual ~SinkBase()
    {
    }
    virtual ImageBaseType::ConstPointer GetInput() const
    {
      return m_InputImage;
    }
    virtual ImageBaseType::Pointer GetInput()
    {
      return const_cast<ImageBaseType*>(m_InputImage.GetPointer());
    }
    virtual void WriteImageInformation()                 = 0;
    virtual void Write(const RegionType& streamRegion)   = 0;
    virtual bool                        CanStreamWrite() const = 0;
    typedef std::shared_ptr<SinkBase> Pointer;
 
 
    virtual itk::ImageRegion<2> GetRegionToWrite() const = 0;
 
  protected:
    ImageBaseType::ConstPointer m_InputImage;
  };
 
  template <class TImage>
  class Sink : public SinkBase
  {
  public:
    Sink()
    {
    }
    Sink(typename TImage::ConstPointer inputImage, const std::string& filename);
    Sink(typename otb::ImageFileWriter<TImage>::Pointer writer);
 
    virtual ~Sink()
    {
    }
 
    void WriteImageInformation() override;
    void Write(const RegionType& streamRegion) override;
    bool                    CanStreamWrite() const override;
    typedef std::shared_ptr<Sink> Pointer;
    
    itk::ImageRegion<2> GetRegionToWrite() const override;
 
  private:
    typename otb::ImageFileWriter<TImage>::Pointer m_Writer;
 
    otb::ImageIOBase::Pointer m_ImageIO;
  };
 
  typedef std::vector<std::shared_ptr<SinkBase>> SinkListType;
  SinkListType                                   m_SinkList;
 
  std::vector<RegionType> m_StreamRegionList;
};
 
} // end of namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbMultiImageFileWriter.hxx"
#endif
 
#endif // otbMultiImageFileWriter_h