31#include "qgsgdalprovider.h"
73#include <QApplication>
81#include <QFontMetrics>
88#include <QRegularExpression>
92#include "moc_qgsrasterlayer.cpp"
97#define ERR(message) QGS_ERROR_MESSAGE(message,"Raster layer")
117 , QSTRING_NOT_SET( u
"Not Set"_s )
118 , TRSTRING_NOT_SET( tr(
"Not Set" ) )
128 const QString &baseName,
129 const QString &providerKey,
133 , QSTRING_NOT_SET( u
"Not Set"_s )
134 , TRSTRING_NOT_SET( tr(
"Not Set" ) )
151 setDataSource( uri, baseName, providerKey, providerOptions, providerFlags );
155 mTemporalProperties->setDefaultsFromDataProviderTemporalCapabilities( mDataProvider->temporalCapabilities() );
177 options.transformContext = mDataProvider->transformContext();
181 layer->mElevationProperties = mElevationProperties->clone();
182 layer->mElevationProperties->setParent( layer.get() );
187 for (
int i = 1; i < mPipe->size(); i++ )
189 if ( mPipe->at( i ) )
190 layer->pipe()->set( mPipe->at( i )->clone() );
192 layer->pipe()->setDataDefinedProperties( mPipe->dataDefinedProperties() );
193 layer->setResamplingStage( mPipe->resamplingStage() );
194 if ( mDataProvider && layer->dataProvider() )
196 layer->dataProvider()->setZoomedInResamplingMethod( mDataProvider->zoomedInResamplingMethod() );
197 layer->dataProvider()->setZoomedOutResamplingMethod( mDataProvider->zoomedOutResamplingMethod() );
200 layer->setLabelsEnabled( mLabelsEnabled );
202 layer->setLabeling( mLabeling->clone() );
204 return layer.release();
211 if ( !mElevationProperties->isEnabled() )
225 const bool myIsValid = QgsGdalProvider::isValidRasterFileName( fileNameQString, retErrMsg );
240 const QFileInfo fi(
name );
246 t = fi.lastModified();
273 if ( !mDataProvider )
return 0;
274 return mDataProvider->bandCount();
281 if ( !mDataProvider )
return QString();
282 return mDataProvider->generateBandName( bandNo );
289 if ( !mDataProvider )
291 return mDataProvider->attributeTable( bandNoInt );
298 if ( !mDataProvider )
302 for (
int bandNo = 1; bandNo <=
bandCount(); ++bandNo )
330 return mDataProvider;
337 return mDataProvider;
346 mDataProvider->reloadData();
375 bool restoreOldResamplingStage =
false;
383 if ( mDataProvider &&
388 restoreOldResamplingStage =
true;
397 drawer.
draw( theQPainter, rasterViewPort, qgsMapToPixel );
399 if ( restoreOldResamplingStage )
404 QgsDebugMsgLevel( u
"total raster draw time (ms): %1"_s.arg( time.elapsed(), 5 ), 4 );
412 return renderer ?
renderer->legendSymbologyItems() : QList< QPair< QString, QColor > >();;
419 if ( !mDataProvider )
423 QString myMetadata = u
"<html><head></head>\n<body>\n"_s;
428 myMetadata += u
"<h1>"_s + tr(
"Information from provider" ) + u
"</h1>\n<hr>\n"_s + u
"<table class=\"list-view\">\n"_s;
430 myMetadata += u
"\n"_s %
432 u
"<tr><td class=\"highlight\">"_s % tr(
"Extent" ) % u
"</td><td>"_s %
extent().
toString() % u
"</td></tr>\n"_s %
435 u
"<tr><td class=\"highlight\">"_s % tr(
"Width" ) % u
"</td><td>"_s;
437 myMetadata += QString::number(
width() );
439 myMetadata += tr(
"n/a" );
440 myMetadata += u
"</td></tr>\n"_s %
443 u
"<tr><td class=\"highlight\">"_s + tr(
"Height" ) + u
"</td><td>"_s;
445 myMetadata += QString::number(
height() );
447 myMetadata += tr(
"n/a" );
448 myMetadata += u
"</td></tr>\n"_s %
451 u
"<tr><td class=\"highlight\">"_s % tr(
"Data type" ) % u
"</td><td>"_s;
453 switch ( mDataProvider->sourceDataType( 1 ) )
456 myMetadata += tr(
"Byte - Eight bit unsigned integer" );
459 myMetadata += tr(
"Int8 - Eight bit signed integer" );
462 myMetadata += tr(
"UInt16 - Sixteen bit unsigned integer " );
465 myMetadata += tr(
"Int16 - Sixteen bit signed integer " );
468 myMetadata += tr(
"UInt32 - Thirty two bit unsigned integer " );
471 myMetadata += tr(
"Int32 - Thirty two bit signed integer " );
474 myMetadata += tr(
"Float32 - Thirty two bit floating point " );
477 myMetadata += tr(
"Float64 - Sixty four bit floating point " );
480 myMetadata += tr(
"CInt16 - Complex Int16 " );
483 myMetadata += tr(
"CInt32 - Complex Int32 " );
486 myMetadata += tr(
"CFloat32 - Complex Float32 " );
489 myMetadata += tr(
"CFloat64 - Complex Float64 " );
492 myMetadata += tr(
"Could not determine raster data type." );
494 myMetadata += u
"</td></tr>\n"_s %
497 mDataProvider->htmlMetadata() %
500 u
"</table>\n<br><br>"_s;
506 myMetadata += u
"<h1>"_s % tr(
"Identification" ) % u
"</h1>\n<hr>\n"_s %
511 u
"<h1>"_s % tr(
"Extent" ) % u
"</h1>\n<hr>\n"_s %
516 u
"<h1>"_s % tr(
"Access" ) % u
"</h1>\n<hr>\n"_s %
521 u
"</table>\n<br><br><h1>"_s % tr(
"Bands" ) % u
"</h1>\n<hr>\n<table class=\"list-view\">\n"_s %
524 u
"<tr><td class=\"highlight\">"_s % tr(
"Band count" ) % u
"</td><td>"_s % QString::number(
bandCount() ) % u
"</td></tr>\n"_s;
527 myMetadata += u
"</table>\n<br><table width=\"100%\" class=\"tabular-view\">\n"_s %
528 u
"<tr><th>"_s % tr(
"Number" ) % u
"</th><th>"_s % tr(
"Band" ) % u
"</th><th>"_s % tr(
"NoData" ) % u
"</th><th>"_s %
529 tr(
"Min" ) % u
"</th><th>"_s % tr(
"Max" ) % u
"</th></tr>\n"_s;
536 rowClass = u
"class=\"odd-row\""_s;
538 myMetadata += u
"<tr "_s % rowClass % u
"><td>"_s % QString::number( i ) % u
"</td><td>"_s %
bandName( i ) % u
"</td><td>"_s;
541 myMetadata += QString::number(
dataProvider()->sourceNoDataValue( i ) );
543 myMetadata += tr(
"n/a" );
544 myMetadata +=
"</td>"_L1;
549 myMetadata += u
"<td>"_s % QString::number( myRasterBandStats.
minimumValue,
'f', 10 ) % u
"</td>"_s %
550 u
"<td>"_s % QString::number( myRasterBandStats.
maximumValue,
'f', 10 ) % u
"</td>"_s;
554 myMetadata += u
"<td>"_s % tr(
"n/a" ) % u
"</td><td>"_s % tr(
"n/a" ) % u
"</td>"_s;
557 myMetadata +=
"</tr>\n"_L1;
561 myMetadata += u
"</table>\n<br><br>"_s %
564 u
"<h1>"_s % tr(
"Contacts" ) % u
"</h1>\n<hr>\n"_s %
569 u
"<h1>"_s % tr(
"References" ) % u
"</h1>\n<hr>\n"_s %
574 u
"<h1>"_s % tr(
"History" ) % u
"</h1>\n<hr>\n"_s %
578 u
"\n</body>\n</html>\n"_s;
603 if ( mDataProvider &&
608 const QList<QgsColorRampShader::ColorRampItem> myColorRampItemList = mDataProvider->colorTable( bandNumber );
609 if ( !myColorRampItemList.isEmpty() )
615 const int mySize = 100;
616 QPixmap myPalettePixmap( mySize, mySize );
617 QPainter myQPainter( &myPalettePixmap );
619 QImage myQImage = QImage( mySize, mySize, QImage::Format_RGB32 );
621 myPalettePixmap.fill();
623 const double myStep = (
static_cast< double >( myColorRampItemList.size() ) - 1 ) /
static_cast< double >( mySize * mySize );
624 double myValue = 0.0;
625 for (
int myRow = 0; myRow < mySize; myRow++ )
627 QRgb *myLineBuffer =
reinterpret_cast< QRgb *
>( myQImage.scanLine( myRow ) );
628 for (
int myCol = 0; myCol < mySize; myCol++ )
630 myValue = myStep *
static_cast< double >( myCol + myRow * mySize );
632 myShader.
shade( myValue, &c1, &c2, &c3, &c4 );
633 myLineBuffer[ myCol ] = qRgba( c1, c2, c3, c4 );
637 myQPainter.drawImage( 0, 0, myQImage );
638 return myPalettePixmap;
640 const QPixmap myNullPixmap;
646 const QPixmap myNullPixmap;
661 if ( mDataProvider &&
664 return mDataProvider->extent().width() / mDataProvider->xSize();
673 if ( mDataProvider &&
676 return mDataProvider->extent().height() / mDataProvider->ySize();
685 if ( !mPipe->renderer() || mPipe->renderer()->opacity() ==
opacity )
688 mPipe->renderer()->setOpacity(
opacity );
697 return mPipe->renderer() ? mPipe->renderer()->opacity() : 1.0;
700void QgsRasterLayer::init()
723 mPipe = std::make_unique< QgsRasterPipe >();
724 mDataProvider =
nullptr;
740 mDataProvider = qobject_cast< QgsRasterDataProvider * >(
mPreloadedProvider.release() );
744 std::unique_ptr< QgsScopedRuntimeProfile > profile;
746 profile = std::make_unique< QgsScopedRuntimeProfile >( tr(
"Create %1 provider" ).arg( provider ), u
"projectload"_s );
751 if ( !mDataProvider )
758 mDataProvider->setParent(
this );
761 if ( !mPipe->set( mDataProvider ) )
764 mDataProvider =
nullptr;
769 if ( !mDataProvider->isValid() )
782 if ( provider ==
"gdal"_L1 )
813 QgsDebugMsgLevel(
"bandCount = " + QString::number( mDataProvider->bandCount() ), 4 );
815 const int bandCount = mDataProvider->bandCount();
868 QString errorMessage;
869 bool hasRat { mDataProvider->readNativeAttributeTable( &errorMessage ) };
872 errorMessage.clear();
873 QgsDebugMsgLevel(
"Native Raster Raster Attribute Table read failed " + errorMessage, 2 );
874 if ( QFile::exists( mDataProvider->dataSourceUri( ) +
".vat.dbf" ) )
876 auto rat = std::make_unique<QgsRasterAttributeTable>();
877 hasRat = rat->readFromFile( mDataProvider->dataSourceUri( ) +
".vat.dbf", &errorMessage );
880 if ( rat->isValid( &errorMessage ) )
882 mDataProvider->setAttributeTable( 1, rat.release() );
883 QgsDebugMsgLevel(
"DBF Raster Attribute Table successfully read from " + mDataProvider->dataSourceUri( ) +
".vat.dbf", 2 );
887 QgsDebugMsgLevel(
"DBF Raster Attribute Table is not valid, skipping: " + errorMessage, 2 );
892 QgsDebugMsgLevel(
"DBF Raster Attribute Table read failed " + errorMessage, 2 );
901 switch ( mRasterType )
919 const QList<QgsColorRampShader::ColorRampItem> colorTable = mDataProvider->colorTable( 1 );
951 for (
int bandNo = 1; bandNo <= mDataProvider->bandCount(); bandNo++ )
955 if (
auto *lRenderer = mPipe->renderer() )
957 lRenderer->setAlphaBand( bandNo );
976 QString resampling = settings.
value( u
"/Raster/defaultZoomedInResampling"_s, u
"nearest neighbour"_s ).toString();
977 if ( resampling ==
"bilinear"_L1 )
982 else if ( resampling ==
"cubic"_L1 )
987 resampling = settings.
value( u
"/Raster/defaultZoomedOutResampling"_s, u
"nearest neighbour"_s ).toString();
988 if ( resampling ==
"bilinear"_L1 )
996 mDataProvider->setMaxOversampling( maxOversampling );
1011 mPipe->set( projector );
1039 mElevationProperties->setEnabled(
true );
1053 if ( mDataProvider->supportsSubsetString() )
1063void QgsRasterLayer::setDataSourcePrivate(
const QString &dataSource,
const QString &baseName,
const QString &provider,
1068 const bool hadRenderer(
renderer() );
1070 QDomImplementation domImplementation;
1071 QDomDocumentType documentType;
1074 bool loadDefaultStyleFlag =
false;
1077 loadDefaultStyleFlag =
true;
1081 if ( hadRenderer && ! loadDefaultStyleFlag )
1083 documentType = domImplementation.createDocumentType(
1084 u
"qgis"_s, u
"http://mrcc.com/qgis.dtd"_s, u
"SYSTEM"_s );
1086 QDomDocument doc = QDomDocument( documentType );
1087 QDomElement styleElem = doc.createElement( u
"qgis"_s );
1089 const QgsReadWriteContext writeContext;
1090 if ( !
writeSymbology( styleElem, doc, errorMsg, writeContext ) )
1092 QgsDebugError( u
"Could not store symbology for layer %1: %2"_s
1098 doc.appendChild( styleElem );
1100 mOriginalStyleDocument = doc;
1101 mOriginalStyleElement = styleElem;
1105 if ( mDataProvider )
1106 closeDataProvider();
1110 for (
int i = mPipe->size() - 1; i >= 0; --i )
1120 if ( mDataProvider )
1126 bool defaultLoadedFlag =
false;
1127 bool restoredStyle =
false;
1128 if ( loadDefaultStyleFlag )
1132 else if ( !mOriginalStyleElement.isNull() )
1134 QgsReadWriteContext readContext;
1135 if ( !
readSymbology( mOriginalStyleElement, errorMsg, readContext ) )
1137 QgsDebugError( u
"Could not restore symbology for layer %1: %2"_s
1144 restoredStyle =
true;
1151 if ( !defaultLoadedFlag && !restoredStyle )
1158void QgsRasterLayer::writeRasterAttributeTableExternalPaths( QDomNode &layerNode, QDomDocument &doc,
const QgsReadWriteContext &context )
const
1164 QDomElement elem = doc.createElement( u
"FileBasedAttributeTables"_s );
1165 for (
int bandNo = 1; bandNo <=
bandCount(); bandNo++ )
1169 QDomElement ratElem = doc.createElement( u
"AttributeTable"_s );
1170 ratElem.setAttribute( u
"band"_s, bandNo );
1172 elem.appendChild( ratElem );
1175 layerNode.appendChild( elem );
1179void QgsRasterLayer::readRasterAttributeTableExternalPaths(
const QDomNode &layerNode,
QgsReadWriteContext &context )
const
1181 const QDomElement ratsElement = layerNode.firstChildElement( u
"FileBasedAttributeTables"_s );
1182 if ( !ratsElement.isNull() && ratsElement.childNodes().count() > 0 )
1184 const QDomNodeList ratElements { ratsElement.childNodes() };
1185 for (
int idx = 0; idx < ratElements.count(); idx++ )
1187 const QDomNode ratElement { ratElements.at( idx ) };
1188 if ( ratElement.attributes().contains( u
"band"_s )
1189 && ratElement.attributes().contains( u
"path"_s ) )
1192 const int band { ratElement.attributes().namedItem( u
"band"_s ).nodeValue().toInt( &ok ) };
1195 if ( ! ok || band <= 0 || band >
bandCount() )
1197 QgsMessageLog::logMessage( tr(
"Error reading raster attribute table: invalid band %1." ).arg( band ), tr(
"Raster" ) );
1201 const QString path { context.
pathResolver().
readPath( ratElement.attributes().namedItem( u
"path"_s ).nodeValue() ) };
1202 if ( ! QFile::exists( path ) )
1204 QgsMessageLog::logMessage( tr(
"Error loading raster attribute table, file not found: %1." ).arg( path ), tr(
"Raster" ) );
1208 auto rat = std::make_unique<QgsRasterAttributeTable>();
1209 QString errorMessage;
1210 if ( ! rat->readFromFile( path, &errorMessage ) )
1212 QgsMessageLog::logMessage( tr(
"Error loading raster attribute table from path %1: %2" ).arg( path, errorMessage ), tr(
"Raster" ) );
1217 mDataProvider->setAttributeTable( band, rat.release() );
1223void QgsRasterLayer::closeDataProvider()
1228 mPipe->remove( mDataProvider );
1229 mDataProvider =
nullptr;
1237 double &min,
double &max )
1248 return mDataProvider ? mDataProvider->ignoreExtents() :
false;
1255 return mTemporalProperties;
1262 return mElevationProperties;
1273 generateLookupTableFlag,
1274 mPipe->renderer() );
1281 bool generateLookupTableFlag,
1287 if ( !rasterRenderer || !mDataProvider )
1293 QList<QgsContrastEnhancement *> myEnhancements;
1294 QgsRasterMinMaxOrigin myMinMaxOrigin;
1295 QgsRasterRenderer *myRasterRenderer =
nullptr;
1296 QgsSingleBandGrayRenderer *myGrayRenderer =
nullptr;
1297 QgsSingleBandPseudoColorRenderer *myPseudoColorRenderer =
nullptr;
1298 QgsMultiBandColorRenderer *myMultiBandRenderer =
nullptr;
1299 const QString rendererType = rasterRenderer->
type();
1300 if ( rendererType ==
"singlebandgray"_L1 )
1302 myGrayRenderer =
dynamic_cast<QgsSingleBandGrayRenderer *
>( rasterRenderer );
1303 if ( !myGrayRenderer )
1308 myRasterRenderer = myGrayRenderer;
1311 else if ( rendererType ==
"multibandcolor"_L1 )
1313 myMultiBandRenderer =
dynamic_cast<QgsMultiBandColorRenderer *
>( rasterRenderer );
1314 if ( !myMultiBandRenderer )
1319 myRasterRenderer = myMultiBandRenderer;
1322 else if ( rendererType ==
"singlebandpseudocolor"_L1 )
1324 myPseudoColorRenderer =
dynamic_cast<QgsSingleBandPseudoColorRenderer *
>( rasterRenderer );
1325 if ( !myPseudoColorRenderer )
1329 myBands << myPseudoColorRenderer->
inputBand();
1330 myRasterRenderer = myPseudoColorRenderer;
1331 myMinMaxOrigin = myPseudoColorRenderer->
minMaxOrigin();
1338 for (
const int myBand : std::as_const( myBands ) )
1343 auto myEnhancement = std::make_unique<QgsContrastEnhancement>(
static_cast< Qgis::DataType >( myType ) );
1344 myEnhancement->setContrastEnhancementAlgorithm(
algorithm, generateLookupTableFlag );
1350 if ( rendererType ==
"singlebandpseudocolor"_L1 )
1353 if ( ! myPseudoColorRenderer )
1361 bool minMaxChanged {
false };
1362 if ( ! std::isnan( min ) )
1365 minMaxChanged =
true;
1368 if ( ! std::isnan( max ) )
1371 minMaxChanged =
true;
1374 if ( minMaxChanged && myPseudoColorRenderer->
shader() )
1376 QgsColorRampShader *colorRampShader =
dynamic_cast<QgsColorRampShader *
>( myPseudoColorRenderer->
shader()->rasterShaderFunction() );
1377 if ( colorRampShader )
1385 myEnhancement->setMinimumValue( min );
1386 myEnhancement->setMaximumValue( max );
1387 myEnhancements.append( myEnhancement.release() );
1392 myEnhancements.append(
nullptr );
1397 if ( rendererType ==
"singlebandgray"_L1 && myGrayRenderer )
1401 else if ( rendererType ==
"multibandcolor"_L1 && myMultiBandRenderer )
1409 qDeleteAll( myEnhancements );
1412 if (
extent != QgsRectangle() &&
1417 if ( myRasterRenderer )
1422 if ( rasterRenderer ==
renderer() )
1439 ce = singleBandRenderer->contrastEnhancement();
1477 if ( !
isValid() || !mDataProvider )
1479 QgsDebugMsgLevel( u
"invoked with invalid layer or null mDataProvider"_s, 3 );
1482 if ( !mDataProvider->supportsSubsetString() )
1486 return mDataProvider->subsetString();
1493 if ( !
isValid() || !mDataProvider )
1495 QgsDebugMsgLevel( u
"invoked with invalid layer or null mDataProvider or while editing"_s, 3 );
1500 if ( !mDataProvider->supportsSubsetString() )
1505 if ( subset == mDataProvider->subsetString() )
1508 const bool res = mDataProvider->setSubsetString( subset );
1516 QList<double> minValues;
1517 QList<double> maxValues;
1519 for (
const int bandIdx :
renderer()->usesBands() )
1527 minValues.append( min );
1528 maxValues.append( max );
1547 QString defaultLimits;
1552 key = u
"singleBand"_s;
1562 key = u
"multiBandSingleByte"_s;
1570 key = u
"multiBandMultiByte"_s;
1578 if ( key.isEmpty() )
1580 QgsDebugMsgLevel( u
"No default contrast enhancement for this drawing style"_s, 2 );
1587 const QString myAlgorithmString = mySettings.value(
"/Raster/defaultContrastEnhancementAlgorithm/" + key, defaultAlg ).toString();
1592 const QString myLimitsString = mySettings.value(
"/Raster/defaultContrastEnhancementLimits/" + key, defaultLimits ).toString();
1618 if ( mDataProvider )
1620 QgsDebugMsgLevel( u
"About to mDataProvider->setLayerOrder(layers)."_s, 4 );
1621 mDataProvider->setLayerOrder( layers );
1630 if ( mDataProvider )
1632 QgsDebugMsgLevel( u
"About to mDataProvider->setSubLayerVisibility(name, vis)."_s, 4 );
1633 mDataProvider->setSubLayerVisibility(
name, vis );
1641 if ( !mDataProvider )
1643 return mDataProvider->timestamp();
1650 if (
auto *lRenderer = mPipe->renderer() )
1652 if ( !lRenderer->accept( visitor ) )
1662 return mLabelsEnabled &&
static_cast< bool >( mLabeling );
1669 mLabelsEnabled = enabled;
1676 return mLabeling.get();
1683 return mLabeling.get();
1701 context.setExtraProperties( props );
1721 QDomElement constraintElem = doc.createElement( u
"sld:LayerFeatureConstraints"_s );
1722 node.appendChild( constraintElem );
1724 const QDomElement featureTypeConstraintElem = doc.createElement( u
"sld:FeatureTypeConstraint"_s );
1725 constraintElem.appendChild( featureTypeConstraintElem );
1727 QDomElement userStyleElem = doc.createElement( u
"sld:UserStyle"_s );
1728 node.appendChild( userStyleElem );
1730 if ( !
name().isEmpty() )
1732 QDomElement nameElem = doc.createElement( u
"sld:Name"_s );
1733 nameElem.appendChild( doc.createTextNode(
name() ) );
1734 userStyleElem.appendChild( nameElem );
1740 QDomElement abstractElem = doc.createElement( u
"sld:Abstract"_s );
1741 abstractElem.appendChild( doc.createTextNode(
abstract ) );
1742 userStyleElem.appendChild( abstractElem );
1746 if ( !
title.isEmpty() )
1748 QDomElement titleElem = doc.createElement( u
"sld:Title"_s );
1749 titleElem.appendChild( doc.createTextNode(
title ) );
1750 userStyleElem.appendChild( titleElem );
1753 QDomElement featureTypeStyleElem = doc.createElement( u
"sld:FeatureTypeStyle"_s );
1754 userStyleElem.appendChild( featureTypeStyleElem );
1764 QDomElement typeStyleNameElem = doc.createElement( u
"sld:Name"_s );
1765 featureTypeStyleElem.appendChild( typeStyleNameElem );
1768 QDomElement typeStyleRuleElem = doc.createElement( u
"sld:Rule"_s );
1769 featureTypeStyleElem.appendChild( typeStyleRuleElem );
1777 QDomElement minScaleElem = doc.createElement( u
"sld:MinScaleDenominator"_s );
1778 minScaleElem.appendChild( doc.createTextNode( QString::number(
maximumScale() ) ) );
1779 typeStyleRuleElem.appendChild( minScaleElem );
1782 QDomElement maxScaleElem = doc.createElement( u
"sld:MaxScaleDenominator"_s );
1783 maxScaleElem.appendChild( doc.createTextNode( QString::number(
minimumScale() ) ) );
1784 typeStyleRuleElem.appendChild( maxScaleElem );
1788 mPipe->renderer()->toSld( doc, typeStyleRuleElem, context );
1793 const QDomNodeList elements = typeStyleRuleElem.elementsByTagName( u
"sld:RasterSymbolizer"_s );
1794 if ( elements.size() != 0 )
1797 QDomElement rasterSymbolizerElem = elements.at( 0 ).toElement();
1800 auto vendorOptionWriter = [&]( QString
name, QString value )
1802 QDomElement vendorOptionElem = doc.createElement( u
"sld:VendorOption"_s );
1803 vendorOptionElem.setAttribute( u
"name"_s,
name );
1804 vendorOptionElem.appendChild( doc.createTextNode( value ) );
1805 rasterSymbolizerElem.appendChild( vendorOptionElem );
1810 vendorOptionWriter( u
"invertColors"_s, QString::number( 1 ) );
1820 property = u
"lightness"_s;
1823 property = u
"luminosity"_s;
1826 property = u
"average"_s;
1832 if ( !property.isEmpty() )
1833 vendorOptionWriter( u
"grayScale"_s, property );
1839 vendorOptionWriter( u
"colorizeOn"_s, QString::number(
hueSaturationFilter()->colorizeOn() ) );
1840 vendorOptionWriter( u
"colorizeRed"_s, QString::number(
hueSaturationFilter()->colorizeColor().red() ) );
1841 vendorOptionWriter( u
"colorizeGreen"_s, QString::number(
hueSaturationFilter()->colorizeColor().green() ) );
1842 vendorOptionWriter( u
"colorizeBlue"_s, QString::number(
hueSaturationFilter()->colorizeColor().blue() ) );
1844 vendorOptionWriter( u
"colorizeStrength"_s, QString::number(
hueSaturationFilter()->colorizeStrength() / 100.0 ) );
1845 vendorOptionWriter( u
"saturation"_s, QString::number(
hueSaturationFilter()->colorizeColor().saturationF() ) );
1854 const double sF = ( s - ( -100.0 ) ) / ( 100.0 - ( -100.0 ) );
1855 vendorOptionWriter( u
"saturation"_s, QString::number( sF ) );
1864 const double bF = ( b - ( -255.0 ) ) / ( 255.0 - ( -255.0 ) );
1865 vendorOptionWriter( u
"brightness"_s, QString::number( bF ) );
1873 const double cF = (
c - ( -100.0 ) ) / ( 100.0 - ( -100.0 ) );
1874 vendorOptionWriter( u
"contrast"_s, QString::number( cF ) );
1887 if ( newProps.contains( u
"contrast"_s ) )
1890 double contrast = newProps[ u
"contrast"_s ].toDouble();
1891 double percentage = ( contrast - ( -100.0 ) ) / ( 100.0 - ( -100.0 ) );
1892 if ( percentage <= 0.5 )
1895 gamma = percentage / 0.5;
1902 QDomElement globalContrastEnhancementElem = doc.createElement( u
"sld:ContrastEnhancement"_s );
1903 rasterSymolizerElem.appendChild( globalContrastEnhancementElem );
1905 QDomElement gammaValueElem = doc.createElement( u
"sld:GammaValue"_s );
1906 gammaValueElem.appendChild( doc.createTextNode( QString::number( gamma ) ) );
1907 globalContrastEnhancementElem.appendChild( gammaValueElem );
1934 return mPipe->renderer();
1941 return mPipe->resampleFilter();
1948 return mPipe->brightnessFilter();
1955 return mPipe->hueSaturationFilter();
1973 if ( mDataProvider )
1982 if ( ! mDataProvider )
1983 return QStringList();
1984 return mDataProvider->subLayers();
1993 QImage image( size, format );
1998 if ( image.format() == QImage::Format_Indexed8 )
2000 image.setColor( 0, bgColor.rgba() );
2005 image.fill( bgColor );
2010 double mapUnitsPerPixel;
2014 if (
extent.width() /
extent.height() >=
static_cast< double >( image.width() ) / image.height() )
2016 mapUnitsPerPixel =
extent.width() / image.width();
2017 y = ( image.height() -
extent.height() / mapUnitsPerPixel ) / 2;
2021 mapUnitsPerPixel =
extent.height() / image.height();
2022 x = ( image.width() -
extent.width() / mapUnitsPerPixel ) / 2;
2025 const double pixelWidth =
extent.width() / mapUnitsPerPixel;
2026 const double pixelHeight =
extent.height() / mapUnitsPerPixel;
2030 rasterViewPort->
mWidth = image.width();
2031 rasterViewPort->
mHeight = image.height();
2039 QPainter *painter =
new QPainter( &image );
2040 draw( painter, rasterViewPort, mapToPixel );
2041 delete rasterViewPort;
2055 Q_UNUSED( errorMessage )
2058 QDomElement rasterRendererElem;
2060 const QDomElement layerElement = layer_node.toElement();
2070 QDomNode pipeNode = layer_node.firstChildElement( u
"pipe"_s );
2071 if ( pipeNode.isNull() )
2073 pipeNode = layer_node;
2077 if ( !layer_node.firstChildElement( u
"rasterproperties"_s ).isNull() )
2080 QDomNode layerNodeCopy = layer_node.cloneNode();
2081 QDomDocument doc = layerNodeCopy.ownerDocument();
2082 QDomElement rasterPropertiesElem = layerNodeCopy.firstChildElement( u
"rasterproperties"_s );
2085 rasterRendererElem = layerNodeCopy.firstChildElement( u
"rasterrenderer"_s );
2090 rasterRendererElem = pipeNode.firstChildElement( u
"rasterrenderer"_s );
2093 if ( !rasterRendererElem.isNull() )
2095 const QString rendererType = rasterRendererElem.attribute( u
"type"_s );
2108 const QDomElement brightnessElem = pipeNode.firstChildElement( u
"brightnesscontrast"_s );
2109 if ( !brightnessElem.isNull() )
2119 const QDomElement hueSaturationElem = pipeNode.firstChildElement( u
"huesaturation"_s );
2120 if ( !hueSaturationElem.isNull() )
2130 const QDomElement resampleElem = pipeNode.firstChildElement( u
"rasterresampler"_s );
2131 if ( !resampleElem.isNull() )
2138 if ( mDataProvider )
2140 const QDomElement providerElem = pipeNode.firstChildElement( u
"provider"_s );
2141 if ( !providerElem.isNull() )
2143 mDataProvider->readXml( providerElem );
2148 const QDomNode resamplingStageElement = pipeNode.namedItem( u
"resamplingStage"_s );
2149 if ( !resamplingStageElement.isNull() )
2151 const QDomElement e = resamplingStageElement.toElement();
2152 if ( e.text() ==
"provider"_L1 )
2154 else if ( e.text() ==
"resamplingFilter"_L1 )
2159 const QDomNode blendModeNode = layer_node.namedItem( u
"blendMode"_s );
2160 if ( !blendModeNode.isNull() )
2162 const QDomElement e = blendModeNode.toElement();
2166 const QDomElement elemDataDefinedProperties = layer_node.firstChildElement( u
"pipe-data-defined-properties"_s );
2167 if ( !elemDataDefinedProperties.isNull() )
2172 if ( categories.testFlag(
Labeling ) )
2176 QDomElement labelingElement = layer_node.firstChildElement( u
"labeling"_s );
2177 if ( !labelingElement.isNull() )
2180 mLabelsEnabled = layer_node.toElement().attribute( u
"labelsEnabled"_s, u
"0"_s ).toInt();
2185 if ( categories.testFlag(
MapTips ) )
2187 QDomElement mapTipElem = layer_node.namedItem( u
"mapTip"_s ).toElement();
2195 readRasterAttributeTableExternalPaths( layer_node, context );
2198 if ( categories.testFlag(
Legend ) )
2202 const QDomElement legendElem = layer_node.firstChildElement( u
"legend"_s );
2204 if ( rasterLegend && !legendElem.isNull() )
2206 rasterLegend->
readXml( legendElem, context );
2208 else if ( rasterLegend )
2225 return readSymbology( node, errorMessage, context, categories );
2236 const QDomNode pkeyNode = layer_node.namedItem( u
"provider"_s );
2238 if ( pkeyNode.isNull() )
2244 const QDomElement pkeyElt = pkeyNode.toElement();
2258 const QDomNode rpNode = layer_node.namedItem( u
"rasterproperties"_s );
2269 QDomElement layerElement = rpNode.firstChildElement( u
"wmsSublayer"_s );
2270 while ( !layerElement.isNull() )
2275 uri.
setParam( u
"layers"_s, layerElement.namedItem( u
"name"_s ).toElement().text() );
2278 uri.
setParam( u
"styles"_s, layerElement.namedItem( u
"style"_s ).toElement().text() );
2280 layerElement = layerElement.nextSiblingElement( u
"wmsSublayer"_s );
2284 uri.
setParam( u
"format"_s, rpNode.namedItem( u
"wmsFormat"_s ).toElement().text() );
2301 const QDomNode extentNode = layer_node.namedItem( u
"extent"_s );
2302 if ( !extentNode.isNull() )
2314 mOriginalStyleElement = layer_node.namedItem( u
"originalStyle"_s ).firstChildElement();
2315 if ( mOriginalStyleElement.isNull() )
2316 mOriginalStyleElement = layer_node.toElement();
2317 mOriginalStyleDocument = layer_node.ownerDocument();
2319 if ( ! mDataProvider )
2343 QDomNode stampNode = layer_node.namedItem(
"timestamp" );
2344 if ( !stampNode.isNull() )
2346 QDateTime stamp = QDateTime::fromString( stampNode.toElement().text(), Qt::ISODate );
2348 if ( stamp < mDataProvider->dataTimestamp() )
2351 closeDataProvider();
2354 if ( !
isValid() )
return false;
2360 const QDomElement noDataElement = layer_node.firstChildElement( u
"noData"_s );
2362 const QDomNodeList noDataBandList = noDataElement.elementsByTagName( u
"noDataList"_s );
2364 for (
int i = 0; mDataProvider && i < noDataBandList.size(); ++i )
2366 const QDomElement bandElement = noDataBandList.at( i ).toElement();
2368 const int bandNo = bandElement.attribute( u
"bandNo"_s ).toInt( &ok );
2370 if ( ok && ( bandNo > 0 ) && ( bandNo <= mDataProvider->
bandCount() ) )
2372 mDataProvider->setUseSourceNoDataValue( bandNo, bandElement.attribute( u
"useSrcNoData"_s ).toInt() );
2375 const QDomNodeList rangeList = bandElement.elementsByTagName( u
"noDataRange"_s );
2377 myNoDataRangeList.reserve( rangeList.size() );
2378 for (
int j = 0; j < rangeList.size(); ++j )
2380 const QDomElement rangeElement = rangeList.at( j ).toElement();
2381 const QgsRasterRange myNoDataRange( rangeElement.attribute( u
"min"_s ).toDouble(),
2382 rangeElement.attribute( u
"max"_s ).toDouble() );
2383 QgsDebugMsgLevel( u
"min = %1 %2"_s.arg( rangeElement.attribute(
"min" ) ).arg( myNoDataRange.
min() ), 4 );
2384 myNoDataRangeList << myNoDataRange;
2386 mDataProvider->setUserNoDataValue( bandNo, myNoDataRangeList );
2390 readRasterAttributeTableExternalPaths( layer_node, context );
2402 Q_UNUSED( errorMessage )
2405 QDomElement layerElement = layer_node.toElement();
2409 if ( categories.testFlag(
Labeling ) )
2413 QDomElement labelingElement = mLabeling->save( document, context );
2414 layerElement.appendChild( labelingElement );
2416 if ( mLabelsEnabled )
2417 layerElement.setAttribute( u
"labelsEnabled"_s, u
"1"_s );
2421 if ( categories.testFlag(
MapTips ) )
2423 QDomElement mapTipElem = document.createElement( u
"mapTip"_s );
2425 QDomText mapTipText = document.createTextNode(
mapTipTemplate() );
2426 mapTipElem.appendChild( mapTipText );
2427 layer_node.toElement().appendChild( mapTipElem );
2433 writeRasterAttributeTableExternalPaths( layer_node, document, context );
2441 QDomElement pipeElement = document.createElement( u
"pipe"_s );
2443 for (
int i = 0; i < mPipe->size(); i++ )
2446 if ( !interface )
continue;
2447 interface->
writeXml( document, pipeElement );
2450 QDomElement elemDataDefinedProperties = document.createElement( u
"pipe-data-defined-properties"_s );
2452 layer_node.appendChild( elemDataDefinedProperties );
2454 QDomElement resamplingStageElement = document.createElement( u
"resamplingStage"_s );
2456 resamplingStageElement.appendChild( resamplingStageText );
2457 pipeElement.appendChild( resamplingStageElement );
2459 layer_node.appendChild( pipeElement );
2461 if ( !
isValid() && !mOriginalStyleElement.isNull() )
2463 QDomElement originalStyleElement = document.createElement( u
"originalStyle"_s );
2464 originalStyleElement.appendChild( mOriginalStyleElement );
2465 layer_node.appendChild( originalStyleElement );
2469 QDomElement blendModeElement = document.createElement( u
"blendMode"_s );
2471 blendModeElement.appendChild( blendModeText );
2472 layer_node.appendChild( blendModeElement );
2477 QDomElement legendElement =
legend()->
writeXml( document, context );
2478 if ( !legendElement.isNull() )
2479 layer_node.appendChild( legendElement );
2490 return writeSymbology( node, doc, errorMessage, context, categories );
2494 QDomDocument &document,
2499 if ( !mDataProvider )
2504 QDomElement mapLayerNode = layer_node.toElement();
2506 if ( mapLayerNode.isNull() ||
"maplayer" != mapLayerNode.nodeName() )
2516 QDomElement provider = document.createElement( u
"provider"_s );
2517 const QDomText providerText = document.createTextNode(
mProviderKey );
2518 provider.appendChild( providerText );
2519 layer_node.appendChild( provider );
2522 QDomElement noData = document.createElement( u
"noData"_s );
2524 for (
int bandNo = 1; bandNo <= mDataProvider->bandCount(); bandNo++ )
2526 QDomElement noDataRangeList = document.createElement( u
"noDataList"_s );
2527 noDataRangeList.setAttribute( u
"bandNo"_s, bandNo );
2528 noDataRangeList.setAttribute( u
"useSrcNoData"_s, mDataProvider->useSourceNoDataValue( bandNo ) );
2530 const auto constUserNoDataValues = mDataProvider->userNoDataValues( bandNo );
2533 QDomElement noDataRange = document.createElement( u
"noDataRange"_s );
2537 noDataRangeList.appendChild( noDataRange );
2540 noData.appendChild( noDataRangeList );
2543 if ( noData.hasChildNodes() )
2545 layer_node.appendChild( noData );
2549 writeRasterAttributeTableExternalPaths( layer_node, document, context );
2555 return writeSymbology( layer_node, document, errorMsg, context );
2577 if ( !mDataProvider )
return 0;
2578 return mDataProvider->xSize();
2585 if ( !mDataProvider )
return 0;
2586 return mDataProvider->ySize();
2593 mPipe->setResamplingStage( stage );
2600 return mPipe->resamplingStage();
2603bool QgsRasterLayer::update()
2612 closeDataProvider();
Provides global constants and enumerations for use throughout the application.
static QString version()
Version string.
@ IsBasemapLayer
Layer is considered a 'basemap' layer, and certain properties of the layer should be ignored when cal...
RasterResamplingStage
Stage at which raster resampling occurs.
@ Provider
Resampling occurs in Provider.
@ ResampleFilter
Resampling occurs in ResamplingFilter.
@ ProviderHintBenefitsFromResampling
Provider benefits from resampling and should apply user default resampling settings.
@ ProviderHintCanPerformProviderResampling
Provider can perform resampling (to be opposed to post rendering resampling).
@ ReadLayerMetadata
Provider can read layer metadata from data store. Since QGIS 3.0. See QgsDataProvider::layerMetadata(...
@ SingleBandColorData
Single band containing color data.
@ GrayOrUndefined
Gray or undefined.
RasterRangeLimit
Describes the limits used to compute raster ranges (min/max values).
@ CumulativeCut
Range is [ min + cumulativeCutLower() * (max - min), min + cumulativeCutUpper() * (max - min) ].
@ MinimumMaximum
Real min-max values.
@ Linear
Interpolates the color between two class breaks linearly.
@ Discrete
Assigns the color of the higher class for every pixel between two class breaks.
@ IsBasemapSource
Associated source should be considered a 'basemap' layer. See Qgis::MapLayerProperty::IsBasemapLayer.
@ Bilinear
Bilinear (2x2 kernel) resampling.
@ Cubic
Cubic Convolution Approximation (4x4 kernel) resampling.
RasterDrawingStyle
Raster drawing styles.
@ SingleBandGray
A single band image drawn as a range of gray colors.
@ SingleBandColorData
ARGB values rendered directly.
@ MultiBandColor
A layer containing 2 or more bands, mapped to RGB color space. In the case of a multiband with only t...
@ PalettedColor
A "Palette" image drawn using color table.
@ SingleBandPseudoColor
A single band image drawn using a pseudocolor algorithm.
QFlags< RasterInterfaceCapability > RasterInterfaceCapabilities
Raster interface capabilities.
BlendMode
Blending modes defining the available composition modes that can be used when painting.
@ Size
Original data source size (and thus resolution) is known, it is not always available,...
@ IdentifyValue
Numerical values.
@ IdentifyFeature
WMS GML -> feature.
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
@ ExcludeByDefault
If set, the layer should not be included in legends by default, and must be manually added by a user.
DataType
Raster data types.
@ Float32
Thirty two bit floating point (float).
@ CFloat64
Complex Float64.
@ Int16
Sixteen bit signed integer (qint16).
@ ARGB32_Premultiplied
Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32_Premultiplied.
@ Int8
Eight bit signed integer (qint8) (added in QGIS 3.30).
@ UInt16
Sixteen bit unsigned integer (quint16).
@ Byte
Eight bit unsigned integer (quint8).
@ ARGB32
Color, alpha, red, green, blue, 4 bytes the same as QImage::Format_ARGB32.
@ Int32
Thirty two bit signed integer (qint32).
@ Float64
Sixty four bit floating point (double).
@ CFloat32
Complex Float32.
@ UInt32
Thirty two bit unsigned integer (quint32).
@ WholeRaster
Whole raster is used to compute statistics.
@ FixedCanvas
Current extent of the canvas (at the time of computation) is used to compute statistics.
QFlags< MapLayerProperty > MapLayerProperties
Map layer properties.
@ LoadDefaultStyle
Reset the layer's style to the default for the datasource.
@ SkipGetExtent
Skip the extent from provider.
@ TrustDataSource
Trust datasource config (primary key unicity, geometry type and srid, etc). Improves provider load ti...
RasterColorInterpretation
Raster color interpretation.
@ AlphaBand
Alpha (0=transparent, 255=opaque).
@ PaletteIndex
Paletted (see associated color table).
@ ContinuousPalette
Continuous palette, QGIS addition, GRASS.
RasterIdentifyFormat
Raster identify formats.
@ Feature
WMS GML/JSON -> feature.
@ Value
Numerical pixel value.
@ Preferred
Preferred format, matching the most recent WKT ISO standard. Currently an alias to WKT2_2019,...
Abstract base class for objects which generate elevation profiles.
Abstract base class for labeling settings for raster layers.
static QgsAbstractRasterLayerLabeling * createFromElement(const QDomElement &element, const QgsReadWriteContext &context)
Tries to create an instance of an implementation based on the XML data.
static QgsRasterRendererRegistry * rasterRendererRegistry()
Returns the application's raster renderer registry, used for managing raster layer renderers.
static QgsRuntimeProfiler * profiler()
Returns the application runtime profiler.
Bilinear raster resampler.
Brightness/contrast and gamma correction filter pipe for rasters.
int contrast() const
Returns current contrast level.
int brightness() const
Returns current brightness level.
A ramp shader will color a raster pixel based on a list of values ranges in a ramp.
bool shade(double value, int *returnRedValue, int *returnGreenValue, int *returnBlueValue, int *returnAlphaValue) const override
Generates an new RGBA value based on one input value.
void classifyColorRamp(int classes=0, int band=-1, const QgsRectangle &extent=QgsRectangle(), QgsRasterInterface *input=nullptr)
Classify color ramp shader.
void setColorRampType(Qgis::ShaderInterpolationMethod colorRampType)
Sets the color ramp interpolation method.
void setColorRampItemList(const QList< QgsColorRampShader::ColorRampItem > &list)
Sets a custom color map.
Handles contrast enhancement and clipping.
ContrastEnhancementAlgorithm
This enumerator describes the types of contrast enhancement algorithms that can be used.
@ StretchToMinimumMaximum
Linear histogram.
@ NoEnhancement
Default color scaling algorithm, no scaling is applied.
static QString contrastEnhancementAlgorithmString(ContrastEnhancementAlgorithm algorithm)
Returns a string to serialize ContrastEnhancementAlgorithm.
static ContrastEnhancementAlgorithm contrastEnhancementAlgorithmFromString(const QString &contrastEnhancementString)
Deserialize ContrastEnhancementAlgorithm.
ContrastEnhancementAlgorithm contrastEnhancementAlgorithm() const
Represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Abstract base class for spatial data provider implementations.
Stores the component parts of a data source URI (e.g.
QByteArray encodedUri() const
Returns the complete encoded URI as a byte array.
void setEncodedUri(const QByteArray &uri)
Sets the complete encoded uri.
void setParam(const QString &key, const QString &value)
Sets a generic parameter value on the URI.
Color and saturation filter pipe for rasters.
Base class for storage of map layer elevation properties.
static QString typeToString(Qgis::LayerType type)
Converts a map layer type to a string value.
An abstract interface for implementations of legends for one map layer.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Reads configuration from a DOM element previously written by writeXml().
virtual QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Writes configuration to a DOM element, to be used later with readXml().
static QgsMapLayerLegend * defaultRasterLegend(QgsRasterLayer *rl)
Create new legend implementation for raster layer.
void setFlag(Qgis::MapLayerLegendFlag flag, bool on=true)
Enables or disables a particular flag (other flags are not affected).
Base class for utility classes that encapsulate information necessary for rendering of map layers.
QString title() const
Returns the title of the layer used by QGIS Server in GetCapabilities request.
QString abstract() const
Returns the abstract of the layerused by QGIS Server in GetCapabilities request.
Base class for storage of map layer temporal properties.
void readStyleManager(const QDomNode &layerNode)
Read style manager's configuration (if any). To be called by subclasses.
void setError(const QgsError &error)
Sets error message.
void writeStyleManager(QDomNode &layerNode, QDomDocument &doc) const
Write style manager's configuration (if exists). To be called by subclasses.
QgsMapLayerLegend * legend() const
Can be nullptr.
virtual QgsRectangle extent() const
Returns the extent of the layer.
QString source() const
Returns the source for the layer.
Q_INVOKABLE QVariant customProperty(const QString &value, const QVariant &defaultValue=QVariant()) const
Read a custom property from layer.
void setBlendMode(QPainter::CompositionMode blendMode)
Set the blending mode used for rendering a layer.
void configChanged()
Emitted whenever the configuration is changed.
static Qgis::DataProviderReadFlags providerReadFlags(const QDomNode &layerNode, QgsMapLayer::ReadFlags layerReadFlags)
Returns provider read flag deduced from layer read flags layerReadFlags and a dom node layerNode that...
QgsCoordinateReferenceSystem crs
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
virtual QString loadDefaultStyle(bool &resultFlag)
Retrieve the default style for this layer if one exists (either as a .qml file on disk or as a record...
void setDataSource(const QString &dataSource, const QString &baseName=QString(), const QString &provider=QString(), bool loadDefaultStyleFlag=false)
Updates the data source of the layer.
QString mLayerName
Name of the layer - used for display.
void triggerRepaint(bool deferredUpdate=false)
Will advise the map canvas (and any other interested party) that this layer requires to be repainted.
QString crsHtmlMetadata() const
Returns a HTML fragment containing the layer's CRS metadata, for use in the htmlMetadata() method.
QgsLayerMetadata metadata
Q_DECL_DEPRECATED QString abstract() const
Returns the abstract of the layer used by QGIS Server in GetCapabilities request.
QgsMapLayer(Qgis::LayerType type=Qgis::LayerType::Vector, const QString &name=QString(), const QString &source=QString())
Constructor for QgsMapLayer.
QPainter::CompositionMode blendMode() const
Returns the current blending mode for a layer.
void statusChanged(const QString &status)
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar).
virtual void setMetadata(const QgsLayerMetadata &metadata)
Sets the layer's metadata store.
QFlags< StyleCategory > StyleCategories
Q_INVOKABLE void setCustomProperty(const QString &key, const QVariant &value)
Set a custom property for layer.
QString mProviderKey
Data provider key (name of the data provider).
QgsCoordinateTransformContext transformContext() const
Returns the layer data provider coordinate transform context or a default transform context if the la...
std::unique_ptr< QgsDataProvider > mPreloadedProvider
Optionally used when loading a project, it is released when the layer is effectively created.
void rendererChanged()
Signal emitted when renderer is changed.
Q_DECL_DEPRECATED QString title() const
Returns the title of the layer used by QGIS Server in GetCapabilities request.
virtual QgsError error() const
Gets current status error.
QgsMapLayer::LayerFlags flags
bool hasScaleBasedVisibility() const
Returns whether scale based visibility is enabled for the layer.
void opacityChanged(double opacity)
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (...
void emitStyleChanged()
Triggers an emission of the styleChanged() signal.
void dataChanged()
Data of layer changed.
void willBeDeleted()
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid...
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
void setName(const QString &name)
Set the display name of the layer.
virtual void setExtent(const QgsRectangle &rect)
Sets the extent.
void appendError(const QgsErrorMessage &error)
Add error message.
QString mDataSource
Data source description string, varies by layer type.
void setMapTipsEnabled(bool enabled)
Enable or disable map tips for this layer.
@ FlagReadExtentFromXml
Read extent from xml and skip get extent from provider.
@ FlagTrustLayerMetadata
Trust layer metadata. Improves layer load time by skipping expensive checks like primary key unicity,...
@ FlagDontResolveLayers
Don't resolve layer paths or create data providers for layers.
void setValid(bool valid)
Sets whether layer is valid or not.
void readCommonStyle(const QDomElement &layerElement, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)
Read style data common to all layer types.
QgsMapLayer::ReadFlags mReadFlags
Read flags. It's up to the subclass to respect these when restoring state from XML.
double minimumScale() const
Returns the minimum map scale (i.e.
void repaintRequested(bool deferredUpdate=false)
By emitting this signal the layer tells that either appearance or content have been changed and any v...
void setMapTipTemplate(const QString &mapTipTemplate)
The mapTip is a pretty, html representation for feature information.
@ AttributeTable
Attribute table settings: choice and order of columns, conditional styling.
@ Rendering
Rendering: scale visibility, simplify method, opacity.
void setProviderType(const QString &providerType)
Sets the providerType (provider key).
QString customPropertyHtmlMetadata() const
Returns an HTML fragment containing custom property information, for use in the htmlMetadata() method...
QString generalHtmlMetadata() const
Returns an HTML fragment containing general metadata information, for use in the htmlMetadata() metho...
void writeCommonStyle(QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const
Write style data common to all layer types.
double maximumScale() const
Returns the maximum map scale (i.e.
void invalidateWgs84Extent()
Invalidates the WGS84 extent.
bool mShouldValidateCrs
true if the layer's CRS should be validated and invalid CRSes are not permitted.
void setCrs(const QgsCoordinateReferenceSystem &srs, bool emitSignal=true)
Sets layer's spatial reference system.
Perform transforms between map coordinates and device coordinates.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true, const char *file=__builtin_FILE(), const char *function=__builtin_FUNCTION(), int line=__builtin_LINE())
Adds a message to the log instance (and creates it if necessary).
Renderer for multiband images with the color components.
int blueBand() const
Returns the band number for the blue channel.
void setGreenContrastEnhancement(QgsContrastEnhancement *ce)
Sets the contrast enhancement to use for the green channel.
void setBlueContrastEnhancement(QgsContrastEnhancement *ce)
Sets the contrast enhancement to use for the blue channel.
void setRedContrastEnhancement(QgsContrastEnhancement *ce)
Sets the contrast enhancement to use for the red channel.
const QgsContrastEnhancement * redContrastEnhancement() const
Returns the contrast enhancement to use for the red channel.
int redBand() const
Returns the band number for the red channel.
int greenBand() const
Returns the band number for the green channel.
static Qgis::BlendMode getBlendModeEnum(QPainter::CompositionMode blendMode)
Returns a Qgis::BlendMode corresponding to a QPainter::CompositionMode.
static QPainter::CompositionMode getCompositionMode(Qgis::BlendMode blendMode)
Returns a QPainter::CompositionMode corresponding to a Qgis::BlendMode.
QString writePath(const QString &filename) const
Prepare a filename to save it to the project file.
QString readPath(const QString &filename) const
Turn filename read from the project file to an absolute path.
Encapsulates properties and constraints relating to fetching elevation profiles from different source...
QString absoluteToRelativeUri(const QString &providerKey, const QString &uri, const QgsReadWriteContext &context) const
Converts absolute path(s) to relative path(s) in the given provider-specific URI.
static QgsProviderRegistry * instance(const QString &pluginPath=QString())
Means of accessing canonical single instance.
QString relativeToAbsoluteUri(const QString &providerKey, const QString &uri, const QgsReadWriteContext &context) const
Converts relative path(s) to absolute path(s) in the given provider-specific URI.
Represents a Raster Attribute Table (RAT).
QString filePath() const
Returns the (possibly empty) path of the file-based RAT, the path is set when a RAT is read or writte...
The RasterBandStats struct is a container for statistics about a single raster band.
double minimumValue
The minimum cell value in the raster band.
double maximumValue
The maximum cell value in the raster band.
static int typeSize(Qgis::DataType dataType)
Returns the size in bytes for the specified dataType.
static QString printValue(double value, bool localized=false)
Print double value with all necessary significant digits.
Handles elevation related properties for a raster data provider.
Base class for raster data providers.
QDateTime timestamp() const override
Time stamp of data source in the moment when data/metadata were loaded by provider.
QgsRectangle extent() const override=0
Returns the extent of the layer.
QDateTime dataTimestamp() const override
Current time stamp of data source.
void statusChanged(const QString &) const
Emit a message to be displayed on status bar, usually used by network providers (WMS,...
static QString identifyFormatName(Qgis::RasterIdentifyFormat format)
Converts a raster identify format to a string name.
The drawing pipe for raster layers.
void draw(QPainter *p, QgsRasterViewPort *viewPort, const QgsMapToPixel *qgsMapToPixel, QgsRasterBlockFeedback *feedback=nullptr)
Draws raster data.
Base class for processing filters like renderers, reprojector, resampler etc.
Q_DECL_DEPRECATED QgsRasterBandStats bandStatistics(int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
Returns the band statistics.
Q_DECL_DEPRECATED bool hasStatistics(int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
Returns true if histogram is available (cached, already calculated).
virtual void writeXml(QDomDocument &doc, QDomElement &parentElem) const
Write base class members to xml.
virtual QgsRasterInterface * input() const
Current input.
Iterator for sequentially processing raster cells.
Raster layer specific subclass of QgsMapLayerElevationProperties.
Implementation of QgsAbstractProfileGenerator for raster layers.
Implementation of threaded rendering for raster layers.
Implementation of map layer temporal properties for raster layers.
static void computeMinMax(QgsRasterDataProvider *provider, int band, const QgsRasterMinMaxOrigin &mmo, Qgis::RasterRangeLimit limits, const QgsRectangle &extent, int sampleSize, double &min, double &max)
Compute the min max values for provider along band according to MinMaxOrigin parameters mmo and exten...
QString htmlMetadata() const override
Obtain a formatted HTML string containing assorted metadata for this layer.
bool canCreateRasterAttributeTable()
Returns true if the raster renderer is suitable for creation of a raster attribute table.
void subsetStringChanged()
Emitted when the layer's subset string has changed.
Qgis::MapLayerProperties properties() const override
Returns the map layer properties of this layer.
QString encodedSource(const QString &source, const QgsReadWriteContext &context) const override
Called by writeLayerXML(), used by derived classes to encode provider's specific data source to proje...
const QgsAbstractRasterLayerLabeling * labeling() const
Access to const labeling configuration.
Q_DECL_DEPRECATED QgsLegendColorList legendSymbologyItems() const
Returns a list with classification items (Text and color).
QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext) override
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
void showStatusMessage(const QString &message)
QgsRasterAttributeTable * attributeTable(int bandNumber) const
Returns the (possibly NULL) raster attribute table for the given band bandNumber.
virtual bool setSubsetString(const QString &subset)
Sets the string (typically sql) used to define a subset of the layer.
QgsRasterResampleFilter * resampleFilter() const
Returns the raster's resample filter.
bool writeSymbology(QDomNode &, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const override
Write the style for the layer into the document provided.
QgsRasterLayer * clone() const override
Returns a new instance equivalent to this one.
void setResamplingStage(Qgis::RasterResamplingStage stage)
Select which stage of the pipe should apply resampling.
Qgis::RasterResamplingStage resamplingStage() const
Returns which stage of the pipe should apply resampling.
static const QgsSettingsEntryBool * settingsRasterDefaultEarlyResampling
int attributeTableCount() const
Returns the number of attribute tables for the raster by counting the number of bands that have an as...
void refreshContrastEnhancement(const QgsRectangle &extent)
Refresh contrast enhancement with new extent.
int height() const
Returns the height of the (unclipped) raster.
static const Qgis::RasterRangeLimit SINGLE_BAND_MIN_MAX_LIMITS
Default enhancement limits for single band raster.
Q_DECL_DEPRECATED void setDataProvider(const QString &provider)
Set the data provider.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_SINGLE_BYTE_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for multiple band raster of type Byte.
int bandCount() const
Returns the number of bands in this layer.
QgsMapLayerTemporalProperties * temporalProperties() override
Returns the layer's temporal properties.
bool ignoreExtents() const
If the ignoreExtent flag is set, the layer will also render outside the bounding box reported by the ...
QString decodedSource(const QString &source, const QString &provider, const QgsReadWriteContext &context) const override
Called by readLayerXML(), used by derived classes to decode provider's specific data source from proj...
double opacity() const final
Returns the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
void computeMinMax(int band, const QgsRasterMinMaxOrigin &mmo, Qgis::RasterRangeLimit limits, const QgsRectangle &extent, int sampleSize, double &min, double &max)
Compute the min max values along band according to MinMaxOrigin parameters mmo and extent.
bool labelsEnabled() const
Returns whether the layer contains labels which are enabled and should be drawn.
void setSubLayerVisibility(const QString &name, bool vis) override
Set the visibility of the given sublayer name.
static const QgsSettingsEntryDouble * settingsRasterDefaultOversampling
void setLabeling(QgsAbstractRasterLayerLabeling *labeling)
Sets labeling configuration.
virtual QString subsetString() const
Returns the string (typically sql) used to define a subset of the layer.
QgsAbstractProfileGenerator * createProfileGenerator(const QgsProfileRequest &request) override
Given a profile request, returns a new profile generator ready for generating elevation profiles.
QgsBrightnessContrastFilter * brightnessFilter() const
Returns the raster's brightness/contrast filter.
bool writeXml(QDomNode &layer_node, QDomDocument &doc, const QgsReadWriteContext &context) const override
Called by writeLayerXML(), used by children to write state specific to them to project files.
bool writeStyle(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) const override
Write just the symbology information for the layer into the document.
double rasterUnitsPerPixelX() const
Returns the number of raster units per each raster pixel in X axis.
void reload() override
Synchronises with changes in the datasource.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified symbology visitor, causing it to visit all symbols associated with the layer.
QImage previewAsImage(QSize size, const QColor &bgColor=Qt::white, QImage::Format format=QImage::Format_ARGB32_Premultiplied)
Draws a preview of the rasterlayer into a QImage.
QStringList subLayers() const override
Returns the sublayers of this layer.
static const Qgis::RasterRangeLimit MULTIPLE_BAND_MULTI_BYTE_MIN_MAX_LIMITS
Default enhancement limits for multiple band raster of type different from Byte.
void setContrastEnhancement(QgsContrastEnhancement::ContrastEnhancementAlgorithm algorithm, Qgis::RasterRangeLimit limits=Qgis::RasterRangeLimit::MinimumMaximum, const QgsRectangle &extent=QgsRectangle(), int sampleSize=QgsRasterLayer::SAMPLE_SIZE, bool generateLookupTableFlag=true)
Set contrast enhancement algorithm.
void setDefaultContrastEnhancement()
Sets the default contrast enhancement.
QgsRasterRenderer * renderer() const
Returns the raster's renderer.
static const double SAMPLE_SIZE
Default sample size (number of pixels) for estimated statistics/histogram calculation.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm MULTIPLE_BAND_MULTI_BYTE_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for multiple band raster of type different from Byte.
static const Qgis::RasterRangeLimit MULTIPLE_BAND_SINGLE_BYTE_MIN_MAX_LIMITS
Default enhancement limits for multiple band raster of type Byte.
bool readXml(const QDomNode &layer_node, QgsReadWriteContext &context) override
Called by readLayerXML(), used by children to read state specific to them from project files.
void setLabelsEnabled(bool enabled)
Sets whether labels should be enabled for the layer.
QString bandName(int bandNoInt) const
Returns the name of a band given its number.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
static bool isValidRasterFileName(const QString &fileNameQString, QString &retError)
This helper checks to see whether the file name appears to be a valid raster file name.
bool isSpatial() const override
Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated w...
void setOpacity(double opacity) final
Sets the opacity for the layer, where opacity is a value between 0 (totally transparent) and 1....
double rasterUnitsPerPixelY() const
Returns the number of raster units per each raster pixel in Y axis.
int width() const
Returns the width of the (unclipped) raster.
QgsMapLayerElevationProperties * elevationProperties() override
Returns the layer's elevation properties.
bool readSymbology(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) override
Read the symbology for the current layer from the DOM node supplied.
void draw(QPainter *theQPainter, QgsRasterViewPort *myRasterViewPort, const QgsMapToPixel *qgsMapToPixel=nullptr)
This is an overloaded version of the draw() function that is called by both draw() and thumbnailAsPix...
Q_DECL_DEPRECATED bool writeSld(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QVariantMap &props=QVariantMap()) const
Writes the symbology of the layer into the document provided in SLD 1.0.0 format.
static QDateTime lastModified(const QString &name)
Returns time stamp for given file name.
static const QgsContrastEnhancement::ContrastEnhancementAlgorithm SINGLE_BAND_ENHANCEMENT_ALGORITHM
Default enhancement algorithm for single band raster.
~QgsRasterLayer() override
QDateTime timestamp() const override
Time stamp of data source in the moment when data/metadata were loaded by provider.
void setTransformContext(const QgsCoordinateTransformContext &transformContext) override
Sets the coordinate transform context to transformContext.
void setRenderer(QgsRasterRenderer *renderer)
Sets the raster's renderer.
QgsRasterLayer()
Constructor. Provider is not set.
void setLayerOrder(const QStringList &layers) override
Reorders the previously selected sublayers of this layer from bottom to top.
bool defaultContrastEnhancementSettings(QgsContrastEnhancement::ContrastEnhancementAlgorithm &myAlgorithm, Qgis::RasterRangeLimit &myLimits) const
Returns default contrast enhancement settings for that type of raster.
QgsHueSaturationFilter * hueSaturationFilter() const
Returns the raster's hue/saturation filter.
bool readStyle(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories=QgsMapLayer::AllStyleCategories) override
Read the style for the current layer from the DOM node supplied.
QPixmap paletteAsPixmap(int bandNumber=1)
Returns a 100x100 pixmap of the color palette.
Describes the origin of minimum and maximum values in a raster.
static QString limitsString(Qgis::RasterRangeLimit limits)
Returns a string to serialize Limits.
void setLimits(Qgis::RasterRangeLimit limits)
Sets the limits.
void setExtent(Qgis::RasterRangeExtent extent)
Sets the extent.
Qgis::RasterRangeExtent extent() const
Returns the raster extent.
static Qgis::RasterRangeLimit limitsFromString(const QString &limits)
Deserialize Limits.
Qgis::RasterRangeLimit limits() const
Returns the raster limits.
Contains a pipeline of raster interfaces for sequential raster processing.
static QgsPropertiesDefinition propertyDefinitions()
Returns the definitions for data defined properties available for use in raster pipes.
Implements approximate projection support for optimised raster transformation.
Q_DECL_DEPRECATED void setCrs(const QgsCoordinateReferenceSystem &srcCRS, const QgsCoordinateReferenceSystem &destCRS, int srcDatumTransform=-1, int destDatumTransform=-1)
Sets the source and destination CRS.
Represents a range of raster values between min and max, optionally including the min and max value.
double min() const
Returns the minimum value for the range.
Raster renderer pipe that applies colors to a raster.
virtual QString type() const
Returns a unique string representation of the renderer type.
virtual bool canCreateRasterAttributeTable() const
Returns true if the renderer is suitable for attribute table creation.
void setMinMaxOrigin(const QgsRasterMinMaxOrigin &origin)
Sets origin of min/max values.
const QgsRasterMinMaxOrigin & minMaxOrigin() const
Returns const reference to origin of min/max values.
virtual bool refresh(const QgsRectangle &extent, const QList< double > &min, const QList< double > &max, bool forceRefresh=false)
Refreshes the renderer according to the min and max values associated with the extent.
Resample filter pipe for rasters.
Interface for all raster shaders.
void setRasterShaderFunction(QgsRasterShaderFunction *function)
A public method that allows the user to set their own shader function.
Allows entering a context category and takes care of leaving this category on deletion of the class.
A container for the context for various read/write operations on objects.
QgsReadWriteContextCategoryPopper enterCategory(const QString &category, const QString &details=QString()) const
Push a category to the stack.
QgsCoordinateTransformContext transformContext() const
Returns data provider coordinate transform context.
const QgsPathResolver & pathResolver() const
Returns path resolver for conversion between relative and absolute paths.
A rectangle specified with double values.
Q_INVOKABLE QString toString(int precision=16) const
Returns a string representation of form xmin,ymin : xmax,ymax Coordinates will be truncated to the sp...
Contains information about the context of a rendering operation.
A boolean settings entry.
static QgsSettingsTreeNode * sTreeRaster
Stores settings for use within QGIS.
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
Raster renderer pipe for single band gray.
void setContrastEnhancement(QgsContrastEnhancement *ce)
Takes ownership.
int inputBand() const override
Returns the input band for the renderer, or -1 if no input band is available.
Raster renderer pipe for single band pseudocolor.
void setClassificationMin(double min)
void setShader(QgsRasterShader *shader)
Takes ownership of the shader.
void setClassificationMax(double max)
QgsRasterShader * shader()
Returns the raster shader.
int inputBand() const override
Returns the input band for the renderer, or -1 if no input band is available.
Holds SLD export options and other information related to SLD export of a QGIS layer style.
void setExtraProperties(const QVariantMap &properties)
Sets the open ended set of properties that can drive/inform the SLD encoding.
QVariantMap extraProperties() const
Returns the open ended set of properties that can drive/inform the SLD encoding.
An interface for classes which can visit style entity (e.g.
static void mergeScaleDependencies(double mScaleMinDenom, double mScaleMaxDenom, QVariantMap &props)
Merges the local scale limits, if any, with the ones already in the map, if any.
static QgsRectangle readRectangle(const QDomElement &element)
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference).
QgsSignalBlocker< Object > whileBlocking(Object *object)
Temporarily blocks signals from a QObject while calling a single method from the object.
#define QgsDebugMsgLevel(str, level)
#define QgsDebugError(str)
QgsDataProvider * classFactoryFunction_t(const QString *, const QgsDataProvider::ProviderOptions &options)
QList< QPair< QString, QColor > > QgsLegendColorList
QList< QgsRasterRange > QgsRasterRangeList
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS
Setting options for creating vector data providers.
Setting options for loading raster layers.
bool skipCrsValidation
Controls whether the layer is allowed to have an invalid/unknown CRS.
bool loadDefaultStyle
Sets to true if the default layer style should be loaded.
QgsCoordinateTransformContext transformContext
Coordinate transform context.
Registry for raster renderer entries.
QgsRasterRendererCreateFunc rendererCreateFunction
This class provides details of the viewable area that a raster will be rendered into.
qgssize mHeight
Height, number of rows to be rendered.
QgsCoordinateReferenceSystem mDestCRS
Target (map) coordinate system.
QgsPointXY mBottomRightPoint
Coordinate (in output device coordinate system) of bottom right corner of the part of the raster that...
QgsPointXY mTopLeftPoint
Coordinate (in output device coordinate system) of top left corner of the part of the raster that is ...
QgsCoordinateReferenceSystem mSrcCRS
Source (layer) coordinate system.
QgsRectangle mDrawnExtent
Intersection of current map extent and layer extent, in map (destination) CRS.
QgsCoordinateTransformContext mTransformContext
Coordinate transform context.
qgssize mWidth
Width, number of columns to be rendered.