otbImageFileReader.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2022 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 otbImageFileReader_h
#define otbImageFileReader_h
 
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#include "itkImageSource.h"
#pragma GCC diagnostic pop
#else
#include "itkImageSource.h"
#endif
#include "otbImageIOBase.h"
#include "itkExceptionObject.h"
#include "itkImageRegion.h"
#include "OTBImageIOExport.h"
 
#include "otbDefaultConvertPixelTraits.h"
#include "otbExtendedFilenameToReaderOptions.h"
#include "otbImageFileReaderException.h"
#include "otbMetadataSupplierInterface.h"
#include <string>
 
namespace otb
{
 
template <class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits<typename TOutputImage::IOPixelType>>
class OTBImageIO_EXPORT_TEMPLATE ImageFileReader : public itk::ImageSource<TOutputImage>
{
public:
  typedef ImageFileReader                Self;
  typedef itk::ImageSource<TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>        Pointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ImageFileReader, ImageSource);
 
  typedef typename TOutputImage::SizeType SizeType;
 
  typedef typename TOutputImage::IndexType IndexType;
 
  typedef typename TOutputImage::RegionType ImageRegionType;
 
  typedef typename TOutputImage::InternalPixelType OutputImagePixelType;
 
  typedef ExtendedFilenameToReaderOptions FNameHelperType;
 
  void GenerateOutputInformation(void) override;
 
  void GenerateData() override;
 
  void EnlargeOutputRequestedRegion(itk::DataObject* output) override;
 
  void SetImageIO(otb::ImageIOBase* imageIO);
  itkGetObjectMacro(ImageIO, otb::ImageIOBase);
 
  virtual void SetFileName(const std::string& extendedFileName);
 
  virtual const char* GetFileName() const;
 
  unsigned int GetOverviewsCount();
 
 
  std::vector<std::string> GetOverviewsInfo();
 
  // Retrieve the real source file name if derived dataset */
  static std::string GetDerivedDatasetSourceFileName(const std::string& filename);
 
protected:
  ImageFileReader();
  ~ImageFileReader() override;
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void DoConvertBuffer(void* buffer, size_t numberOfPixels);
 
private:
  void TestValidImageIO();
 
  bool GetGdalReadImageFileName(const std::string& filename, std::string& GdalFileName);
 
  ImageFileReader(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  otb::ImageIOBase::Pointer m_ImageIO;
  bool                      m_UserSpecifiedImageIO; // keep track whether the
                                                    // ImageIO is user specified
 
  std::string m_FileName; // The file to be read
 
  bool m_UseStreaming;
 
  // The region that the ImageIO class will return when we ask to
  // produce the requested region.
  itk::ImageIORegion m_ActualIORegion;
 
  FNameHelperType::Pointer m_FilenameHelper;
 
  unsigned int m_AdditionalNumber;
 
  std::vector<unsigned int> m_BandList;
 
  unsigned int m_IOComponents;
};
 
} // namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbImageFileReader.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 ImageFileReader<Image<unsigned int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<unsigned char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<unsigned short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<float, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<double, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<std::complex<int>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<std::complex<short>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<std::complex<float>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<Image<std::complex<double>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<unsigned int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<int, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<unsigned char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<char, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<unsigned short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<short, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<float, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<double, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<std::complex<int>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<std::complex<short>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<std::complex<float>, 2>>;
extern template class OTBImageIO_EXPORT_TEMPLATE ImageFileReader<VectorImage<std::complex<double>, 2>>;
}
 
#endif // otbImageFileReader_h