From a82adc22864d854508993e82eddaa652eb9b3c77 Mon Sep 17 00:00:00 2001 From: Vaclav Petras Date: Tue, 28 Jan 2025 21:27:50 -0500 Subject: [PATCH] r.watershed: Use raster mask, not MASK, simplify doc (#4998) * Replaces uppercase MASK by whatever is more appropriate in the given context. * Simplifies the sentences about mask and nulls cells. They are the same, ignored, and reduce computational requirements. The original text was repetetive. The new text is trying to be more succinct. * The heading mentions no data, but not NULLs while text NULLs and not no data. The new text is trying to address that. * An example which is directly manipulating MASK is left as is. --- raster/r.watershed/front/r.watershed.html | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/raster/r.watershed/front/r.watershed.html b/raster/r.watershed/front/r.watershed.html index 5713f611ea3..6772fabf384 100644 --- a/raster/r.watershed/front/r.watershed.html +++ b/raster/r.watershed/front/r.watershed.html @@ -316,17 +316,15 @@

Basin threshold

stream segment is determined by the distance between the tributaries flowing into it. -

MASK and no data

+

Masking and no data

The r.watershed program does not require the user to have the current geographic region filled with elevation values. Areas without -elevation data (masked or NULL cells) are ignored. It is NOT necessary -to create a raster map (or raster reclassification) -named MASK for NULL cells. Areas without elevation data will -be treated as if they are off the edge of the region. Such areas will -reduce the memory necessary to run the program. Masking out -unimportant areas can significantly reduce processing time if the +elevation data (masked or NULL cells, i.e., no data) are ignored and +treated as if they were outside the region. Masking out +unimportant areas can significantly reduce processing time and memory +requirements if the watersheds of interest occupy a small percentage of the overall area.

@@ -357,7 +355,7 @@

Further processing of output layers

module, a number of approaches may be considered.
    -
  1. Use a resample of the basins catchment raster map as a MASK.
    +
  2. Use a resample of the basins catchment raster map as a raster mask.
    The equivalent vector map method is similar using v.select or v.overlay.
  3. @@ -386,7 +384,7 @@

    Further processing of output layers

    with r.thin. Each stream segment in the vector map will have the value of the associated basin. To isolate -subbasins and streams for a larger basin, a MASK for the larger basin +subbasins and streams for a larger basin, a mask for the larger basin can be created with r.water.outlet. The stream segments output serves as a guide where to place the outlet point used