26QString QgsRasterSurfaceVolumeAlgorithm::name()
const
28 return QStringLiteral(
"rastersurfacevolume" );
31QString QgsRasterSurfaceVolumeAlgorithm::displayName()
const
33 return QObject::tr(
"Raster surface volume" );
36QStringList QgsRasterSurfaceVolumeAlgorithm::tags()
const
38 return QObject::tr(
"sum,volume,area,height,terrain,dem,elevation" ).split(
',' );
41QString QgsRasterSurfaceVolumeAlgorithm::group()
const
43 return QObject::tr(
"Raster analysis" );
46QString QgsRasterSurfaceVolumeAlgorithm::groupId()
const
48 return QStringLiteral(
"rasteranalysis" );
51void QgsRasterSurfaceVolumeAlgorithm::initAlgorithm(
const QVariantMap & )
54 QObject::tr(
"Input layer" ) ) );
56 QObject::tr(
"Band number" ), 1, QStringLiteral(
"INPUT" ) ) );
60 QObject::tr(
"Method" ), QStringList()
61 << QObject::tr(
"Count Only Above Base Level" )
62 << QObject::tr(
"Count Only Below Base Level" )
63 << QObject::tr(
"Subtract Volumes Below Base Level" )
64 << QObject::tr(
"Add Volumes Below Base Level" ) ) );
67 QObject::tr(
"Surface volume report" ), QObject::tr(
"HTML files (*.html)" ), QVariant(),
true ) );
76QString QgsRasterSurfaceVolumeAlgorithm::shortHelpString()
const
78 return QObject::tr(
"This algorithm calculates the volume under a raster grid's surface.\n\n"
79 "Several methods of volume calculation are available, which control whether "
80 "only values above or below the specified base level are considered, or "
81 "whether volumes below the base level should be added or subtracted from the total volume.\n\n"
82 "The algorithm outputs the calculated volume, the total area, and the total number of pixels analysed. "
83 "If the 'Count Only Above Base Level' or 'Count Only Below Base Level' methods are used, "
84 "then the calculated area and pixel count only includes pixels which are above or below the "
85 "specified base level respectively.\n\n"
86 "Units of the calculated volume are dependent on the coordinate reference system of "
87 "the input raster file. For a CRS in meters, with a DEM height in meters, the calculated "
88 "value will be in meters³. If instead the input raster is in a geographic coordinate system "
89 "(e.g. latitude/longitude values), then the result will be in degrees² × meters, and an "
90 "appropriate scaling factor will need to be applied in order to convert to meters³." );
93QString QgsRasterSurfaceVolumeAlgorithm::shortDescription()
const
95 return QObject::tr(
"Calculates the volume under a raster grid's surface." );
98QgsRasterSurfaceVolumeAlgorithm *QgsRasterSurfaceVolumeAlgorithm::createInstance()
const
100 return new QgsRasterSurfaceVolumeAlgorithm();
105 QgsRasterLayer *layer = parameterAsRasterLayer( parameters, QStringLiteral(
"INPUT" ), context );
106 const int band = parameterAsInt( parameters, QStringLiteral(
"BAND" ), context );
111 mBand = parameterAsInt( parameters, QStringLiteral(
"BAND" ), context );
112 if ( mBand < 1 || mBand > layer->
bandCount() )
113 throw QgsProcessingException( QObject::tr(
"Invalid band number for BAND (%1): Valid values for input raster are 1 to %2" ).arg( mBand )
118 mLayerWidth = layer->
width();
119 mLayerHeight = layer->
height();
120 mExtent = layer->
extent();
124 mSource = layer->
source();
126 mLevel = parameterAsDouble( parameters, QStringLiteral(
"LEVEL" ), context );
127 mMethod =
static_cast< Method
>( parameterAsEnum( parameters, QStringLiteral(
"METHOD" ), context ) );
133 const QString outputFile = parameterAsFileOutput( parameters, QStringLiteral(
"OUTPUT_HTML_FILE" ), context );
137 std::unique_ptr< QgsFeatureSink > sink;
138 if ( parameters.contains( QStringLiteral(
"OUTPUT_TABLE" ) ) && parameters.value( QStringLiteral(
"OUTPUT_TABLE" ) ).isValid() )
141 outFields.
append(
QgsField( QStringLiteral(
"volume" ), QMetaType::Type::Double, QString(), 20, 8 ) );
142 outFields.
append(
QgsField( areaUnit.replace( QStringLiteral(
"²" ), QStringLiteral(
"2" ) ), QMetaType::Type::Double, QString(), 20, 8 ) );
143 outFields.
append(
QgsField( QStringLiteral(
"pixel_count" ), QMetaType::Type::LongLong ) );
154 const int nbBlocksWidth =
static_cast< int >( std::ceil( 1.0 * mLayerWidth / maxWidth ) );
155 const int nbBlocksHeight =
static_cast< int >( std::ceil( 1.0 * mLayerHeight / maxHeight ) );
156 const int nbBlocks = nbBlocksWidth * nbBlocksHeight;
159 iter.startRasterRead( mBand, mLayerWidth, mLayerHeight, mExtent );
165 std::unique_ptr< QgsRasterBlock > rasterBlock;
166 while ( iter.readNextRasterPart( mBand, iterCols, iterRows, rasterBlock, iterLeft, iterTop ) )
168 feedback->
setProgress( 100 * ( ( iterTop / maxHeight * nbBlocksWidth ) + iterLeft / maxWidth ) / nbBlocks );
169 for (
int row = 0; row < iterRows; row++ )
173 for (
int column = 0; column < iterCols; column++ )
175 if ( mHasNoDataValue && rasterBlock->isNoData( row, column ) )
180 const double z = rasterBlock->value( row, column ) - mLevel;
184 case CountOnlyAboveBaseLevel:
192 case CountOnlyBelowBaseLevel:
200 case SubtractVolumesBelowBaseLevel:
205 case AddVolumesBelowBaseLevel:
206 volume += std::fabs( z );
215 const double pixelArea = mRasterUnitsPerPixelX * mRasterUnitsPerPixelY;
216 const double area = count * pixelArea;
218 if ( !outputFile.isEmpty() )
220 QFile file( outputFile );
221 if ( file.open( QIODevice::WriteOnly | QIODevice::Truncate ) )
225 QTextStream out( &file );
226#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
227 out.setCodec(
"UTF-8" );
229 out << QStringLiteral(
"<html><head><meta http-equiv=\"Content-Type\" content=\"text/html;charset=utf-8\"/></head><body>\n" );
230 out << QStringLiteral(
"<p>%1: %2 (%3 %4)</p>\n" ).arg( QObject::tr(
"Analyzed file" ), mSource, QObject::tr(
"band" ) ).arg( mBand );
231 out << QObject::tr(
"<p>%1: %2</p>\n" ).arg( QObject::tr(
"Volume" ), QString::number( volume,
'g', 16 ) );
232 out << QObject::tr(
"<p>%1: %2</p>\n" ).arg( QObject::tr(
"Pixel count" ) ).arg( count );
233 out << QObject::tr(
"<p>%1: %2 %3</p>\n" ).arg( QObject::tr(
"Area" ), QString::number( area,
'g', 16 ), encodedAreaUnit );
234 out << QStringLiteral(
"</body></html>" );
235 outputs.insert( QStringLiteral(
"OUTPUT_HTML_FILE" ), outputFile );
244 throw QgsProcessingException( writeFeatureError( sink.get(), parameters, QStringLiteral(
"OUTPUT_TABLE" ) ) );
245 outputs.insert( QStringLiteral(
"OUTPUT_TABLE" ), tableDest );
247 outputs.insert( QStringLiteral(
"VOLUME" ), volume );
248 outputs.insert( QStringLiteral(
"AREA" ), area );
249 outputs.insert( QStringLiteral(
"PIXEL_COUNT" ), count );
@ Vector
Tables (i.e. vector layers with or without geometry). When used for a sink this indicates the sink ha...
@ Double
Double/float values.
This class represents a coordinate reference system (CRS).
@ FastInsert
Use faster inserts, at the cost of updating the passed features to reflect changes made at the provid...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
void setAttributes(const QgsAttributes &attrs)
Sets the feature's attributes.
bool isCanceled() const
Tells whether the operation has been canceled already.
void setProgress(double progress)
Sets the current progress for the feedback object.
Encapsulate a field in an attribute table or data source.
Container of fields for a vector layer.
bool append(const QgsField &field, Qgis::FieldOrigin origin=Qgis::FieldOrigin::Provider, int originIndex=-1)
Appends a field.
virtual QgsRectangle extent() const
Returns the extent of the layer.
QString source() const
Returns the source for the layer.
QgsCoordinateReferenceSystem crs
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 numeric 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 feature sink output for processing algorithms.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
A numeric parameter for processing algorithms.
A raster layer parameter for processing algorithms.
QgsRasterDataProvider * clone() const override=0
Clone itself, create deep copy.
virtual bool sourceHasNoDataValue(int bandNo) const
Returns true if source band has no data value.
Iterator for sequentially processing raster cells.
static const int DEFAULT_MAXIMUM_TILE_WIDTH
Default maximum tile width.
static const int DEFAULT_MAXIMUM_TILE_HEIGHT
Default maximum tile height.
Represents a raster layer.
int height() const
Returns the height of the (unclipped) raster.
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.
int width() const
Returns the width of the (unclipped) raster.
static QString ampersandEncode(const QString &string)
Makes a raw string safe for inclusion as a HTML/XML string literal.
static Q_INVOKABLE QString toAbbreviatedString(Qgis::DistanceUnit unit)
Returns a translated abbreviation representing a distance unit.
static Q_INVOKABLE Qgis::AreaUnit distanceToAreaUnit(Qgis::DistanceUnit distanceUnit)
Converts a distance unit to its corresponding area unit, e.g., meters to square meters.