r3.mask(1grass)

💖 r3.mask — the 1grass manual page, bestie edition 💖

okay so picture this: you're out here doing 3D raster things in GRASS, and you need a bouncer at the door. that's r3.mask. she's not loud, she's not flashy, but she decides which voxels get in and which ones get politely told "no 💅".

---

✨ NAME ✨

r3.mask — sets up the current working 3D raster mask. that's it. that's the job. she establishes it, she doesn't over-explain, she's giving main character energy with minimal dialogue.

---

🔑 KEYWORDS 🔑

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

like, this is your search-term vibe check. iykyk. 🦋

---

📜 SYNOPSIS 📜

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

so basically you're feeding her a map, and optionally a little list of maskvalues, and she does the thing. ⭐

🚩 Flags

• --help — prints the usage summary. your "what does this even do" button, no shame in pressing it.
• --verbose — verbose module output. she will tell you everything. chatty queen.
• --quiet — quiet module output. she will tell you nothing. mysterious queen.
• --ui — force launches the GUI dialog. for when you want to click instead of type 🎀

🎛️ Parameters

• map=string [required] — a 3D raster map with reference values. this is the required bestie, she cannot be skipped. no map, no mask, no cap. 💀
• maskvalues=val[-val][,val[-val],...] — the list of cell values you want masked out. you can list single values, or ranges written as val-val, and stack them up comma-separated. yes, the syntax is literally in the parameter definition, so copy it exactly, don't freestyle: val[-val][,val[-val],...] 🫶

---

🌸 DESCRIPTION 🌸

okay so r3.mask makes it so easy to create a raster3d "MASK" map, and that mask is what controls your raster3d operations. think of it as the velvet rope.

the raster3d map you hand over gets used as the reference map. then, for every cell, she checks: does the corresponding cell in map hold a value that falls in the range you gave her with maskvalues? if yes? that cell is marked "mask out". bye bestie, you're not participating. 😭✨

---

📝 NOTES 📝

real talk: before you can create a brand new 3D-mask, the existing mask has to be removed first, and you do that with g.remove.

no sneaking a new mask in while the old one's still standing. clear the runway first, then slay. 💅

---

👀 SEE ALSO 👀

• g.remove

that's the one. that's the whole list. go love her. 💜

---

👑 AUTHORS 👑

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

an absolute icon lineup, fr fr. legends only. 🌈

---

💻 SOURCE CODE 💻

Available at: r3.mask source code (history)

Latest change: Friday Feb 07 19:16:09 2025 in commit: a82a39f673b97fafcfce1604dc3e6015cb96487a

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

---

and that's the whole page, bestie 🥰 this was the r3.mask manual for GRASS 8.5.0, © 2003-2026 GRASS Development Team — go forth, mask responsibly, and remember: clear that old mask with g.remove first. obsessed with you. bye!! 💖✨🎀🦋🌸