GRASS logo

Note: This addon document is for an older version of GRASS GIS that will be discontinued soon. You should upgrade your GRASS GIS installation, and read the current addon manual page.

NAME

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

KEYWORDS

raster, algebra

SYNOPSIS

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

Flags:

--overwrite
Allow output files to overwrite existing files
--help
Print usage summary
--verbose
Verbose module output
--quiet
Quiet module output
--ui
Force launching GUI dialog

Parameters:

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

DESCRIPTION

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 pixel in the input satellite image using r.mapcalc (OR and NOT operators).

EXAMPLE

  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 arbitray (0/1), then assume 0 value
    

SEE ALSO

i.modis.qc, r.mapcalc

AUTHORS

Radim Blazek, Markus Neteler

SOURCE CODE

Available at: r.bitpattern source code (history)

Latest change: Mon Jun 28 07:54:09 2021 in commit: 1cfc0af029a35a5d6c7dae5ca7204d0eb85dbc55


Note: This addon document is for an older version of GRASS GIS that will be discontinued soon. You should upgrade your GRASS GIS installation, and read the current addon manual page.

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

© 2003-2023 GRASS Development Team, GRASS GIS 7.8.8dev Reference Manual