otbGDALOverviewsBuilder.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 otbGDALOverviewsBuilder_h
#define otbGDALOverviewsBuilder_h
 
 
// #include "itkLightObject.h"
#include "itkProcessObject.h"
#include "itkSize.h"
 
#include "otbGDALDatasetWrapper.h"
#include "otbConfigure.h"
 
#include "OTBIOGDALExport.h"
#include <string>
 
namespace otb
{
 
enum GDALResampling
{
  GDAL_RESAMPLING_NONE = 0,
  //
  GDAL_RESAMPLING_NEAREST,
  GDAL_RESAMPLING_GAUSS,
  GDAL_RESAMPLING_CUBIC,
  GDAL_RESAMPLING_AVERAGE,
  GDAL_RESAMPLING_MODE,
  GDAL_RESAMPLING_AVERAGE_MAGPHASE,
  //
  GDAL_RESAMPLING_COUNT
};
 
 
// Compile-time compatibility alias.
typedef GDALResampling GDALResamplingType;
 
enum GDALCompression
{
  GDAL_COMPRESSION_NONE = 0,
  //
  GDAL_COMPRESSION_JPEG,
  GDAL_COMPRESSION_LZW,
  GDAL_COMPRESSION_PACKBITS,
  GDAL_COMPRESSION_DEFLATE,
  //
  GDAL_COMPRESSION_COUNT,
};
 
 
enum GDALFormat
{
  GDAL_FORMAT_ERDAS,
  GDAL_FORMAT_GEOTIFF,
  //
  GDAL_FORMAT_COUNT,
};
 
 
class OTBIOGDAL_EXPORT GDALOverviewsBuilder : public itk::ProcessObject
{
public:
  typedef GDALOverviewsBuilder          Self;
  typedef ProcessObject                 Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  typedef itk::Size<2>      Size;
  typedef std::vector<Size> SizeVector;
 
  itkNewMacro(Self);
 
  static bool CanGenerateOverviews(const std::string& filename);
 
  unsigned int CountResolutions(unsigned int factor, unsigned int size) const;
 
  unsigned int CountResolutions(unsigned int size) const;
 
  unsigned int CountResolutions() const;
 
  void ListResolutions(SizeVector&, unsigned int factor, unsigned int count);
 
  void ListResolutions(SizeVector&);
 
  unsigned int GetOverviewsCount() const;
 
 
  size_t GetEstimatedSize() const;
 
  GDALResampling GetResamplingMethod() const;
 
  void SetResamplingMethod(GDALResampling);
 
 
  void SetBypassEnabled(bool);
 
  bool IsBypassEnabled() const;
 
  unsigned int GetWidth() const;
 
  unsigned int GetHeight() const;
 
  GDALCompression GetCompressionMethod() const;
 
  void SetCompressionMethod(GDALCompression);
 
 
  GDALFormat GetFormat() const;
 
  void SetFormat(GDALFormat);
 
 
  unsigned int GetNbResolutions() const;
 
  void SetNbResolutions(unsigned int);
 
  unsigned int GetResolutionFactor() const;
 
  void SetResolutionFactor(unsigned int);
 
 
  const std::string& GetInputFileName() const;
 
  void SetInputFileName(const std::string& str);
 
 
  void Update() override;
 
 
protected:
  GDALOverviewsBuilder();
 
  ~GDALOverviewsBuilder() override{};
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
 
private:
  GDALOverviewsBuilder(const Self&) = delete;
 
  void operator=(const Self&) = delete;
 
  // void GetGDALResamplingMethod( std::string & resamplingMethod );
 
  void OpenDataset(const std::string& filename);
 
 
  GDALDatasetWrapper::Pointer m_GDALDataset;
  std::string                 m_InputFileName;
  unsigned int                m_NbResolutions;
  unsigned int                m_ResolutionFactor;
  GDALResampling              m_ResamplingMethod;
  GDALCompression             m_CompressionMethod;
  GDALFormat                  m_Format;
  bool                        m_IsBypassEnabled : 1;
 
}; // end of GDALOverviewsBuilder
 
} // end namespace otb
 
#endif // otbGDALOverviewsBuilder_h