qgsrasterdataprovider.cpp

Go to the documentation of this file.

/***************************************************************************
    qgsrasterdataprovider.cpp - DataProvider Interface for raster layers
     --------------------------------------
    Date                 : Mar 11, 2005
    Copyright            : (C) 2005 by Brendan Morley
    email                : morb at ozemail dot com dot au
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsrasterdataprovider.h"
 
#include "qgslogger.h"
#include "qgspoint.h"
#include "qgsproviderregistry.h"
#include "qgsrasteridentifyresult.h"
#include "qgsthreadingutils.h"
 
#include <QByteArray>
#include <QMap>
#include <QSet>
#include <QString>
#include <QTime>
#include <QUrl>
#include <QUrlQuery>
#include <QVariant>
 
#include "moc_qgsrasterdataprovider.cpp"
 
using namespace Qt::StringLiterals;
 
#define ERR(message) QgsError(message, "Raster provider")
 
void QgsRasterDataProvider::setUseSourceNoDataValue( int bandNo, bool use )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( mUseSrcNoDataValue.size() < bandNo )
  {
    for ( int i = mUseSrcNoDataValue.size(); i < bandNo; i++ )
    {
      mUseSrcNoDataValue.append( false );
    }
  }
  mUseSrcNoDataValue[bandNo - 1] = use;
}
 
QgsRasterBlock *QgsRasterDataProvider::block( int bandNo, QgsRectangle  const &boundingBox, int width, int height, QgsRasterBlockFeedback *feedback )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  QgsDebugMsgLevel( u"bandNo = %1 width = %2 height = %3"_s.arg( bandNo ).arg( width ).arg( height ), 4 );
  QgsDebugMsgLevel( u"boundingBox = %1"_s.arg( boundingBox.toString() ), 4 );
 
  auto block = std::make_unique< QgsRasterBlock >( dataType( bandNo ), width, height );
  if ( sourceHasNoDataValue( bandNo ) && useSourceNoDataValue( bandNo ) )
  {
    block->setNoDataValue( sourceNoDataValue( bandNo ) );
  }
 
  if ( block->isEmpty() )
  {
    QgsDebugError( u"Couldn't create raster block"_s );
    block->setError( { tr( "Couldn't create raster block." ), u"Raster"_s } );
    block->setValid( false );
    return block.release();
  }
 
  // Read necessary extent only
  QgsRectangle tmpExtent = boundingBox;
 
  if ( tmpExtent.isEmpty() )
  {
    QgsDebugError( u"Extent outside provider extent"_s );
    block->setError( { tr( "Extent outside provider extent." ), u"Raster"_s } );
    block->setValid( false );
    block->setIsNoData();
    return block.release();
  }
 
  const double xRes = boundingBox.width() / width;
  const double yRes = boundingBox.height() / height;
  double tmpXRes, tmpYRes;
  double providerXRes = 0;
  double providerYRes = 0;
  if ( capabilities() & Qgis::RasterInterfaceCapability::Size )
  {
    providerXRes = extent().width() / xSize();
    providerYRes = extent().height() / ySize();
    tmpXRes = std::max( providerXRes, xRes );
    tmpYRes = std::max( providerYRes, yRes );
    if ( qgsDoubleNear( tmpXRes, xRes ) ) tmpXRes = xRes;
    if ( qgsDoubleNear( tmpYRes, yRes ) ) tmpYRes = yRes;
  }
  else
  {
    tmpXRes = xRes;
    tmpYRes = yRes;
  }
 
  if ( tmpExtent != boundingBox ||
       tmpXRes > xRes || tmpYRes > yRes )
  {
    // Read smaller extent or lower resolution
 
    if ( !extent().contains( boundingBox ) )
    {
      const QRect subRect = QgsRasterBlock::subRect( boundingBox, width, height, extent() );
      block->setIsNoDataExcept( subRect );
    }
 
    // Calculate row/col limits (before tmpExtent is aligned)
    const int fromRow = std::round( ( boundingBox.yMaximum() - tmpExtent.yMaximum() ) / yRes );
    const int toRow = std::round( ( boundingBox.yMaximum() - tmpExtent.yMinimum() ) / yRes ) - 1;
    const int fromCol = std::round( ( tmpExtent.xMinimum() - boundingBox.xMinimum() ) / xRes );
    const int toCol = std::round( ( tmpExtent.xMaximum() - boundingBox.xMinimum() ) / xRes ) - 1;
 
    QgsDebugMsgLevel( u"fromRow = %1 toRow = %2 fromCol = %3 toCol = %4"_s.arg( fromRow ).arg( toRow ).arg( fromCol ).arg( toCol ), 4 );
 
    if ( fromRow < 0 || fromRow >= height || toRow < 0 || toRow >= height ||
         fromCol < 0 || fromCol >= width || toCol < 0 || toCol >= width )
    {
      // Should not happen
      QgsDebugError( u"Row or column limits out of range"_s );
      block->setError( { tr( "Row or column limits out of range" ), u"Raster"_s } );
      block->setValid( false );
      return block.release();
    }
 
    // If lower source resolution is used, the extent must be aligned to original
    // resolution to avoid possible shift due to resampling
    if ( tmpXRes > xRes )
    {
      int col = std::floor( ( tmpExtent.xMinimum() - extent().xMinimum() ) / providerXRes );
      tmpExtent.setXMinimum( extent().xMinimum() + col * providerXRes );
      col = std::ceil( ( tmpExtent.xMaximum() - extent().xMinimum() ) / providerXRes );
      tmpExtent.setXMaximum( extent().xMinimum() + col * providerXRes );
    }
    if ( tmpYRes > yRes )
    {
      int row = std::floor( ( extent().yMaximum() - tmpExtent.yMaximum() ) / providerYRes );
      tmpExtent.setYMaximum( extent().yMaximum() - row * providerYRes );
      row = std::ceil( ( extent().yMaximum() - tmpExtent.yMinimum() ) / providerYRes );
      tmpExtent.setYMinimum( extent().yMaximum() - row * providerYRes );
    }
    const int tmpWidth = std::round( tmpExtent.width() / tmpXRes );
    const int tmpHeight = std::round( tmpExtent.height() / tmpYRes );
    tmpXRes = tmpExtent.width() / tmpWidth;
    tmpYRes = tmpExtent.height() / tmpHeight;
 
    QgsDebugMsgLevel( u"Reading smaller block tmpWidth = %1 height = %2"_s.arg( tmpWidth ).arg( tmpHeight ), 4 );
    QgsDebugMsgLevel( u"tmpExtent = %1"_s.arg( tmpExtent.toString() ), 4 );
 
    auto tmpBlock = std::make_unique< QgsRasterBlock >( dataType( bandNo ), tmpWidth, tmpHeight );
    if ( sourceHasNoDataValue( bandNo ) && useSourceNoDataValue( bandNo ) )
    {
      tmpBlock->setNoDataValue( sourceNoDataValue( bandNo ) );
    }
 
    if ( !readBlock( bandNo, tmpExtent, tmpWidth, tmpHeight, tmpBlock->bits(), feedback ) )
    {
      QgsDebugError( u"Error occurred while reading block"_s );
      block->setError( { tr( "Error occurred while reading block." ), u"Raster"_s } );
      block->setValid( false );
      block->setIsNoData();
      return block.release();
    }
 
    const int pixelSize = dataTypeSize( bandNo );
 
    const double xMin = boundingBox.xMinimum();
    const double yMax = boundingBox.yMaximum();
    const double tmpXMin = tmpExtent.xMinimum();
    const double tmpYMax = tmpExtent.yMaximum();
 
    for ( int row = fromRow; row <= toRow; row++ )
    {
      const double y = yMax - ( row + 0.5 ) * yRes;
      const int tmpRow = std::floor( ( tmpYMax - y ) / tmpYRes );
 
      for ( int col = fromCol; col <= toCol; col++ )
      {
        const double x = xMin + ( col + 0.5 ) * xRes;
        const int tmpCol = std::floor( ( x - tmpXMin ) / tmpXRes );
 
        if ( tmpRow < 0 || tmpRow >= tmpHeight || tmpCol < 0 || tmpCol >= tmpWidth )
        {
          QgsDebugError( u"Source row or column limits out of range"_s );
          block->setIsNoData(); // so that the problem becomes obvious and fixed
          block->setError( { tr( "Source row or column limits out of range." ), u"Raster"_s } );
          block->setValid( false );
          return block.release();
        }
 
        const qgssize tmpIndex = static_cast< qgssize >( tmpRow ) * static_cast< qgssize >( tmpWidth ) + tmpCol;
        const qgssize index = row * static_cast< qgssize >( width ) + col;
 
        const char *tmpBits = tmpBlock->constBits( tmpIndex );
        char *bits = block->bits( index );
        if ( !tmpBits )
        {
          QgsDebugError( u"Cannot get input block data tmpRow = %1 tmpCol = %2 tmpIndex = %3."_s.arg( tmpRow ).arg( tmpCol ).arg( tmpIndex ) );
          continue;
        }
        if ( !bits )
        {
          QgsDebugError( u"Cannot set output block data."_s );
          continue;
        }
        memcpy( bits, tmpBits, pixelSize );
      }
    }
  }
  else
  {
    if ( !readBlock( bandNo, boundingBox, width, height, block->bits(), feedback ) )
    {
      QgsDebugError( u"Error occurred while reading block"_s );
      block->setIsNoData();
      block->setError( { tr( "Error occurred while reading block." ), u"Raster"_s } );
      block->setValid( false );
      return block.release();
    }
  }
 
  // apply scale and offset
  block->applyScaleOffset( bandScale( bandNo ), bandOffset( bandNo ) );
  // apply user no data values
  block->applyNoDataValues( userNoDataValues( bandNo ) );
  return block.release();
}
 
QgsRasterDataProvider::QgsRasterDataProvider()
  : QgsDataProvider( QString(), QgsDataProvider::ProviderOptions(), Qgis::DataProviderReadFlags() )
  , QgsRasterInterface( nullptr )
  , mTemporalCapabilities( std::make_unique< QgsRasterDataProviderTemporalCapabilities >() )
  , mElevationProperties( std::make_unique< QgsRasterDataProviderElevationProperties >() )
{
 
}
 
QgsRasterDataProvider::QgsRasterDataProvider( const QString &uri, const ProviderOptions &options,
    Qgis::DataProviderReadFlags flags )
  : QgsDataProvider( uri, options, flags )
  , QgsRasterInterface( nullptr )
  , mTemporalCapabilities( std::make_unique< QgsRasterDataProviderTemporalCapabilities >() )
  , mElevationProperties( std::make_unique< QgsRasterDataProviderElevationProperties >() )
{
}
 
Qgis::RasterProviderCapabilities QgsRasterDataProvider::providerCapabilities() const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return Qgis::RasterProviderCapability::NoProviderCapabilities;
}
 
Qgis::RasterColorInterpretation QgsRasterDataProvider::colorInterpretation( int bandNo ) const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  Q_UNUSED( bandNo )
  return Qgis::RasterColorInterpretation::Undefined;
}
 
// TODO
// (WMS) IdentifyFormatFeature is not consistent with QgsRaster::IdentifyFormatValue.
// IdentifyFormatHtml: better error reporting
QgsRasterIdentifyResult QgsRasterDataProvider::identify( const QgsPointXY &point, Qgis::RasterIdentifyFormat format, const QgsRectangle &boundingBox, int width, int height, int /*dpi*/ )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  QgsDebugMsgLevel( u"Entered"_s, 4 );
  QMap<int, QVariant> results;
 
  if ( format != Qgis::RasterIdentifyFormat::Value || !( capabilities() & Qgis::RasterInterfaceCapability::IdentifyValue ) )
  {
    QgsDebugError( u"Format not supported"_s );
    return QgsRasterIdentifyResult( ERR( tr( "Format not supported" ) ) );
  }
 
  if ( !extent().contains( point ) )
  {
    // Outside the raster
    for ( int bandNo = 1; bandNo <= bandCount(); bandNo++ )
    {
      results.insert( bandNo, QVariant() );
    }
    return QgsRasterIdentifyResult( Qgis::RasterIdentifyFormat::Value, results );
  }
 
  QgsRectangle finalExtent = boundingBox;
  if ( finalExtent.isEmpty() )
    finalExtent = extent();
 
  if ( width == 0 )
  {
    width = ( capabilities() & Qgis::RasterInterfaceCapability::Size ) ? xSize() : 1000;
  }
  if ( height == 0 )
  {
    height = ( capabilities() & Qgis::RasterInterfaceCapability::Size ) ? ySize() : 1000;
  }
 
  // Calculate the row / column where the point falls
  const double xres = ( finalExtent.width() ) / width;
  const double yres = ( finalExtent.height() ) / height;
 
  const int col = static_cast< int >( std::floor( ( point.x() - finalExtent.xMinimum() ) / xres ) );
  const int row = static_cast< int >( std::floor( ( finalExtent.yMaximum() - point.y() ) / yres ) );
 
  const double xMin = finalExtent.xMinimum() + col * xres;
  const double xMax = xMin + xres;
  const double yMax = finalExtent.yMaximum() - row * yres;
  const double yMin = yMax - yres;
  const QgsRectangle pixelExtent( xMin, yMin, xMax, yMax );
 
  for ( int bandNumber = 1; bandNumber <= bandCount(); bandNumber++ )
  {
    std::unique_ptr< QgsRasterBlock > bandBlock( block( bandNumber, pixelExtent, 1, 1 ) );
 
    if ( bandBlock )
    {
      const double value = bandBlock->value( 0 );
      if ( ( sourceHasNoDataValue( bandNumber ) && useSourceNoDataValue( bandNumber ) &&
             ( std::isnan( value ) || qgsDoubleNear( value, sourceNoDataValue( bandNumber ) ) ) ) ||
           ( QgsRasterRange::contains( value, userNoDataValues( bandNumber ) ) ) )
      {
        results.insert( bandNumber, QVariant() ); // null QVariant represents no data
      }
      else
      {
        results.insert( bandNumber, value );
      }
    }
    else
    {
      results.insert( bandNumber, QVariant() );
    }
  }
  return QgsRasterIdentifyResult( Qgis::RasterIdentifyFormat::Value, results );
}
 
double QgsRasterDataProvider::sample( const QgsPointXY &point, int band,
                                      bool *ok, const QgsRectangle &boundingBox, int width, int height, int dpi )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( ok )
    *ok = false;
 
  const auto res = identify( point, Qgis::RasterIdentifyFormat::Value, boundingBox, width, height, dpi );
  const QVariant value = res.results().value( band );
 
  if ( !value.isValid() )
    return std::numeric_limits<double>::quiet_NaN();
 
  if ( ok )
    *ok = true;
 
  return value.toDouble( ok );
}
 
QString QgsRasterDataProvider::lastErrorFormat()
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return u"text/plain"_s;
}
 
bool QgsRasterDataProvider::writeBlock( QgsRasterBlock *block, int band, int xOffset, int yOffset )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( !block )
    return false;
  if ( !isEditable() )
  {
    setError( QgsError( u"writeBlock() called on read-only provider."_s, u"writeBlock"_s ) );
    QgsDebugError( u"writeBlock() called on read-only provider."_s );
    return false;
  }
  return write( block->bits(), band, block->width(), block->height(), xOffset, yOffset );
}
 
// typedef QList<QPair<QString, QString> > *pyramidResamplingMethods_t();
QList<QPair<QString, QString> > QgsRasterDataProvider::pyramidResamplingMethods( const QString &providerKey )
{
  QList<QPair<QString, QString> > methods = QgsProviderRegistry::instance()->pyramidResamplingMethods( providerKey );
  if ( methods.isEmpty() )
  {
    QgsDebugMsgLevel( u"provider pyramidResamplingMethods returned no methods"_s, 2 );
  }
  return methods;
}
 
bool QgsRasterDataProvider::hasPyramids()
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  const QList<QgsRasterPyramid> pyramidList = buildPyramidList();
  return std::any_of( pyramidList.constBegin(), pyramidList.constEnd(), []( QgsRasterPyramid pyramid ) { return pyramid.getExists(); } );
}
 
void QgsRasterDataProvider::setUserNoDataValue( int bandNo, const QgsRasterRangeList &noData )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( bandNo >= mUserNoDataValue.size() )
  {
    for ( int i = mUserNoDataValue.size(); i < bandNo; i++ )
    {
      mUserNoDataValue.append( QgsRasterRangeList() );
    }
  }
  QgsDebugMsgLevel( u"set %1 band %1 no data ranges"_s.arg( noData.size() ), 4 );
 
  if ( mUserNoDataValue[bandNo - 1] != noData )
  {
    // Clear statistics
    mStatistics.erase( std::remove_if( mStatistics.begin(), mStatistics.end(), [bandNo]( const QgsRasterBandStats & stats )
    {
      return stats.bandNumber == bandNo;
    } ), mStatistics.end() );
    mHistograms.erase( std::remove_if( mHistograms.begin(), mHistograms.end(), [bandNo]( const QgsRasterHistogram & histogram )
    {
      return histogram.bandNumber == bandNo;
    } ), mHistograms.end() );
    mUserNoDataValue[bandNo - 1] = noData;
  }
}
 
QgsRasterDataProviderTemporalCapabilities *QgsRasterDataProvider::temporalCapabilities()
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return mTemporalCapabilities.get();
}
 
const QgsRasterDataProviderTemporalCapabilities *QgsRasterDataProvider::temporalCapabilities() const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return mTemporalCapabilities.get();
}
 
QgsRasterDataProviderElevationProperties *QgsRasterDataProvider::elevationProperties()
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return mElevationProperties.get();
}
 
const QgsRasterDataProviderElevationProperties *QgsRasterDataProvider::elevationProperties() const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return mElevationProperties.get();
}
 
QgsRasterDataProvider *QgsRasterDataProvider::create( const QString &providerKey,
    const QString &uri,
    const QString &format, int nBands,
    Qgis::DataType type,
    int width, int height, double *geoTransform,
    const QgsCoordinateReferenceSystem &crs,
    const QStringList &creationOptions )
{
  QgsRasterDataProvider *ret = QgsProviderRegistry::instance()->createRasterDataProvider(
                                 providerKey,
                                 uri, format,
                                 nBands, type, width,
                                 height, geoTransform, crs, creationOptions );
  if ( !ret )
  {
    QgsDebugError( "Cannot resolve 'createRasterDataProviderFunction' function in " + providerKey + " provider" );
  }
 
  // TODO: it would be good to return invalid QgsRasterDataProvider
  // with QgsError set, but QgsRasterDataProvider has pure virtual methods
 
  return ret;
}
 
QString QgsRasterDataProvider::identifyFormatName( Qgis::RasterIdentifyFormat format )
{
  switch ( format )
  {
    case Qgis::RasterIdentifyFormat::Value:
      return u"Value"_s;
    case Qgis::RasterIdentifyFormat::Text:
      return u"Text"_s;
    case Qgis::RasterIdentifyFormat::Html:
      return u"Html"_s;
    case Qgis::RasterIdentifyFormat::Feature:
      return u"Feature"_s;
    case Qgis::RasterIdentifyFormat::Undefined:
      break;
  }
  return u"Undefined"_s;
}
 
QString QgsRasterDataProvider::identifyFormatLabel( Qgis::RasterIdentifyFormat format )
{
  switch ( format )
  {
    case Qgis::RasterIdentifyFormat::Value:
      return tr( "Value" );
    case Qgis::RasterIdentifyFormat::Text:
      return tr( "Text" );
    case Qgis::RasterIdentifyFormat::Html:
      return tr( "HTML" );
    case Qgis::RasterIdentifyFormat::Feature:
      return tr( "Feature" );
    case Qgis::RasterIdentifyFormat::Undefined:
      break;
  }
  return u"Undefined"_s;
}
 
Qgis::RasterIdentifyFormat QgsRasterDataProvider::identifyFormatFromName( const QString &formatName )
{
  if ( formatName == "Value"_L1 )
    return Qgis::RasterIdentifyFormat::Value;
  if ( formatName == "Text"_L1 )
    return Qgis::RasterIdentifyFormat::Text;
  if ( formatName == "Html"_L1 )
    return Qgis::RasterIdentifyFormat::Html;
  if ( formatName == "Feature"_L1 )
    return Qgis::RasterIdentifyFormat::Feature;
  return Qgis::RasterIdentifyFormat::Undefined;
}
 
Qgis::RasterInterfaceCapability QgsRasterDataProvider::identifyFormatToCapability( Qgis::RasterIdentifyFormat format )
{
  switch ( format )
  {
    case Qgis::RasterIdentifyFormat::Value:
      return Qgis::RasterInterfaceCapability::IdentifyValue;
    case Qgis::RasterIdentifyFormat::Text:
      return Qgis::RasterInterfaceCapability::IdentifyText;
    case Qgis::RasterIdentifyFormat::Html:
      return Qgis::RasterInterfaceCapability::IdentifyHtml;
    case Qgis::RasterIdentifyFormat::Feature:
      return Qgis::RasterInterfaceCapability::IdentifyFeature;
    case Qgis::RasterIdentifyFormat::Undefined:
      break;
  }
  return Qgis::RasterInterfaceCapability::NoCapabilities;
}
 
QList<double> QgsRasterDataProvider::nativeResolutions() const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return QList< double >();
}
 
bool QgsRasterDataProvider::ignoreExtents() const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return false;
}
 
QgsPoint QgsRasterDataProvider::transformCoordinates( const QgsPoint &point, QgsRasterDataProvider::TransformType type )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  Q_UNUSED( point )
  Q_UNUSED( type )
  return QgsPoint();
}
 
bool QgsRasterDataProvider::userNoDataValuesContains( int bandNo, double value ) const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  const QgsRasterRangeList rangeList = mUserNoDataValue.value( bandNo - 1 );
  return QgsRasterRange::contains( value, rangeList );
}
 
void QgsRasterDataProvider::copyBaseSettings( const QgsRasterDataProvider &other )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  mDpi = other.mDpi;
  mSrcNoDataValue = other.mSrcNoDataValue;
  mSrcHasNoDataValue = other.mSrcHasNoDataValue;
  mUseSrcNoDataValue = other.mUseSrcNoDataValue;
  mUserNoDataValue = other.mUserNoDataValue;
  mExtent = other.mExtent;
  mProviderResamplingEnabled = other.mProviderResamplingEnabled;
  mZoomedInResamplingMethod = other.mZoomedInResamplingMethod;
  mZoomedOutResamplingMethod = other.mZoomedOutResamplingMethod;
  mMaxOversampling = other.mMaxOversampling;
 
  if ( mTemporalCapabilities && other.mTemporalCapabilities )
  {
    *mTemporalCapabilities = *other.mTemporalCapabilities;
  }
  if ( mElevationProperties && other.mElevationProperties )
  {
    *mElevationProperties = *other.mElevationProperties;
  }
}
 
static Qgis::RasterResamplingMethod resamplingMethodFromString( const QString &str )
{
  if ( str == "bilinear"_L1 )
  {
    return Qgis::RasterResamplingMethod::Bilinear;
  }
  else if ( str == "cubic"_L1 )
  {
    return Qgis::RasterResamplingMethod::Cubic;
  }
  else if ( str == "cubicSpline"_L1 )
  {
    return Qgis::RasterResamplingMethod::CubicSpline;
  }
  else if ( str == "lanczos"_L1 )
  {
    return Qgis::RasterResamplingMethod::Lanczos;
  }
  else if ( str == "average"_L1 )
  {
    return Qgis::RasterResamplingMethod::Average;
  }
  else if ( str == "mode"_L1 )
  {
    return Qgis::RasterResamplingMethod::Mode;
  }
  else if ( str == "gauss"_L1 )
  {
    return Qgis::RasterResamplingMethod::Gauss;
  }
  return  Qgis::RasterResamplingMethod::Nearest;
}
 
void QgsRasterDataProvider::readXml( const QDomElement &filterElem )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( filterElem.isNull() )
  {
    return;
  }
 
  const QDomElement resamplingElement = filterElem.firstChildElement( u"resampling"_s );
  if ( !resamplingElement.isNull() )
  {
    setMaxOversampling( resamplingElement.attribute( u"maxOversampling"_s, u"2.0"_s ).toDouble() );
    setZoomedInResamplingMethod( resamplingMethodFromString( resamplingElement.attribute( u"zoomedInResamplingMethod"_s ) ) );
    setZoomedOutResamplingMethod( resamplingMethodFromString( resamplingElement.attribute( u"zoomedOutResamplingMethod"_s ) ) );
    enableProviderResampling( resamplingElement.attribute( u"enabled"_s ) == "true"_L1 );
  }
}
 
static QString resamplingMethodToString( Qgis::RasterResamplingMethod method )
{
  switch ( method )
  {
    case Qgis::RasterResamplingMethod::Nearest:
      return u"nearestNeighbour"_s;
    case Qgis::RasterResamplingMethod::Bilinear:
      return u"bilinear"_s;
    case Qgis::RasterResamplingMethod::Cubic:
      return u"cubic"_s;
    case Qgis::RasterResamplingMethod::CubicSpline:
      return u"cubicSpline"_s;
    case Qgis::RasterResamplingMethod::Lanczos:
      return u"lanczos"_s;
    case Qgis::RasterResamplingMethod::Average:
      return u"average"_s;
    case Qgis::RasterResamplingMethod::Mode:
      return u"mode"_s;
    case Qgis::RasterResamplingMethod::Gauss:
      return u"gauss"_s;
  }
  // should not happen
  return u"nearestNeighbour"_s;
}
 
void QgsRasterDataProvider::writeXml( QDomDocument &doc, QDomElement &parentElem ) const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  QDomElement providerElement = doc.createElement( u"provider"_s );
  parentElem.appendChild( providerElement );
 
  QDomElement resamplingElement = doc.createElement( u"resampling"_s );
  providerElement.appendChild( resamplingElement );
 
  resamplingElement.setAttribute( u"enabled"_s,
                                  mProviderResamplingEnabled ? u"true"_s :  u"false"_s );
 
  resamplingElement.setAttribute( u"zoomedInResamplingMethod"_s,
                                  resamplingMethodToString( mZoomedInResamplingMethod ) );
 
  resamplingElement.setAttribute( u"zoomedOutResamplingMethod"_s,
                                  resamplingMethodToString( mZoomedOutResamplingMethod ) );
 
  resamplingElement.setAttribute( u"maxOversampling"_s,
                                  QString::number( mMaxOversampling ) );
}
 
QgsRasterAttributeTable *QgsRasterDataProvider::attributeTable( int bandNumber ) const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  try
  {
    return mAttributeTables.at( bandNumber ).get();
  }
  catch ( std::out_of_range const & )
  {
    return nullptr;
  }
}
 
void QgsRasterDataProvider::setAttributeTable( int bandNumber, QgsRasterAttributeTable *attributeTable )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( attributeTable )
  {
    mAttributeTables[ bandNumber ] = std::unique_ptr<QgsRasterAttributeTable>( attributeTable );
  }
  else
  {
    removeAttributeTable( bandNumber );
  }
}
 
void QgsRasterDataProvider::removeAttributeTable( int bandNumber )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( mAttributeTables.find( bandNumber ) != std::end( mAttributeTables ) )
  {
    mAttributeTables.erase( bandNumber );
  }
}
 
bool QgsRasterDataProvider::writeFileBasedAttributeTable( int bandNumber, const QString &path, QString *errorMessage ) const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  QgsRasterAttributeTable *rat { attributeTable( bandNumber ) };
  if ( ! rat )
  {
    if ( errorMessage )
    {
      *errorMessage = QObject::tr( "Raster has no Raster Attribute Table for band %1" ).arg( bandNumber );
    }
    return false;
  }
 
  return rat->writeToFile( path, errorMessage );
}
 
bool QgsRasterDataProvider::readNativeAttributeTable( QString *errorMessage )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  if ( errorMessage )
  {
    *errorMessage = QObject::tr( "Raster data provider has no native Raster Attribute Table support." );
  }
  return false;
}
 
QString QgsRasterDataProvider::bandDescription( int bandNumber )
{
  Q_UNUSED( bandNumber )
  return QString();
}
 
bool QgsRasterDataProvider::readFileBasedAttributeTable( int bandNumber, const QString &path, QString *errorMessage )
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  auto rat = std::make_unique<QgsRasterAttributeTable>();
  if ( rat->readFromFile( path, errorMessage ) )
  {
    setAttributeTable( bandNumber, rat.release() );
    return true;
  }
  else
  {
    return false;
  }
}
 
bool QgsRasterDataProvider::writeNativeAttributeTable( QString *errorMessage )  //#spellok
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  Q_UNUSED( errorMessage );
  return false;
}
 
QString QgsRasterDataProvider::colorInterpretationName( int bandNo ) const
{
  QGIS_PROTECT_QOBJECT_THREAD_ACCESS
 
  return colorName( colorInterpretation( bandNo ) );
}
 
QString QgsRasterDataProvider::colorName( Qgis::RasterColorInterpretation colorInterpretation ) const
{
  // Modified copy from GDAL
  switch ( colorInterpretation )
  {
    case Qgis::RasterColorInterpretation::Undefined:
      return tr( "Undefined" );
 
    case Qgis::RasterColorInterpretation::GrayIndex:
      return tr( "Gray" );
 
    case Qgis::RasterColorInterpretation::PaletteIndex:
      return tr( "Palette" );
 
    case Qgis::RasterColorInterpretation::RedBand:
      return tr( "Red" );
 
    case Qgis::RasterColorInterpretation::GreenBand:
      return tr( "Green" );
 
    case Qgis::RasterColorInterpretation::BlueBand:
      return tr( "Blue" );
 
    case Qgis::RasterColorInterpretation::AlphaBand:
      return tr( "Alpha" );
 
    case Qgis::RasterColorInterpretation::HueBand:
      return tr( "Hue" );
 
    case Qgis::RasterColorInterpretation::SaturationBand:
      return tr( "Saturation" );
 
    case Qgis::RasterColorInterpretation::LightnessBand:
      return tr( "Lightness" );
 
    case Qgis::RasterColorInterpretation::CyanBand:
      return tr( "Cyan" );
 
    case Qgis::RasterColorInterpretation::MagentaBand:
      return tr( "Magenta" );
 
    case Qgis::RasterColorInterpretation::YellowBand:
      return tr( "Yellow" );
 
    case Qgis::RasterColorInterpretation::BlackBand:
      return tr( "Black" );
 
    case Qgis::RasterColorInterpretation::YCbCr_YBand:
      return tr( "YCbCr_Y" );
 
    case Qgis::RasterColorInterpretation::YCbCr_CbBand:
      return tr( "YCbCr_Cb" );
 
    case Qgis::RasterColorInterpretation::YCbCr_CrBand:
      return tr( "YCbCr_Cr" );
 
    case Qgis::RasterColorInterpretation::ContinuousPalette:
      return tr( "Continuous Palette" );
 
    case Qgis::RasterColorInterpretation::PanBand:
      return tr( "Panchromatic" );
 
    case Qgis::RasterColorInterpretation::CoastalBand:
      return tr( "Coastal" );
 
    case Qgis::RasterColorInterpretation::RedEdgeBand:
      return tr( "Red Edge" );
 
    case Qgis::RasterColorInterpretation::NIRBand:
      return tr( "Near-InfraRed (NIR)" );
 
    case Qgis::RasterColorInterpretation::SWIRBand:
      return tr( "Short-Wavelength InfraRed (SWIR)" );
 
    case Qgis::RasterColorInterpretation::MWIRBand:
      return tr( "Mid-Wavelength InfraRed (MWIR)" );
 
    case Qgis::RasterColorInterpretation::LWIRBand:
      return tr( "Long-Wavelength InfraRed (LWIR)" );
 
    case Qgis::RasterColorInterpretation::TIRBand:
      return tr( "Thermal InfraRed (TIR)" );
 
    case Qgis::RasterColorInterpretation::OtherIRBand:
      return tr( "Other InfraRed" );
 
    case Qgis::RasterColorInterpretation::SAR_Ka_Band:
      return tr( "Synthetic Aperture Radar (SAR) Ka band" );
 
    case Qgis::RasterColorInterpretation::SAR_K_Band:
      return tr( "Synthetic Aperture Radar (SAR) K band" );
 
    case Qgis::RasterColorInterpretation::SAR_Ku_Band:
      return tr( "Synthetic Aperture Radar (SAR) Ku band" );
 
    case Qgis::RasterColorInterpretation::SAR_X_Band:
      return tr( "Synthetic Aperture Radar (SAR) X band" );
 
    case Qgis::RasterColorInterpretation::SAR_C_Band:
      return tr( "Synthetic Aperture Radar (SAR) C band" );
 
    case Qgis::RasterColorInterpretation::SAR_S_Band:
      return tr( "Synthetic Aperture Radar (SAR) S band" );
 
    case Qgis::RasterColorInterpretation::SAR_L_Band:
      return tr( "Synthetic Aperture Radar (SAR) L band" );
 
    case Qgis::RasterColorInterpretation::SAR_P_Band:
      return tr( "Synthetic Aperture Radar (SAR) P band" );
  }
  return QString();
}
 
QgsRasterDataProvider::VirtualRasterParameters QgsRasterDataProvider::decodeVirtualRasterProviderUri( const QString &uri, bool *ok )
{
  QUrl url = QUrl::fromPercentEncoding( uri.toUtf8() );
  const QUrlQuery query( url.query() );
  VirtualRasterParameters components;
 
  if ( ! query.hasQueryItem( u"crs"_s ) )
  {
    QgsDebugError( "crs is missing" );
    if ( ok ) *ok = false;
    return components;
  }
  if ( ! components.crs.createFromString( query.queryItemValue( u"crs"_s ) ) )
  {
    QgsDebugError( "failed to create crs" );
    if ( ok ) *ok = false;
    return components;
  }
 
 
  if ( ! query.hasQueryItem( u"extent"_s ) )
  {
    QgsDebugError( "extent is missing" );
    if ( ok ) *ok = false;
    return components;
  }
  QStringList pointValuesList = query.queryItemValue( u"extent"_s ).split( ',' );
  if ( pointValuesList.size() != 4 )
  {
    QgsDebugError( "the extent is not correct" );
    if ( ok ) *ok = false;
    return components;
  }
  components.extent = QgsRectangle( pointValuesList.at( 0 ).toDouble(), pointValuesList.at( 1 ).toDouble(),
                                    pointValuesList.at( 2 ).toDouble(), pointValuesList.at( 3 ).toDouble() );
 
  if ( ! query.hasQueryItem( u"width"_s ) )
  {
    QgsDebugError( "width is missing" );
    if ( ok ) *ok = false;
    return components;
  }
  bool flagW;
  components.width = query.queryItemValue( u"width"_s ).toInt( & flagW );
  if ( !flagW ||  components.width < 0 )
  {
    QgsDebugError( "invalid or negative width input" );
    if ( ok ) *ok = false;
    return components;
  }
 
  if ( ! query.hasQueryItem( u"height"_s ) )
  {
    QgsDebugError( "height is missing" );
    if ( ok ) *ok = false;
    return components;
  }
  bool flagH;
  components.height = query.queryItemValue( u"height"_s ).toInt( & flagH );
  if ( !flagH ||  components.height < 0 )
  {
    QgsDebugError( "invalid or negative width input" );
    if ( ok ) *ok = false;
    return components;
  }
 
  if ( ! query.hasQueryItem( u"formula"_s ) )
  {
    QgsDebugError( "formula is missing" );
    if ( ok ) *ok = false;
    return components;
  }
  components.formula = query.queryItemValue( u"formula"_s );
 
  for ( const auto &item : query.queryItems() )
  {
    if ( !( item.first.mid( item.first.indexOf( ':' ), -1 ) == ":uri"_L1 ) )
    {
      continue;
    }
 
    VirtualRasterInputLayers rLayer;
    rLayer.name = item.first.mid( 0, item.first.indexOf( ':' ) );
    rLayer.uri = query.queryItemValue( item.first );
    rLayer.provider = query.queryItemValue( item.first.mid( 0, item.first.indexOf( ':' ) ) + u":provider"_s );
 
    if ( rLayer.uri.isNull() || rLayer.provider.isNull() )
    {
      QgsDebugError( "One or more raster information are missing" );
      if ( ok ) *ok = false;
      return components;
    }
 
    components.rInputLayers.append( rLayer ) ;
 
  }
 
  if ( ok ) *ok = true;
  return components;
}
 
QString QgsRasterDataProvider::encodeVirtualRasterProviderUri( const VirtualRasterParameters &parts )
{
  QUrl uri;
  QUrlQuery query;
 
  if ( parts.crs.isValid() )
  {
    query.addQueryItem( u"crs"_s, parts.crs.authid() );
  }
 
  if ( ! parts.extent.isNull() )
  {
    QString rect = QString( "%1,%2,%3,%4" ).arg( qgsDoubleToString( parts.extent.xMinimum() ), qgsDoubleToString( parts.extent.yMinimum() ),
                   qgsDoubleToString( parts.extent.xMaximum() ), qgsDoubleToString( parts.extent.yMaximum() ) );
 
    query.addQueryItem( u"extent"_s, rect );
  }
 
  query.addQueryItem( u"width"_s, QString::number( parts.width ) );
 
  query.addQueryItem( u"height"_s, QString::number( parts.height ) );
 
  query.addQueryItem( u"formula"_s, parts.formula );
 
  if ( ! parts.rInputLayers.isEmpty() )
  {
    for ( const auto &it : parts.rInputLayers )
    {
      query.addQueryItem( it.name + u":uri"_s, it.uri );
      query.addQueryItem( it.name + u":provider"_s, it.provider );
    }
  }
  uri.setQuery( query );
  return QString( QUrl::toPercentEncoding( uri.toEncoded() ) );
}
 
bool QgsRasterDataProvider::hasReportsDuringClose() const
{
  return false;
}
 
bool QgsRasterDataProvider::closeWithProgress( QgsFeedback * /* feedback */ )
{
  return false;
}
 
 
#undef ERR