Skip to content

Commit

Permalink
doc: Use lowercase for 2D raster mask (#5000)
Browse files Browse the repository at this point in the history
Similarly to #4401 and #4495, this replaces usage of MASK by mask or raster mask. It removes uppercase MASK when not needed.
  • Loading branch information
wenzeslaus authored Jan 28, 2025
1 parent 71410de commit 8845151
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/examples/notebooks/parallelization_tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@
" * write output maps/files with identical names (common mistake, but easy to fix)\n",
" * modify computational region\n",
" * modify vector attribute database\n",
" * modify MASK\n",
" * modify raster mask\n",
" * use [r.reclass](https://grass.osgeo.org/grass-stable/manuals/r.reclass.html) to reclassify from the same base map\n",
"\n",
"The following sections provide solutions, starting with the option to execute tools in separate mapsets, which addresses all of the issues above, except r.reclass."
Expand Down
2 changes: 1 addition & 1 deletion imagery/i.pca/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* AUTHOR(S): Original author Center for Space Research (Uni. of TX)
* Rewritten by Brad Douglas <rez touchofmadness com>
* NULL value/MASK handling and speed up by Markus Metz
* NULL value/mask handling and speed up by Markus Metz
*
* PURPOSE: Principal Component Analysis transform of raster data.
*
Expand Down
7 changes: 4 additions & 3 deletions raster/r.out.gdal/r.out.gdal.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ <h2>DESCRIPTION</h2>
(created imagery groups with the <em><a href="i.group.html">i.group</a></em>
module)
<p>As with most GRASS raster modules, the current region extents and region
resolution are used, and a MASK is respected if present.
resolution are used, and a raster mask is respected if present.
Use <em><a href="g.region.html">g.region</a></em>'s "align=", or "raster="
options if you need to realign the region settings to match the original
map's before export.
Expand Down Expand Up @@ -267,7 +267,8 @@ <h3>Export RGB with alpha channel that encodes NULL cells</h3>
equal to this nodata value will be interpreted as nodata. Using an additional
alpha channel means that all pixels with an alpha value of 0 are
transparent. The alpha channel thus represents per-pixel encoding of
nodata, just like the GRASS MASK (null file). That means when using an alpha
nodata, just like the GRASS raster mask or per-raster null file.
That means when using an alpha
channel, you do not need to "free up" any particular value, but you can
use any value you like to replace NULL cells, as long as the value can be
represented by the Byte data type. It does not matter if that value is
Expand Down Expand Up @@ -298,7 +299,7 @@ <h3>Export RGB with alpha channel that encodes NULL cells</h3>
# create group for export
i.group group=out_rgba input=out_r,out_g,out_b,out_a

# remove any MASK because this works only if there are
# remove any mask because this works only if there are
# no NULL cells in the bands to be exported
r.mask -r

Expand Down
5 changes: 3 additions & 2 deletions raster/r.resamp.bspline/r.resamp.bspline.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ <h2>DESCRIPTION</h2>
<p>
The input raster map is read at its native resolution, the output raster
map will be produced for the current computational region set with
<em><a href="g.region.html">g.region</a></em>. Any MASK will be respected, masked
values will be treated as NULL cells in both the input and the output map.
<em><a href="g.region.html">g.region</a></em>. A raster mask, if present,
will be respected. Masked values will be treated like other NULL cells
in both the input and output maps.
<p>Spline step values <b>ew_step</b> for the east-west direction and
<b>ns_step</b> for the north-south direction should not be smaller than
the east-west and north-south resolutions of the input map. For a raster
Expand Down
2 changes: 1 addition & 1 deletion vector/vectorintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ <h3>Vector-Raster-DB conversion</h3>

With <a href="v.to.points.html">v.to.points</a>,
<a href="v.to.rast.html">v.to.rast</a> and <a href="v.to.rast3.html">v.to.rast3</a>
conversions are performed. Note that a raster mask ("MASK") will not be
conversions are performed. Note that a raster mask will not be
respected since it is only applied when <em>reading</em> an existing
GRASS raster map.

Expand Down

0 comments on commit 8845151

Please sign in to comment.