- Draws the boxplot of the rastrers of a space-time raster dataset
t.rast.boxplot [-onhgd] input=name [output=File name] [dpi=integer] [range=float] [plot_dimensions=string] [rotate_labels=float] [font_size=integer] [date_format=string] [axis_limits=string] [bx_width=float] [bx_color=name] [bx_lw=float] [median_lw=float] [median_color=name] [whisker_linewidth=float] [flier_marker=string] [flier_size=string] [flier_color=name] [--overwrite] [--help] [--verbose] [--quiet] [--ui]
- Include outliers
- Draw boxplot(s) with outliers
- Draw notch
- Draw boxplot(s) with notch
- Horizontal boxplot(s)
- Draw the boxplot horizontal
- Add grid lines
- Add grid lines
- Us date format as compact as possible while still having complete date information. This will override the data_format setting.
- Allow output files to overwrite existing files
- Print usage summary
- Verbose module output
- Quiet module output
- Force launching GUI dialog
- input=name [required]
- input space-time raster dataset
- output=File name
- Name of output image file
- Name for output file
- Resolution of plot
- Range (value > 0)
- This determines how far the plot whiskers extend out from the box. If range is positive, the whiskers extend to the most extreme data point which is no more than range times the interquartile range from the box. A value of zero causes the whiskers to extend to the data extremes.
- Default: 1.5
- Plot dimensions (width,height)
- Dimensions (width,height) of the figure in inches
- Rotate labels
- Rotate labels (degrees)
- Options: -90-90
- Font size
- Font size of labels
- Default: 10
- Date format
- Set date format (see https://strftime.org/ for options)
- limit value axis
- min and max value of y-axis, or x-axis if -h flag is set)
- Boxplot width
- The width of the boxplots
- Boxplot color
- Color of the boxplots. See manual page for color notation options.
- Default: white
- boxplot linewidth
- The linewidth of the boxplots
- Default: 1
- width of the boxplot median line
- Default: 1.1
- Color of the boxlot median line
- Color of median
- Default: orange
- Whisker and cap linewidth
- The linewidth of the whiskers and caps
- Default: 1
- Flier marker
- Set flier marker (see https://matplotlib.org/stable/api/markers_api.html for options)
- Default: o
- Flier size
- Set the flier size
- Default: 2
- Flier color
- Set the flier color
- Default: black
draws boxplots of the raster in a space-time
raster data set (strds). The module can be used to display changes over
time, and how this varies within a area. It will plot all rasters in
a strds. To display a subset of a strds, the user first needs to create
a new strds with the required subset of raster layers. It will
furthermore, plot the boxplots using the temporal granularity
The whiskers of the boxplots extend to the most extreme data point,
which is no more than range ✕ the interquartile range
(iqr) from the box. By default, a range of 1.5 is used, but the
user can change this. Note that range values need to be larger than 0.
There are a few plot format/layout options, including the option to
rotate the plot and the x-axis labels, print the boxplot(s) with
notches, and to include the outliers (by default, they are not
included). You can also set the limits of the y-axis (or the x-axis if
the -h flag is set). This makes it easier to compare the boxplots of
two time-series of, e.g., two different areas.
There are various option to format the boxplots, e.g., setting the
width and color of the boxplots, the color and thickness of the median
line(s), whisker line width, and flier marker type and color.
The default format of the date-time labels on the x-axis (or y-axis in
case the boxplots are plotted horizontally) depend on the temporal
granularity of the data. This can be changed by the user. For a list of
options, see the Python strftime
Alternatively, the user can set the -d flag. With this option,
an attempt is made to figure out the best tick locations and format to
use, and to make the format as compact as possible while still having
complete date information. Note, this will override the
data_format setting. With this option, often not all boxplots
will get a label.
By default, the resulting plot is displayed on screen. However, the
user can also save the plot to file using the output option.
The format is determined by the extension given by the user. So, if
output = outputfile.png, the plot will be saved as a *png* file. The
user can set the output size (in inches) and resolution (dpi) of the
If you work with a large number of raster layers, of if the raster
layers are very large, try to avoid setting the 'range' value very low,
as that may result in a massive number of outliers, slowing down the
computations and rendering of the plot.
The t.rast.boxplot module operates on the raster array defined by the
current region settings, not the original extent and resolution of the
input map. See g.region
to understand the impact of the region settings on the calculations.
You can change the width of the boxplot using the bx_width
parameter. The default value is 0.75, which means that the boxplots
0.75 the maximum width between two consecutive periods. Importantly,
the function uses the time stamp unit (see
t.register) to determine the maximum width. This means that if
the time stamp unit is in days, but the raster layers represent e.g.,
10-day periods, you need to multiply the bx_width value you would
normally use by 10 to get the same relative width. See
this post for an example.
The first two examples use the MODIS Land Surface Temperature mapset.
First download the North Caroline sample data set from this
. Unzip the sample GRASS GIS dataset to a convenient location
on your computer. Next, download the MODIS mapset (link
and unzip this in the NC location of the NC database. Now, open the
mapset in GRASS GIS.
Plot the time series, using the default settings, except that we set
the dimension of the plot to 12 inch (ca. 30 cm) wide and 8 inch (ca.
20 cm) height, and a dpi of 200
t.rast.boxplot input=LST_Day_monthly@modis_lst \
We use the same example as above, but this time, we change the color of
the boxplots and median lines to respectively green
) and white (median_color=white
), use the
default plot dimensions, set the font size to 8, and include the
outliers (-o flag
). Note that by plotting the outliers will
increase the time required to create the plot considerably.
For the outliers (fliers) we use orange squares (flier_marker=s
& flier_color=orange). We furthermore plot the boxplots
horizontally (-h flag) and add grid lines (-g flag. Note
that for horizontal plots, the labels are plotted horizontally (equal
to rotate_labels=0) by default.
t.rast.boxplot -o -h -g input=LST_Day_monthly@modis_lst \
bx_color=green median_color=white median_lw=0.8 bx_lw=0.8 \
flier_color=orange flier_size=1 flier_marker=s font_size=8
for the different formats in which colors can be specified.
In the following example, the date labels are changed, showing the
abbreviated name of the month, followed by the year (date_format="%B
). The boxplot colors are set to white, and for the median line
we set the color to orange and the line width to 2. Lastly, the labels
are rotated 90℃ (the default for vertical plots is
t.rast.boxplot input=LST_Day_monthly@modis_lst rotate_labels=90 \
date_format="%B %Y" bx_color=white median_lw=2 median_color=red \
If we want to plot 3-monthly patterns instead, we first need to create
a new strds. In the example below, the function
is used to aggregate the LST_Day_monthly to a
3 month granularity.
t.rast.aggregate input=LST_Day_monthly@modis_lst output=LST_Day_3monthly \
basename=LST_3monthly granularity="3 months" method=average
Now, we can plot the 3-monthly temporal pattern using the newly created
strds as input.
As you can see below, the plot plots the boxplots using the 3-month
granularity of the input strds.
This work was carried in the framework of the Save the tiger, save
the grassland, save the water
project by the Innovative Bio-Monitoring research group
of the HAS
University of Applied Sciences.
Paulo van Breugel
Applied Geo-information Sciences HAS University of Applied
t.rast.boxplot source code
Latest change: Monday Jan 30 19:52:26 2023 in commit: cac8d9d848299297977d1315b7e90cc3f7698730
Main index |
Temporal index |
Topics index |
Keywords index |
Graphical index |
GRASS Development Team,
GRASS GIS 8.3.1dev Reference Manual