r3.mask(1)

📦
version 8.4.2 · 8 versions
, in fedora 44

💖 r3.mask 💖

okay bestie, so this is a page from the GRASS GIS User's Manual (that's the manual name, we're folding it in, you're welcome) and it's literally all about r3.mask — the girl whose whole job is setting up your current working 3D raster mask. Yes, 3D. Voxels. The whole vibe. 🧚

✨ KEYWORDS ✨

raster3d, mask, null data, no-data, voxel

like… that's the tag cloud, that's the energy. 🔥

🌸 SYNOPSIS 🌸

r3.mask
r3.mask --help
r3.mask map=string  [maskvalues=val[-val][,val[-val],...]]   [--help]
[--verbose]  [--quiet]  [--ui]

🎀 Flags:

  • --help — prints the usage summary, aka the "what even is this" button
  • --verbose — verbose module output, she's chatty, she's telling you everything
  • --quiet — quiet module output, she's giving ✨mysterious✨
  • --ui — force launches the GUI dialog, for when you want the pretty buttons

🦋 Parameters:

  • map=string — required 🚨 this is your 3D raster map with reference values
  • maskvalues=val[-val][,val[-val],...] — the list of cell values to be masked out

💅 DESCRIPTION 💅

r3.mask facilitates the creation of a raster3d "MASK" map to control raster3d operations. (Facilitates. She's helpful like that. She's the main character of your voxel pipeline, no cap.)

The raster3d map is used as the reference map.

Here's the tea 🍓: cells in the mask get marked as "mask out" if the corresponding cell in map contains a value in the range specified with maskvalues.

That's it. That's the whole plot. Iconic behavior honestly.

👑 NOTES 👑

🚨 Listen up bestie, this one MATTERS: before a new 3D-mask can be created, the existing mask has to be removed with g.remove. No shortcuts. Don't come crying to me when your stale mask is still masking. 😭

🌈 SEE ALSO 🌈

  • g.remove

iykyk 💜

🫶 AUTHORS 🫶

Roman Waupotitsch, Michael Shapiro, Helena Mitasova, Bill Brown, Lubos Mitas, Jaro Hofierka

(the literal founding mothers and fathers of your 3D raster life, we stan) 👑

⭐ SOURCE CODE ⭐

Available at: r3.mask source code (history)

Accessed: Saturday Jan 17 05:41:15 2026

Main index | 3D raster index | Topics index | Keywords index | Graphical index | Full index

© 2003-2025 GRASS Development Team, GRASS GIS 8.4.2 Reference Manual

and that's the whole thing, babe — this was the r3.mask page from GRASS 8.4.2, accessed Saturday Jan 17 05:41:15 2026, brought to you by the GRASS Development Team, © 2003-2025. go mask responsibly 💖✨🎀🦋

📦 where this page comes from