.TH r3.univar 1grass "" "GRASS 6.4.4" "Grass User's Manual"
.SH NAME
\fI\fBr3.univar\fR\fR  - Calculates univariate statistics from the non-null 3d cells of a raster3d map.
.SH KEYWORDS
raster3d, voxel, statistics
.SH SYNOPSIS
\fBr3.univar\fR
.br
\fBr3.univar help\fR
.br
\fBr3.univar\fR [\-\fBget\fR] \fBinput\fR=\fIname\fR  [\fBzones\fR=\fIname\fR]   [\fBoutput\fR=\fIname\fR]   [\fBpercentile\fR=\fIfloat\fR[,\fIfloat\fR,...]]   [\fBfs\fR=\fIcharacter\fR]   [\-\-\fBverbose\fR]  [\-\-\fBquiet\fR] 
.SS Flags:
.IP "\fB\-g\fR" 4m
.br
Print the stats in shell script style
.IP "\fB\-e\fR" 4m
.br
Calculate extended statistics
.IP "\fB\-t\fR" 4m
.br
Table output format instead of standard output format
.IP "\fB\-\-verbose\fR" 4m
.br
Verbose module output
.IP "\fB\-\-quiet\fR" 4m
.br
Quiet module output
.PP
.SS Parameters:
.IP "\fBinput\fR=\fIname\fR" 4m
.br
Name of input raster3d map
.IP "\fBzones\fR=\fIname\fR" 4m
.br
3D Raster map used for zoning, must be of type CELL
.IP "\fBoutput\fR=\fIname\fR" 4m
.br
Name for output file (if omitted or "-" output to stdout)
.IP "\fBpercentile\fR=\fIfloat[,\fIfloat\fR,...]\fR" 4m
.br
Percentile to calculate (requires extended statistics flag)
.br
Options: \fI0-100\fR
.br
Default: \fI90\fR
.IP "\fBfs\fR=\fIcharacter\fR" 4m
.br
Field separator
.br
Special characters: space, comma, tab
.br
Default: \fI|\fR
.PP
.SH DESCRIPTION
\fIr3.univar\fR calculates the univariate statistics for raster3d maps.
This includes the number of cells counted, minimum and maximum cell values,
range, arithmetic mean, population variance, standard deviation, and 
coefficient of variation. Statistics are calculated separately for every
category/zone found in the \fBzones\fR input map if given.
If the \fB-e\fR extended statistics flag is given the 1st quartile, median,
3rd quartile, and given \fBpercentile\fR are calculated.
If the \fB-g\fR flag is given the results are presented in a format suitable
for use in a shell script.
If the \fB-t\fR flag is given the results are presented in tabular format
with the given field separator. The table can immediately be converted to a
vector attribute table which can then be linked to a vector, e.g. the vector
that was rasterized to create the \fBzones\fR input raster.
.SH NOTES
As with most GRASS raster3d modules, \fIr3.univar\fR operates on the voxel
array defined by the current 3d region settings, not the original extent and
resolution of the input map. See \fIg.region\fR.
.PP
This module can use large amounts of system memory when the \fB-e\fR
extended statistics flag is used with a very large region setting. If the
region is too large the module should exit gracefully with a memory allocation
error. Basic statistics can be calculated using any size input region.
.SH TODO
\fImode, skewness, kurtosis\fR
.SH SEE ALSO
\fI
g.region,
r.univar,
r.average,
r.median,
r.mode,
r.quantile,
r.sum,
r.series,
r3.stats,
v.rast.stats,
r.statistics,
v.univar
\fR
.SH AUTHORS
Soeren Gebbert
.br
Code is based on r.univar from
.br
Hamish Bowman, Otago University, New Zealand
.br
and Martin Landa
.br
Zonal loop by Markus Metz
.PP
\fILast changed: $Date: 2012-08-14 11:11:23 +0200 (Tue, 14 Aug 2012) $\fR
.PP
Full index
.PP
© 2003-2014 GRASS Development Team