qgsgdalutils.h

Go to the documentation of this file.

/***************************************************************************
                             qgsgdalutils.h
                             --------------
    begin                : September 2018
    copyright            : (C) 2018 Even Rouault
    email                : even.rouault at spatialys.com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSGDALUTILS_H
#define QGSGDALUTILS_H
 
#define SIP_NO_FILE
 
#include "qgis_core.h"
#include <gdal.h>
 
#include "qgsogrutils.h"
 
class QgsRasterBlock;
 
class CORE_EXPORT QgsGdalOption
{
  public:
 
    enum class Type
    {
      Invalid, 
      Select, 
      Boolean, 
      Text, 
      Int, 
      Double, 
    };
 
    QString name;
 
    Type type = Type::Invalid;
 
    QString description;
 
    QStringList options;
 
    QVariant defaultValue;
 
    QVariant minimum;
 
    QVariant maximum;
 
    QString scope;
 
    static QgsGdalOption fromXmlNode( const CPLXMLNode *node );
 
    static QList< QgsGdalOption > optionsFromXml( const CPLXMLNode *node );
};
 
 
class CORE_EXPORT QgsGdalUtils
{
  public:
 
    static bool supportsRasterCreate( GDALDriverH driver );
 
    static gdal::dataset_unique_ptr createSingleBandMemoryDataset( GDALDataType dataType, const QgsRectangle &extent, int width, int height, const QgsCoordinateReferenceSystem &crs );
 
    static gdal::dataset_unique_ptr createMultiBandMemoryDataset( GDALDataType dataType, int bands, const QgsRectangle &extent, int width, int height, const QgsCoordinateReferenceSystem &crs );
 
    static gdal::dataset_unique_ptr createSingleBandTiffDataset( const QString &filename, GDALDataType dataType, const QgsRectangle &extent, int width, int height, const QgsCoordinateReferenceSystem &crs );
 
    static bool resampleSingleBandRaster( GDALDatasetH hSrcDS, GDALDatasetH hDstDS, GDALResampleAlg resampleAlg, const char *pszCoordinateOperation );
 
    static bool resampleSingleBandRaster( GDALDatasetH hSrcDS,
                                          GDALDatasetH hDstDS,
                                          GDALResampleAlg resampleAlg,
                                          const QgsCoordinateReferenceSystem &sourceCrs,
                                          const QgsCoordinateReferenceSystem &destinationCrs );
 
    static QImage resampleImage( const QImage &image, QSize outputSize, GDALRIOResampleAlg resampleAlg );
 
    static QString helpCreationOptionsFormat( const QString &format );
 
    static QString validateCreationOptionsFormat( const QStringList &createOptions, const QString &format );
 
    static char **papszFromStringList( const QStringList &list );
 
    static gdal::dataset_unique_ptr imageToMemoryDataset( const QImage &image );
 
    static gdal::dataset_unique_ptr blockToSingleBandMemoryDataset( int pixelWidth, int pixelHeight, const QgsRectangle &extent, void *block,  GDALDataType dataType );
 
    static gdal::dataset_unique_ptr blockToSingleBandMemoryDataset( const QgsRectangle &extent, QgsRasterBlock *block );
 
    static gdal::dataset_unique_ptr blockToSingleBandMemoryDataset( double rotation, const QgsPointXY &origin, double gridXSize,  double gridYSize,   QgsRasterBlock *block );
 
    static GDALDatasetH rpcAwareAutoCreateWarpedVrt(
      GDALDatasetH hSrcDS,
      const char *pszSrcWKT,
      const char *pszDstWKT,
      GDALResampleAlg eResampleAlg,
      double dfMaxError,
      const GDALWarpOptions *psOptionsIn );
 
    static void *rpcAwareCreateTransformer( GDALDatasetH hSrcDS, GDALDatasetH hDstDS = nullptr, char **papszOptions = nullptr );
 
    static GDALDataType gdalDataTypeFromQgisDataType( Qgis::DataType dataType );
 
    static GDALResampleAlg gdalResamplingAlgorithm( Qgis::RasterResamplingMethod method );
 
#ifndef QT_NO_NETWORKPROXY
    static void setupProxy();
#endif
 
    static bool pathIsCheapToOpen( const QString &path, int smallFileSizeLimit = 50000 );
 
    static QStringList multiLayerFileExtensions();
 
    static QString vsiPrefixForPath( const QString &path );
 
    static QStringList vsiArchivePrefixes();
 
    struct VsiNetworkFileSystemDetails
    {
      QString identifier;
 
      QString name;
    };
 
    static QList< VsiNetworkFileSystemDetails > vsiNetworkFileSystems();
 
    static bool isVsiArchivePrefix( const QString &prefix );
 
    static QStringList vsiArchiveFileExtensions();
 
    static bool isVsiArchiveFileExtension( const QString &extension );
 
    static Qgis::VsiHandlerType vsiHandlerType( const QString &prefix );
 
    static bool applyVsiCredentialOptions( const QString &prefix, const QString &path, const QVariantMap &options );
 
    static bool vrtMatchesLayerType( const QString &vrtPath, Qgis::LayerType type );
 
    static QString gdalDocumentationUrlForDriver( GDALDriverH hDriver );
 
    friend class TestQgsGdalUtils;
};
 
#endif // QGSGDALUTILS_H