otbScalarBufferToImageFileWriter.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 otbScalarBufferToImageFileWriter_h
#define otbScalarBufferToImageFileWriter_h
 
 
#include "otbVectorImage.h"
#include "otbImageFileWriter.h"
#include "OTBImageIOExport.h"
 
namespace otb
{
template <class TBufferType, class TOutputPixelType = TBufferType>
class OTBImageIO_EXPORT_TEMPLATE ScalarBufferToImageFileWriter : public itk::ProcessObject
{
public:
  typedef ScalarBufferToImageFileWriter Self;
  typedef itk::ProcessObject            Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ScalarBufferToImageFileWriter, itk::ProcessObject);
 
  typedef TBufferType      BufferType;
  typedef TOutputPixelType OutputPixelType;
 
  typedef otb::VectorImage<OutputPixelType, 2> ImageType;
  typedef typename ImageType::PixelType  PixelType;
  typedef typename ImageType::RegionType RegionType;
  typedef typename ImageType::SizeType   SizeType;
  typedef typename ImageType::IndexType  IndexType;
 
  typedef otb::ImageFileWriter<ImageType> WriterType;
  typedef typename WriterType::Pointer    WriterPointer;
 
  otbGetObjectMemberMacro(Writer, FileName, std::string);
  otbSetObjectMemberMacro(Writer, FileName, std::string);
 
  itkGetMacro(ImageSize, SizeType);
  itkSetMacro(ImageSize, SizeType);
 
  itkGetMacro(NumberOfChannels, unsigned int);
  itkSetMacro(NumberOfChannels, unsigned int);
 
  itkGetMacro(InverseXSpacing, bool);
  itkSetMacro(InverseXSpacing, bool);
 
  void SetBuffer(BufferType* pBuff)
  {
    m_Buffer = pBuff;
  }
 
  void GenerateData() override;
 
  void Update() override
  {
    this->GenerateData();
  }
 
protected:
  ScalarBufferToImageFileWriter();
  ~ScalarBufferToImageFileWriter() override
  { /* don't call ClearBuffer, user's care */
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  ScalarBufferToImageFileWriter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
 
  WriterPointer m_Writer;
 
  BufferType* m_Buffer;
 
  unsigned int m_NumberOfChannels;
 
  SizeType m_ImageSize;
 
  bool m_InverseXSpacing;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbScalarBufferToImageFileWriter.hxx"
#endif
 
#endif