28QStringList QgsRasterBooleanLogicAlgorithmBase::tags()
const
30 return QObject::tr(
"logical,boolean" ).split(
',' );
33QString QgsRasterBooleanLogicAlgorithmBase::group()
const
35 return QObject::tr(
"Raster analysis" );
38QString QgsRasterBooleanLogicAlgorithmBase::groupId()
const
40 return QStringLiteral(
"rasteranalysis" );
43void QgsRasterBooleanLogicAlgorithmBase::initAlgorithm(
const QVariantMap & )
49 addParameter(
new QgsProcessingParameterBoolean( QStringLiteral(
"NODATA_AS_FALSE" ), QObject::tr(
"Treat NoData values as false" ),
false ) );
51 std::unique_ptr< QgsProcessingParameterNumber > noDataValueParam = std::make_unique< QgsProcessingParameterNumber >( QStringLiteral(
"NO_DATA" ),
54 addParameter( noDataValueParam.release() );
56 std::unique_ptr< QgsProcessingParameterDefinition > typeChoice = QgsRasterAnalysisUtils::createRasterTypeParameter( QStringLiteral(
"DATA_TYPE" ), QObject::tr(
"Output data type" ),
Qgis::DataType::Float32 );
58 addParameter( typeChoice.release() );
60 std::unique_ptr< QgsProcessingParameterString > createOptsParam = std::make_unique< QgsProcessingParameterString >( QStringLiteral(
"CREATE_OPTIONS" ), QObject::tr(
"Creation options" ), QVariant(),
false,
true );
61 createOptsParam->setMetadata( QVariantMap( {{QStringLiteral(
"widget_wrapper" ), QVariantMap( {{QStringLiteral(
"widget_type" ), QStringLiteral(
"rasteroptions" ) }} ) }} ) );
63 addParameter( createOptsParam.release() );
66 QObject::tr(
"Output layer" ) ) );
73 addOutput(
new QgsProcessingOutputNumber( QStringLiteral(
"NODATA_PIXEL_COUNT" ), QObject::tr(
"NoData pixel count" ) ) );
80 QgsRasterLayer *referenceLayer = parameterAsRasterLayer( parameters, QStringLiteral(
"REF_LAYER" ), context );
81 if ( !referenceLayer )
83 mCrs = referenceLayer->
crs();
86 mLayerWidth = referenceLayer->
width();
87 mLayerHeight = referenceLayer->
height();
88 mExtent = referenceLayer->
extent();
89 mNoDataValue = parameterAsDouble( parameters, QStringLiteral(
"NO_DATA" ), context );
90 mDataType = QgsRasterAnalysisUtils::rasterTypeChoiceToDataType( parameterAsEnum( parameters, QStringLiteral(
"DATA_TYPE" ), context ) );
91 if ( mDataType ==
Qgis::DataType::Int8 && atoi( GDALVersionInfo(
"VERSION_NUM" ) ) < GDAL_COMPUTE_VERSION( 3, 7, 0 ) )
94 mTreatNodataAsFalse = parameterAsBoolean( parameters, QStringLiteral(
"NODATA_AS_FALSE" ), context );
96 const QList< QgsMapLayer * > layers = parameterAsLayerList( parameters, QStringLiteral(
"INPUT" ), context );
97 QList< QgsRasterLayer * > rasterLayers;
98 rasterLayers.reserve( layers.count() );
104 QgsRasterAnalysisUtils::RasterLogicInput input;
108 input.interface = input.sourceDataProvider.get();
110 if ( layer->
crs() != mCrs )
112 input.projector = std::make_unique< QgsRasterProjector >();
113 input.projector->setInput( input.sourceDataProvider.get() );
115 input.interface = input.projector.get();
117 mInputs.emplace_back( std::move( input ) );
126 const QString createOptions = parameterAsString( parameters, QStringLiteral(
"CREATE_OPTIONS" ), context ).trimmed();
127 const QString outputFile = parameterAsOutputLayer( parameters, QStringLiteral(
"OUTPUT" ), context );
128 const QFileInfo fi( outputFile );
131 std::unique_ptr< QgsRasterFileWriter > writer = std::make_unique< QgsRasterFileWriter >( outputFile );
132 writer->setOutputProviderKey( QStringLiteral(
"gdal" ) );
133 if ( !createOptions.isEmpty() )
135 writer->setCreateOptions( createOptions.split(
'|' ) );
137 writer->setOutputFormat( outputFormat );
138 std::unique_ptr<QgsRasterDataProvider > provider( writer->createOneBandRaster( mDataType, mLayerWidth, mLayerHeight, mExtent, mCrs ) );
141 if ( !provider->isValid() )
144 provider->setNoDataValue( 1, mNoDataValue );
148 const qgssize layerSize =
static_cast< qgssize >( mLayerWidth ) *
static_cast< qgssize >( mLayerHeight );
150 QgsRasterAnalysisUtils::applyRasterLogicOperator( mInputs, provider.get(), mNoDataValue, mTreatNodataAsFalse, mLayerWidth, mLayerHeight,
151 mExtent, feedback, mExtractValFunc, noDataCount, trueCount, falseCount );
154 outputs.insert( QStringLiteral(
"EXTENT" ), mExtent.toString() );
155 outputs.insert( QStringLiteral(
"CRS_AUTHID" ), mCrs.authid() );
156 outputs.insert( QStringLiteral(
"WIDTH_IN_PIXELS" ), mLayerWidth );
157 outputs.insert( QStringLiteral(
"HEIGHT_IN_PIXELS" ), mLayerHeight );
158 outputs.insert( QStringLiteral(
"TOTAL_PIXEL_COUNT" ), layerSize );
159 outputs.insert( QStringLiteral(
"NODATA_PIXEL_COUNT" ), noDataCount );
160 outputs.insert( QStringLiteral(
"TRUE_PIXEL_COUNT" ), trueCount );
161 outputs.insert( QStringLiteral(
"FALSE_PIXEL_COUNT" ), falseCount );
162 outputs.insert( QStringLiteral(
"OUTPUT" ), outputFile );
172QgsRasterLogicalOrAlgorithm::QgsRasterLogicalOrAlgorithm()
174 mExtractValFunc = [ = ](
const std::vector< std::unique_ptr< QgsRasterBlock > > &inputs,
bool & res,
bool & resIsNoData,
int row,
int column,
bool treatNoDataAsFalse )
178 bool isNoData =
false;
179 for (
auto &block : inputs )
182 if ( !block || !block->isValid() )
184 if ( treatNoDataAsFalse )
194 value = block->valueAndNoData( row, column, isNoData );
195 if ( isNoData && !treatNoDataAsFalse )
203 if ( treatNoDataAsFalse )
211QString QgsRasterLogicalOrAlgorithm::name()
const
213 return QStringLiteral(
"rasterlogicalor" );
216QString QgsRasterLogicalOrAlgorithm::displayName()
const
218 return QObject::tr(
"Raster boolean OR" );
222QString QgsRasterLogicalOrAlgorithm::shortDescription()
const
224 return QObject::tr(
"Calculates the boolean OR for a set of input raster layers" );
227QString QgsRasterLogicalOrAlgorithm::shortHelpString()
const
229 return QObject::tr(
"This algorithm calculates the boolean OR for a set of input rasters. If any of the input rasters have a non-zero value for a pixel, "
230 "that pixel will be set to 1 in the output raster. If all the input rasters have 0 values for the pixel it will be set to 0 in the output raster.\n\n"
231 "The reference layer parameter specifies an existing raster layer to use as a reference when creating the output raster. The output raster "
232 "will have the same extent, CRS, and pixel dimensions as this layer.\n\n"
233 "By default, a NoData pixel in ANY of the input layers will result in a NoData pixel in the output raster. If the "
234 "'Treat NoData values as false' option is checked, then NoData inputs will be treated the same as a 0 input value." );
237QgsRasterLogicalOrAlgorithm *QgsRasterLogicalOrAlgorithm::createInstance()
const
239 return new QgsRasterLogicalOrAlgorithm();
246QgsRasterLogicalAndAlgorithm::QgsRasterLogicalAndAlgorithm()
248 mExtractValFunc = [ = ](
const std::vector< std::unique_ptr< QgsRasterBlock > > &inputs,
bool & res,
bool & resIsNoData,
int row,
int column,
bool treatNoDataAsFalse )
252 bool isNoData =
false;
253 for (
auto &block : inputs )
256 if ( !block || !block->isValid() )
258 if ( treatNoDataAsFalse )
271 value = block->valueAndNoData( row, column, isNoData );
272 if ( isNoData && !treatNoDataAsFalse )
280 if ( treatNoDataAsFalse )
288QString QgsRasterLogicalAndAlgorithm::name()
const
290 return QStringLiteral(
"rasterbooleanand" );
293QString QgsRasterLogicalAndAlgorithm::displayName()
const
295 return QObject::tr(
"Raster boolean AND" );
299QString QgsRasterLogicalAndAlgorithm::shortDescription()
const
301 return QObject::tr(
"Calculates the boolean AND for a set of input raster layers" );
304QString QgsRasterLogicalAndAlgorithm::shortHelpString()
const
306 return QObject::tr(
"This algorithm calculates the boolean AND for a set of input rasters. If all of the input rasters have a non-zero value for a pixel, "
307 "that pixel will be set to 1 in the output raster. If any of the input rasters have 0 values for the pixel it will be set to 0 in the output raster.\n\n"
308 "The reference layer parameter specifies an existing raster layer to use as a reference when creating the output raster. The output raster "
309 "will have the same extent, CRS, and pixel dimensions as this layer.\n\n"
310 "By default, a NoData pixel in ANY of the input layers will result in a NoData pixel in the output raster. If the "
311 "'Treat NoData values as false' option is checked, then NoData inputs will be treated the same as a 0 input value." );
314QgsRasterLogicalAndAlgorithm *QgsRasterLogicalAndAlgorithm::createInstance()
const
316 return new QgsRasterLogicalAndAlgorithm();
@ Float32
Thirty two bit floating point (float)
@ Int8
Eight bit signed integer (qint8) (added in QGIS 3.30)
@ Advanced
Parameter is an advanced parameter which should be hidden from users by default.
@ Double
Double/float values.
Base class for all map layer types.
virtual QgsRectangle extent() const
Returns the extent of the layer.
QgsCoordinateReferenceSystem crs
Contains information about the context in which a processing algorithm is executed.
QgsCoordinateTransformContext transformContext() const
Returns the coordinate transform context.
Custom exception class for processing related exceptions.
Base class for providing feedback from a processing algorithm.
A numeric output for processing algorithms.
A string output for processing algorithms.
A boolean parameter for processing algorithms.
A parameter for processing algorithms which accepts multiple map layers.
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
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.
static QString driverForExtension(const QString &extension)
Returns the GDAL driver name for a specified file extension.
Represents a raster layer.
int height() const
Returns the height of the (unclipped) raster.
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.
unsigned long long qgssize
Qgssize is used instead of size_t, because size_t is stdlib type, unknown by SIP, and it would be har...
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)