otbStreamingImageVirtualWriter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ORFEO Toolbox
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
  See OTBCopyright.txt for details.


     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbStreamingImageVirtualWriter_h
#define __otbStreamingImageVirtualWriter_h

#include "itkMacro.h"
#include "itkImageToImageFilter.h"
#include "otbStreamingManager.h"

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);

protected:
  StreamingImageVirtualWriter();

  virtual ~StreamingImageVirtualWriter();

  void PrintSelf(std::ostream& os, itk::Indent indent) const;

  virtual void GenerateData(void);

  virtual void GenerateInputRequestedRegion(void);

private:
  StreamingImageVirtualWriter(const StreamingImageVirtualWriter &); //purposely not implemented
  void operator =(const StreamingImageVirtualWriter&); //purposely not implemented

  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;
};

} // end namespace otb

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingImageVirtualWriter.txx"
#endif

#endif