wxGUI.modules(1grass)

💖 wxGUI Module dialogs 💖

okay bestie, welcome to the GRASS User's Manual page for wxGUI.modules — the one that explains the module dialog situation. sit down, hydrate, and let's get into it 🫶

🌸 KEYWORDS

general, GUI

---

✨ DESCRIPTION ✨

So here's the tea: GRASS functionality is organized into modules, which are standalone programs with a defined interface. Their graphical user interface (GUI) is literally just a dialog with several tabs, and those tabs organize the module parameters into groups. cute, organized, iconic. 💅

Each parameter can have a different type of input field — like, a text entry, or a drop-down list, depends on the vibe. Flags show up as checkboxes. The parameter (or flag) name is visible on the right side of each input field, so it's super easy to see how the module dialog relates to the command representation that gets used in the manuals and tutorials. And those commands? You can use them to call the module in the command line, in Shell scripts, or — with a slight modification — in a Python script. multi-talented fr fr ✨

🎀 Tabs

Module parameters and flags are organized in tabs. Their names can depend on a module, but bestie, every module has a Command output tab where you can watch the progress, and where the module output gets printed — text results, warnings, all of it. The last tab, Manual, has the description of the module's parameters and examples. Same info lives in the online manual too, no cap.

The style of the tabs can be changed through GUI settings — Appearance — Module dialog style. Quick note though: the style appearance depends on the platform, and some styles might be more suitable for different platforms. There's a Figure in the original showing an example of style "left" and "top" on Ubuntu. ✨

👑 Flags

Module flags are represented as checkboxes with description. And there are three special flags — overwrite, verbose and quiet. The verbose and quiet flags set the level of verbosity of the module (aka how detailed the messages should be). 🗣️

Modules which output a new map or a new file have the overwrite flag, and you must use it when the specified output map or file is already present. If the map or file of the specified name already exists and you didn't use the overwrite flag, an error message appears:

r.slope.aspect elevation=elevation slope=slope
ERROR: option <slope>: <slope> exists. To overwrite, use the --overwrite flag

And if you're using the command instead of the GUI, these flags are — unlike other flags — prefixed with a double dash:

r.slope.aspect elevation=elevation slope=slope --overwrite --quiet

🦋 Current working directory

Certain modules require a file as input or output. You either specify the full path to the file, or a path relative to the current working directory is enough — like, literally just the name of the file. The current working directory is the directory where GRASS would look for or output files to if the full path isn't specified. By default the working directory is the user's home folder. 🏠

You can change it in the wxGUI menu Settings — GRASS working environment — Change working directory, or by typing cd and pressing Enter in the wxGUI Command console. And the glow-up here? If you change the working directory to a directory where the input files are, then it's enough to specify just the name of the file instead of the full path. periodt. 💅

This applies to external files such as text files or GeoTiff files. It does not apply to raster maps, vector maps and other geospatial data stored in the GRASS database — those don't need any path to be specified at all. 🗂️

🧚 Special widgets

For raster, vector or 3D raster input, there's a special widget which — after you click on the arrow to the right — pops up a list of existing maps from different mapsets. Selecting a map from the popup list adds it to the entry field. And if multiple maps can be specified (denoted by the [multiple] label), selecting a map from the popup list will append the map names with comma in between. 🔥

If the input file is supposed to be a text file (for example color rules in r.colors), you can type the text in the provided box directly instead of creating a new file in a text editor and saving it. A temporary file is created in this case. Pressing the Save as button then saves the content of the box into a user specified file, so your workflow can be reproduced later. And with the Load button we can display the content of the selected file and edit it directly in the box. Obsessed. 😭✨

There's a Figure in the original: in the first image, user specified a full path to a file. In the second image, user typed color rules conveniently into the box below — however, plot twist — the rules will not be stored permanently. 💀

---

💜 NOTES 💜

Dialogs are generated automatically based on the module interface defined using g.parser. And you can get the command line interface when running the module with a --help flag — the options and flags are the same as in the module GUI. iconic.

r.neighbors --help
Description:
 Makes each cell category value a function of the category
values assigned to the cells around it, and stores new cell
values in an output raster map layer.
Keywords:
 raster, algebra, statistics, aggregation, neighbor, focal
statistics, filter
Usage:
 r.neighbors [-ac] input=name [selection=name]
output=name[,name,...]
   [method=string[,string,...]] [size=value] [title=phrase]
[weight=name]
   [gauss=value] [quantile=value[,value,...]] [--overwrite]
[--help]
   [--verbose] [--quiet] [--ui]
Flags:
  -a   Do not align output with the input
  -c   Use circular neighborhood
 --o   Allow output files to overwrite existing files
 --h   Print usage summary
 --v   Verbose module output
 --q   Quiet module output
 --ui  Force launching GUI dialog
Parameters:
      input   Name of input raster map
  selection   Name of an input raster map to select the
cells which should be processed
     output   Name for output raster map
     method   Neighborhood operation
              options:
average,median,mode,minimum,maximum,range,stddev,sum,
count,variance,diversity,interspersion,quart1,quart3,
                       perc90,quantile
              default: average
       size   Neighborhood size
              default: 3
      title   Title for output raster map
     weight   Text file containing weights
      gauss   Sigma (in cells) for Gaussian filter
   quantile   Quantile to calculate for method=quantile
              options: 0.0-1.0

---

🌈 SEE ALSO 🌈

• wxGUI, wxGUI components

---

🫶 AUTHORS 🫶

• GRASS Development Team
• manual by Anna Petrasova, OSGeoREL, Faculty of Civil Engineering, Czech Technical University in Prague
• Vaclav Petras, OSGeoREL, Faculty of Civil Engineering, Czech Technical University in Prague

---

⭐ SOURCE CODE ⭐

Available at: wxGUI Module dialogs source code (history)

Accessed: Friday May 08 10:38:23 2026

Main index | Wxgui index | Topics index | Keywords index | Graphical index | Full index

---

and that's the whole page bestie, no cap 💖 this was GRASS 8.5.0 — wxGUI.modules(1grass) — © 2003-2026 GRASS Development Team, from the GRASS 8.5.0 Reference Manual. go slay your module dialogs 🎀✨👑