24const std::vector< Qgis::ZonalStatistic > STATS
40QString QgsZonalStatisticsAlgorithm::name()
const
42 return QStringLiteral(
"zonalstatistics" );
45QString QgsZonalStatisticsAlgorithm::displayName()
const
47 return QObject::tr(
"Zonal statistics (in place)" );
50QStringList QgsZonalStatisticsAlgorithm::tags()
const
52 return QObject::tr(
"stats,statistics,zones,layer,sum,maximum,minimum,mean,count,standard,deviation,"
53 "median,range,majority,minority,variety,variance,summary,raster" ).split(
',' );
56QString QgsZonalStatisticsAlgorithm::group()
const
58 return QObject::tr(
"Raster analysis" );
61QString QgsZonalStatisticsAlgorithm::groupId()
const
63 return QStringLiteral(
"rasteranalysis" );
66QString QgsZonalStatisticsAlgorithm::shortDescription()
const
68 return QObject::tr(
"Calculates statistics for a raster layer's values for each feature of an overlapping polygon vector layer." );
71QString QgsZonalStatisticsAlgorithm::shortHelpString()
const
73 return QObject::tr(
"This algorithm calculates statistics of a raster layer for each feature "
74 "of an overlapping polygon vector layer. The results will be written in place." );
82QgsZonalStatisticsAlgorithm *QgsZonalStatisticsAlgorithm::createInstance()
const
84 return new QgsZonalStatisticsAlgorithm();
87void QgsZonalStatisticsAlgorithm::initAlgorithm(
const QVariantMap & )
89 QStringList statChoices;
90 statChoices.reserve( STATS.size() );
98 QObject::tr(
"Raster band" ), 1, QStringLiteral(
"INPUT_RASTER" ) ) );
101 addParameter(
new QgsProcessingParameterString( QStringLiteral(
"COLUMN_PREFIX" ), QObject::tr(
"Output column prefix" ), QStringLiteral(
"_" ) ) );
104 statChoices,
true, QVariantList() << 0 << 1 << 2 ) );
111 QgsRasterLayer *rasterLayer = parameterAsRasterLayer( parameters, QStringLiteral(
"INPUT_RASTER" ), context );
115 mBand = parameterAsInt( parameters, QStringLiteral(
"RASTER_BAND" ), context );
116 if ( mBand < 1 || mBand > rasterLayer->
bandCount() )
117 throw QgsProcessingException( QObject::tr(
"Invalid band number for BAND (%1): Valid values for input raster are 1 to %2" ).arg( mBand )
121 mCrs = rasterLayer->
crs();
125 mPrefix = parameterAsString( parameters, QStringLiteral(
"COLUMN_PREFIX" ), context );
127 const QList< int > stats = parameterAsEnums( parameters, QStringLiteral(
"STATISTICS" ), context );
129 for (
const int s : stats )
131 mStats |= STATS.at( s );
139 QgsVectorLayer *layer = parameterAsVectorLayer( parameters, QStringLiteral(
"INPUT_VECTOR" ), context );
153 zs.calculateStatistics( feedback );
156 outputs.insert( QStringLiteral(
"INPUT_VECTOR" ), layer->
id() );
@ VectorPolygon
Vector polygon layers.
ZonalStatistic
Statistics to be calculated during a zonal statistics operation.
@ StDev
Standard deviation of pixel values.
@ Mean
Mean of pixel values.
@ Median
Median of pixel values.
@ Max
Max of pixel values.
@ Variance
Variance of pixel values.
@ Min
Min of pixel values.
@ Range
Range of pixel values (max - min)
@ Sum
Sum of pixel values.
@ Minority
Minority of pixel values.
@ Majority
Majority of pixel values.
@ Variety
Variety (count of distinct) pixel values.
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
QFlags< ZonalStatistic > ZonalStatistics
Statistics to be calculated during a zonal statistics operation.
@ Deprecated
Algorithm is deprecated.
@ NoThreading
Algorithm is not thread safe and cannot be run in a background thread, e.g. for algorithms which mani...
QgsCoordinateReferenceSystem crs
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Contains information about the context in which a processing algorithm is executed.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
A vector layer output for processing algorithms.
A raster band parameter for Processing algorithms.
An enum based parameter for processing algorithms, allowing for selection from predefined values.
A raster layer parameter for processing algorithms.
A string parameter for processing algorithms.
A vector layer (with or without geometry) parameter for processing algorithms.
QgsRasterDataProvider * clone() const override=0
Clone itself, create deep copy.
Represents a raster layer.
int bandCount() const
Returns the number of bands in this layer.
double rasterUnitsPerPixelX() const
Returns the number of raster units per each raster pixel in X axis.
QgsRasterDataProvider * dataProvider() override
Returns the source data provider.
double rasterUnitsPerPixelY() const
Returns the number of raster units per each raster pixel in Y axis.
Represents a vector layer which manages a vector based data sets.
A class that calculates raster statistics (count, sum, mean) for a polygon or multipolygon layer and ...
static QString displayName(Qgis::ZonalStatistic statistic)
Returns the friendly display name for a statistic.