QGIS algorithm - Greater than frequency

Source: R/qgis_greaterthanfrequency.R

QGIS Algorithm provided by QGIS (native c++) Greater than frequency (native:greaterthanfrequency). The Greater than frequency algorithm evaluates on a cell-by-cell basis the frequency (number of times) the values of an input stack of rasters are greater than the value of a value raster. If multiband rasters are used in the data raster stack, the algorithm will always perform the analysis on the first band of the rasters - use GDAL to use other bands in the analysis. The input value layer serves as reference layer for the sample layers. Any NoData cells in the value raster or the data layer stack will result in a NoData cell in the output raster if the ignore NoData parameter is not checked. The output NoData value can be set manually. The output rasters extent and resolution is defined by the input raster layer and is always of int32 type.

qgis_greaterthanfrequency(
  INPUT_VALUE_RASTER = qgisprocess:::qgis_default_value(),
  INPUT_VALUE_RASTER_BAND = qgisprocess:::qgis_default_value(),
  INPUT_RASTERS = qgisprocess:::qgis_default_value(),
  IGNORE_NODATA = qgisprocess:::qgis_default_value(),
  OUTPUT_NODATA_VALUE = qgisprocess:::qgis_default_value(),
  CREATE_OPTIONS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT_VALUE_RASTER

raster - Input value raster. Path to a raster layer.

INPUT_VALUE_RASTER_BAND

band - Value raster band. Integer value representing an existing raster band number.

INPUT_RASTERS

multilayer - Input raster layers. .

IGNORE_NODATA

boolean - Ignore NoData values. 1 for true/yes. 0 for false/no. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

OUTPUT_NODATA_VALUE

number - Output NoData value. A numeric value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

CREATE_OPTIONS

string - Creation options. String value. field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field. expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression.

OUTPUT

rasterDestination - Output layer. Path for new raster layer.

...

further parameters passed to qgisprocess::qgis_run_algorithm()

.complete_output

logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.

.quiet

logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.

.messages

logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

  • CRS_AUTHID - outputString - CRS authority identifier

  • EXTENT - outputString - Extent

  • FOUND_LOCATIONS_COUNT - outputNumber - Count of cells with equal value occurrences

  • HEIGHT_IN_PIXELS - outputNumber - Height in pixels

  • MEAN_FREQUENCY_PER_LOCATION - outputNumber - Mean frequency at valid cell locations

  • OCCURRENCE_COUNT - outputNumber - Count of value occurrences

  • OUTPUT - outputRaster - Output layer

  • TOTAL_PIXEL_COUNT - outputNumber - Total pixel count

  • WIDTH_IN_PIXELS - outputNumber - Width in pixels