GRASS logo


r.bitpattern - Compares bit patterns with a raster map.


raster, algebra


r.bitpattern --help
r.bitpattern input=name output=name pattern=integer patval=integer [--overwrite] [--help] [--verbose] [--quiet] [--ui]


Allow output files to overwrite existing files
Print usage summary
Verbose module output
Quiet module output
Force launching GUI dialog


input=name [required]
Name of input raster map
output=name [required]
Name for output raster map
pattern=integer [required]
Bit pattern position(s)
patval=integer [required]
Bit pattern value

Table of contents


r.bitpattern performs bit pattern comparisons. The module can be used to pixelwise verify a satellite image for low quality pixels if a Quality Control Bit Index map is provided (e.g. as for MODIS sensor maps). The functionality is two-fold:
  1. define position: set bit(s) to 1 which shall match, then convert this position pattern to integer, set pattern= parameter with that integer value
  2. define pattern *value* which should be in that position: first bit pattern of value, convert to integer, set patval= parameter
If several bitpatterns have to be tested, the resulting maps can be used to exclude low quality pixels in the input satellite image using r.mapcalc (OR and NOT operators).


  1. Define position:
        xx xx 1x xx
        binary: 1000 -> integer: 8 -> pattern=8
  2. Define value:
        Ex.: We want to check for 0 in that position
        xx xx 0x xx
        binary: 0000 -> integer: 0 -> patval=0
        If value can be arbitrary (0/1), then assume 0 value


i.modis.qc, r.mapcalc


Radim Blazek, Markus Neteler


Available at: r.bitpattern source code (history)

Latest change: Monday Jan 30 19:49:11 2023 in commit: 5fb6b1a969e72db28df78483d3360b15a17f0c68

Main index | Raster index | Topics index | Keywords index | Graphical index | Full index

© 2003-2024 GRASS Development Team, GRASS GIS 8.3.3dev Reference Manual