otbImageFileWriter.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 * Copyright (C) 2020 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 otbImageFileWriter_h
#define otbImageFileWriter_h
 
#include "otbImageIOBase.h"
#include "itkProcessObject.h"
#include "otbStreamingManager.h"
#include "otbExtendedFilenameToWriterOptions.h"
#include <mutex>
#include <string>
#include "OTBImageIOExport.h"
 
namespace otb
{
 
template <class TInputImage>
class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter : public itk::ProcessObject
{
public:
  typedef ImageFileWriter               Self;
  typedef itk::ProcessObject            Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ImageFileWriter, itk::ProcessObject);
 
  typedef TInputImage                            InputImageType;
  typedef typename InputImageType::Pointer       InputImagePointer;
  typedef typename InputImageType::RegionType    InputImageRegionType;
  typedef typename InputImageType::PixelType     InputImagePixelType;
  typedef typename InputImageType::IndexType     InputIndexType;
  typedef TInputImage                            OutputImageType;
  typedef typename OutputImageType::Pointer      OutputImagePointer;
  typedef typename OutputImageType::RegionType   OutputImageRegionType;
  typedef typename OutputImageType::PixelType    OutputImagePixelType;
  typedef typename Superclass::DataObjectPointer DataObjectPointer;
 
  typedef ExtendedFilenameToWriterOptions FNameHelperType;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, InputImageType::ImageDimension);
 
  typedef StreamingManager<InputImageType>       StreamingManagerType;
  typedef typename StreamingManagerType::Pointer StreamingManagerPointerType;
 
  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);
 
  using Superclass::SetInput;
  virtual void SetInput(const InputImageType* input);
 
  const InputImageType* GetInput();
 
  void Update() override;
 
  virtual void SetFileName(const std::string& extendedFileName);
 
  virtual const char* GetFileName() const;
 
  void SetIORegion(const itk::ImageIORegion& region);
  itkGetConstReferenceMacro(IORegion, itk::ImageIORegion);
 
  itkSetMacro(UseCompression, bool);
  itkGetConstReferenceMacro(UseCompression, bool);
  itkBooleanMacro(UseCompression);
 
  itkSetMacro(UseInputMetaDataDictionary, bool);
  itkGetConstReferenceMacro(UseInputMetaDataDictionary, bool);
  itkBooleanMacro(UseInputMetaDataDictionary);
 
  itkSetObjectMacro(ImageIO, otb::ImageIOBase);
  itkGetObjectMacro(ImageIO, otb::ImageIOBase);
  itkGetConstObjectMacro(ImageIO, otb::ImageIOBase);
 
  itkGetConstObjectMacro(FilenameHelper, FNameHelperType);
 
  const bool& GetAbortGenerateData() const override;
 
  void SetAbortGenerateData(const bool val) override;
 
protected:
  ImageFileWriter();
  ~ImageFileWriter() override;
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateData(void) override;
 
  void GenerateOutputInformation(void) override;
 
private:
  ImageFileWriter(const ImageFileWriter&) = delete;
  void operator=(const ImageFileWriter&) = 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;
 
  std::string m_FileName;
 
  otb::ImageIOBase::Pointer m_ImageIO;
 
  bool m_UserSpecifiedImageIO; // track whether the ImageIO is user specified
 
  itk::ImageIORegion m_IORegion;
  bool               m_UserSpecifiedIORegion;   // track whether the region is user specified
  bool               m_FactorySpecifiedImageIO; // track whether the factory mechanism set the ImageIO
  bool               m_UseCompression;
  bool               m_UseInputMetaDataDictionary; // whether to use the
                                                   // MetaDataDictionary from the
                                                   // input or not.
 
  bool m_WriteGeomFile; // Write a geom file to store the
                        // kwl
 
  FNameHelperType::Pointer m_FilenameHelper;
 
  StreamingManagerPointerType m_StreamingManager;
 
  bool           m_IsObserving;
  unsigned long  m_ObserverID;
  InputIndexType m_ShiftOutputIndex;
 
  std::vector<unsigned int> m_BandList;
 
  unsigned int m_IOComponents;
 
  mutable std::mutex m_Lock;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbImageFileWriter.hxx"
#endif
 
#include "otbImage.h"
#include "otbVectorImage.h"
#include <complex>
 
namespace otb
{
 
// Prevent implicit instantiation of common types to improve build performance
// Explicit instantiations are provided in the .cxx
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<unsigned int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<unsigned char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<unsigned short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<float, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<double, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<std::complex<int>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<std::complex<short>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<std::complex<float>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<Image<std::complex<double>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<unsigned int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<unsigned char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<unsigned short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<float, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<double, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<std::complex<int>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<std::complex<short>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<std::complex<float>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileWriter<VectorImage<std::complex<double>, 2>>;
}
 
#endif