# psrose¶

Plot a polar histogram (rose, sector, windrose diagrams)

## Synopsis¶

**gmt psrose** [ *table* ] [ **-A***sector_width*[**+r**] ]
[ **-B**[**p**|**s**]*parameters* ]
[ **-C****m**|[**+w**]*mode_file* ]
[ **-D** ]
[ **-F** ]
[ **-G***fill* ] [ **-I** ]
[ **-J****X***diameter* ]
[ **-K** ]
[ **-L**[*wlabel*,*elabel*,*slabel*,*nlabel*] ]
[ **-M***parameters* ]
[ **-O** ] [ **-P** ]
[ **-Q***alpha* ]
[ **-R***r0*/*r1*/*az0*/*az1* ]
[ **-S** ]
[ **-T** ]
[ **-U**[*stamp*] ]
[ **-V**[*level*] ]
[ **-W**[**v**]*pen* ]
[ **-X**[**a**|**c**|**f**|**r**][*xshift*] ]
[ **-Y**[**a**|**c**|**f**|**r**][*yshift*] ]
[ **-Z****u**|*scale* ]
[ **-bi**binary ]
[ **-di**nodata ]
[ **-e**regexp ]
[ **-h**headers ]
[ **-i**flags ]
[ **-p**flags ]
[ **-qi**flags ]
[ **-t**transp ]
[ **-:**[**i**|**o**] ]
[ **--PAR**=*value* ]

**Note:** No space is allowed between the option flag and the associated arguments.

## Description¶

**rose** reads (length, azimuth) pairs from *file* [or standard input]
and plot a windrose diagram. Add **-i**0 if your file only has azimuth values.
Optionally (with **-A**), polar histograms may be drawn (sector diagram
or rose diagram). Options include full circle and half circle plots. The
outline of the windrose is drawn with the same color as MAP_DEFAULT_PEN.

## Required Arguments¶

None.

## Optional Arguments¶

*table*- One or more ASCII (or binary, see
**-bi**[*ncols*][*type*]) data table file(s) holding a number of data columns. If no tables are given then we read from standard input. If a file with only azimuths are given, use**-i**to indicate the single column with azimuths; then all lengths are set to unity (see**-Zu**to set actual lengths to unity as well).

**-A***sector_width*[**+r**]- Gives the sector width in degrees for sector and rose diagram.
[Default 0 means windrose diagram]. Append
**+r**to draw rose diagram instead of sector diagram.

**-B**[**p**|**s**]*parameters*(more …)- Set map boundary frame and axes attributes.

**-C***cpt*- Give a CPT. The
*r*-value for each sector is used to look-up the sector color. Cannot be used with a rose diagram. If modern mode and no argument is given then we select the current CPT.

**-D**- Shift sectors so that they are centered on the bin interval (e.g., first sector is centered on 0 degrees).

**-E****m**|[**+w**]*mode_file*- Plot vectors showing the principal directions given in the
*mode_file*file. Alternatively, specify**-Em**to compute and plot mean direction. See**-M**to control the vector attributes. Finally, to instead save the computed mean direction and other statistics, use [**m**]**+w***mode_file*. The eight items saved to a single record are:*mean_az, mean_r, mean_resultant, max_r, scaled_mean_r, length_sum, n, sign@alpha*, where the last term is 0 or 1 depending on whether the mean resultant is significant at the level of confidence set via**-Q**.

**-F**- Do not draw the scale length bar [Default plots scale in lower right corner provided
**-B**is used]

**-G***fill*(more …)- Selects shade, color or pattern for filling the sectors [Default is no fill].

**-I**- Inquire. Computes statistics needed to specify a useful
**-R**. No plot is generated. The following statistics are written to stdout:*n*,*mean az*,*mean r*,*mean resultant length*,*max bin sum*,*scaled mean*, and*linear length sum*.

**-JX***diameter*- Sets the diameter of the rose diagram. Only this form of the projection machinery is supported for this module. If not given, then we default to a diameter of 7.5 cm.

**-L**[*wlabel*,*elabel*,*slabel*,*nlabel*]- Specify labels for the 0, 90, 180, and 270 degree marks. For
full-circle plot the default is WEST,EAST,SOUTH,NORTH and for
half-circle the default is 90W,90E,-,0. A - in any entry disables
that label. Use
**-L**with no argument to disable all four labels. Note that the GMT_LANGUAGE setting will affect the words used.

**-M***parameters*- Used with
**-E**to modify vector parameters. For vector heads, append vector head*size*[Default is 0, i.e., a line]. See VECTOR ATTRIBUTES for specifying additional attributes. If**-E**is not given and the current plot mode is to draw a windrose diagram then using**-M**will add vector heads to all individual directions using the supplied attributes.

**-Q**[*alpha*]- Sets the confidence level used to determine if the mean resultant
is significant (i.e., Lord Rayleigh test for uniformity) [0.05].
**Note**: The critical values are approximated [Berens, 2009] and requires at least 10 points; the critical resultants are accurate to at least 3 significant digits. For smaller data sets you should consult exact statistical tables.

**-R***r0*/*r1*/*az0*/*az1*- Specifies the ‘region’ of interest in (
*r*,*azimuth*) space. Here,*r0*is 0,*r1*is max length in units. For azimuth, specify either -90/90 or 0/180 for half circle plot or 0/360 for full circle.

**-S**- Normalize input radii (or bin counts if
**-A**is used) by the largest value so all radii (or bin counts) range from 0 to 1.

**-T**- Specifies that the input data are orientation data (i.e., have a 180 degree
ambiguity) instead of true 0-360 degree directions [Default]. We
compensate by counting each record twice: First as
*azimuth*and second as*azimuth + 180*. Ignored if range is given as -90/90 or 0/180.

**-U**[*label*][**+c**][**+j***just*][**+o***dx*/*dy*] (more …)- Draw GMT time stamp logo on plot.

**-V**[*level*] (more …)- Select verbosity level [
**w**].

**-W***pen*- Set pen attributes for sector outline or rose plot. [Default is no
outline]. Use
**-Wv***pen*to change pen used to draw vector (requires**-E**) [Default is same as sector outline].

**-X**[**a**|**c**|**f**|**r**][*xshift*]

**-Y**[**a**|**c**|**f**|**r**][*yshift*] (more …)- Shift plot origin.

**-Z****u**|*scale*- Multiply the data radii by
*scale*. E.g., use**-Z**0.001 to convert your data from m to km. To exclude the radii from consideration, set them all to unity with**-Zu**[Default is no scaling]. **-:**- Input file has (
*azimuth,radius*) pairs rather than the expected (*radius,azimuth*).

**-bi**[*ncols*][**t**] (more …)- Select native binary format for primary input. [Default is 2 input columns].

**-di***nodata*(more …)- Replace input columns that equal
*nodata*with NaN.

**-e**[**~**]*”pattern”*|**-e**[**~**]/*regexp*/[**i**] (more …)- Only accept data records that match the given pattern.

**-h**[**i**|**o**][*n*][**+c**][**+d**][**+m***segheader*][**+r***remark*][**+t***title*] (more …)- Skip or produce header record(s).

**-i***cols*[**+l**][**+s***scale*][**+o***offset*][,*…*][,**t**[*word*]] (more …)- Select input columns and transformations (0 is first column,
**t**is trailing text, append*word*to read one word only).

**-p**[**x**|**y**|**z**]*azim*[/*elev*[/*zlevel*]][**+w***lon0*/*lat0*[/*z0*]][**+v***x0*/*y0*] (more …)- Select perspective view.

**-qi**[~]*rows*[**+c***col*][**+a**|**f**|**s**] (more …)- Select input rows or data range(s) [all].

**-t**[*transp*] (more …)- Set transparency level in percent.

**-^**or just**-**- Print a short message about the syntax of the command, then exit (NOTE: on Windows just use
**-**). **-+**or just**+**- Print an extensive usage (help) message, including the explanation of any module-specific option (but not the GMT common options), then exit.
**-?**or no arguments- Print a complete usage (help) message, including the explanation of all options, then exit.
**--PAR**=*value*- Temporarily override a GMT default setting; repeatable. See gmt.conf for parameters.

## Vector Attributes¶

Several modifiers may be appended to vector-producing options for specifying the placement of vector heads, their shapes, and the justification of the vector. Below, left and right refers to the side of the vector line when viewed from the start point to the end point of a segment:

+aanglesets the angle of the vector head apex [30].

+bplaces a vector head at the beginning of the vector path [none]. Optionally, appendtfor a terminal line,cfor a circle,afor arrow [Default],ifor tail,Afor plain open arrow, andIfor plain open tail. Further appendl|rto only draw the left or right half-sides of this head [both sides].

+eplaces a vector head at the end of the vector path [none]. Optionally, appendtfor a terminal line,cfor a circle,afor arrow [Default],ifor tail,Afor plain open arrow, andIfor plain open tail. Further appendl|rto only draw the left or right half-sides of this head [both sides].

+g[fill] sets the vector head fill [Default fill is used, which may be no fill]. Turn off vector head fill by not appending afill.

+hshapesets the shape of the vector head (range -2/2). Default is controlled by MAP_VECTOR_SHAPE [0].

+ldraws half-arrows, using only the left side of specified heads [both sides].

+mplaces a vector head at the mid-point the vector path [none]. Appendforrfor forward or reverse direction of the vector [forward]. Optionally, appendtfor a terminal line,cfor a circle,afor arrow [Default],ifor tail,Afor plain open arrow, andIfor plain open tail. Further appendl|rto only draw the left or right half-sides of this head [both sides]. Cannot be combined with+bor+e.

+nnormscales down vector attributes (pen thickness, head size) with decreasing length, where vector plot lengths shorter thannormwill have their attributes scaled by length/norm[arrow attributes remains invariant to length]. For Cartesian vectors specify a length in plot units, while for geovectors specify a length in km.

+o[plon/plat] specifies the oblique pole for the great or small circles. Only needed for great circles if+qis given. If no pole is appended then we default to the north pole.

+p[pen] sets the vector pen attributes. If nopenis appended then the head outline is not drawn. [Default pen is half the width of stem pen, and head outline is drawn]

+qmeans the inputangle,lengthdata instead represent thestartandstopopening angles of the arc segment relative to the given point. See+oto specify a specific pole for the arc [north pole].

+rdraws half-arrows, using only the right side of specified heads [both sides].

+t[b|e]trimwill shift the beginning or end point (or both) along the vector segment by the giventrim; append suitable unit (c,i, orp). If the modifiersb|eare not used thentrimmay be two values separated by a slash, which is used to specify different trims for the beginning and end. Positive trims will shorted the vector while negative trims will lengthen it [no trim].

In addition, all but circular vectors may take these modifiers:

+jjustdetermines how the inputx,ypoint relates to the vector. Choose frombeginning [default],end, orcenter.

+smeans the inputangle,lengthare instead thex,ycoordinates of the vector end point.

Finally, Cartesian vectors may take these modifiers:

+zscaleexpects inputdx,dyvector components and uses thescaleto convert to polar coordinates with length in given unit.

**Note**: Vectors were completely redesigned for GMT5 which separated the vector head (a polygon)
from the vector stem (a line). In GMT4, the entire vector was a polygon and it could only
be a straight Cartesian vector. Yes, the old GMT4 vector shape remains accessible if
you specify a vector (**-Sv**|**V**) using the GMT4 syntax, explained here: *size*, if present, will
be interpreted as *arrowwidth/headlength/headwidth* [Default is 0.075c/0.3c/0.25c (or
0.03i/0.12i/0.1i)]. By default, arrow attributes remain invariant to the length of the
arrow. To have the size of the vector scale down with decreasing size, append **+n***norm*,
where vectors shorter than *norm* will have their attributes scaled by *length*/*norm*.
To center the vector on the balance point, use **-Svb**; to align point with the vector head,
use **-Svh**; to align point with the vector tail, use **-Svt** [Default]. To give the
head point’s coordinates instead of direction and length, use **-Svs**. Upper case
**B**, **H**, **T**, **S** will draw a double-headed vector [Default is single head].

## Classic Mode Arguments¶

These options are used to manipulate the building of layered GMT PostScript plots in classic mode. They are not available when using GMT modern mode.

**-K**(more …)- Do not finalize the PostScript plot.

**-O**(more …)- Append to existing PostScript plot.

**-P**(more …)- Select “Portrait” plot orientation.

## Examples¶

**Note**: Below are some examples of valid syntax for this module.
The examples that use remote files (file names starting with `@`

)
can be cut and pasted into your terminal for testing.
Other commands requiring input files are just dummy examples of the types
of uses that are common but cannot be run verbatim as written.

To plot a half circle rose diagram of the data in the file fault_segments.az_r (containing pairs of (azimuth, length in meters), using a 10 degree bin sector width, on a circle of diameter = 6 inch, grid going out to radius = 150 km in steps of 25 km with a 30 degree sector interval, radial direction annotated every 50 km, using a light blue shading outlined by a solid red pen (width = 0.75 points), draw the mean azimuth, and shown in Portrait orientation, use:

gmt psrose fault_segments.az_r -R0/150/-90/90 -Bx50g25+l"Fault length" -Byg30 -B+t"Rose diagram" -JX6i -A10+r -Glightblue -W0.75p,red -Z0.001 -Cm -P -T -: > half_rose.ps

To plot a full circle wind rose diagram of the data in the file lines.r_az, on a circle of diameter = 10 cm, grid going out to radius = 500 units in steps of 100 with a 45 degree sector interval, using a solid pen (width = 0.5 point, and shown in landscape [Default] orientation with UNIX timestamp and command line plotted, use:

gmt psrose lines.az_r -R0/500/0/360 -JX10c -Bxg100 -Byg45 -B+t"Windrose diagram" -W0.5p -U+c | lpr

Redo the same plot but this time add orange vector heads to each direction (with nominal head size 0.5 cm but this will be reduced linearly for lengths less than 1 cm) and save the plot, use:

`gmt psrose lines.az_r -R0/500/0/360 -JX10c -Bxg100 -Byg45 -B+t"Windrose diagram" -M0.5c+e+gorange+n1c -W0.5p -U+c > rose.ps`

## Bugs¶

No default radial scale and grid settings for polar histograms. Users
must run the module with **-I** to find max length in binned data set.

## References¶

Berens, P., 2009, CircStat: A MATLAB Toolbox for Circular Statistics, *J. Stat. Software, 31(10)*, 1-21.