1.. index:: ! polar
2.. include:: ../module_supplements_purpose.rst_
3
4*****
5polar
6*****
7
8|polar_purpose|
9
10Synopsis
11--------
12
13.. include:: ../../common_SYN_OPTs.rst_
14
15**gmt polar**
16[ *table* ]
17|-D|\ *lon/lat*
18|-J|\ *parameters*
19|SYN_OPT-R|
20|-M|\ *size*\ [**+m**\ *mag*]
21|-S|\ *<symbol><size>*
22[ |SYN_OPT-B| ]
23[ |-E|\ *fill* ]
24[ |-F|\ *fill* ]
25[ |-G|\ *fill* ]
26[ |-N| ]
27[ |-Q|\ *mode*\ [*args*] ]
28[ |-T|\ [**+a**\ *angle*][**+f**\ *font*][**+j**\ *justify*][**+o**\ *dx*\[/*dy*]] ]
29[ |SYN_OPT-U| ]
30[ |SYN_OPT-V| ]
31[ |-W|\ *pen* ]
32[ |SYN_OPT-X| ]
33[ |SYN_OPT-Y| ]
34[ |SYN_OPT-di| ]
35[ |SYN_OPT-e| ]
36[ |SYN_OPT-h| ]
37[ |SYN_OPT-i| ]
38[ |SYN_OPT-qi| ]
39[ |SYN_OPT-t| ]
40[ |SYN_OPT-:| ]
41[ |SYN_OPT--| ]
42
43.. module_common_begins
44
45Description
46-----------
47
48Plot observations from a single earthquake observed at various stations
49at different azimuths and distances on the lower hemisphere of the focal
50sphere.  The focal sphere is typically plotted at the location of the earthquake,
51specified via **-D**. Reads data values from *files* [or standard input].
52
53Parameters are expected to be in the following columns:
54
55    **1**,\ **2**,\ **3**:
56        *station-code azimuth take-off-angle*
57        (all three columns must contain numerical values)
58    **4**:
59        polarity:
60
61        - compression can be c,C,u,U,+
62
63        - rarefaction can be d,D,r,R,-
64
65        - not defined is anything else
66
67Required Arguments
68------------------
69
70.. |Add_intables| unicode:: 0x20 .. just an invisible code
71.. include:: ../../explain_intables.rst_
72
73.. _-D:
74
75**-D**\ *lon/lat*
76    Centers the focal sphere at given longitude and latitude point on the map.
77
78.. |Add_-J| replace:: |Add_-J_links|
79.. include:: /explain_-J.rst_
80    :start-after: **Syntax**
81    :end-before: **Description**
82
83.. _-M:
84
85**-M**\ *size*\ [**+m**\ *mag*]
86    Sets the size of the focal sphere to plot polarities in. *size* is in
87    default units (unless **c**, **i**, or **p** is appended).
88    Optionally append **+m**\ *mag* to specify its magnitude,
89    then focal sphere size is *mag* / 5.0 * *size*.
90
91.. _-R:
92
93.. |Add_-Rgeo| replace:: |Add_-R_auto_table|
94.. include:: ../../explain_-Rgeo.rst_
95
96.. _-S:
97
98**-S**\ *<symbol_type><size>*
99    Selects *symbol_type* and symbol *size*. Size is in default units (unless
100    **c**, **i**, or **p** is appended). Choose symbol type from
101    st(*a*)r, (*c*)ircle, (*d*)iamond, (*h*)exagon, (*i*)nverted
102    triangle, (*p*)oint, (*s*)quare, (*t*)riangle, (*x*)cross.
103
104Optional Arguments
105------------------
106
107.. |Add_-B| replace:: |Add_-B_links|
108.. include:: ../../explain_-B.rst_
109    :start-after: **Syntax**
110    :end-before: **Description**
111
112.. _-E:
113
114**-E**\ *fill* :ref:`(more ...) <-Gfill_attrib>`
115    Selects filling of symbols for stations in extensive quadrants. Set
116    the color [Default is 250]. If **-E**\ *fill* is the same as
117    **-F**\ *fill*, use **-Qe** to outline.
118
119.. _-F:
120
121**-F**\ *fill* :ref:`(more ...) <-Gfill_attrib>`
122    Sets background color of the focal sphere. Default is no fill.
123
124.. _-G:
125
126**-G**\ *fill* :ref:`(more ...) <-Gfill_attrib>`
127    Selects filling of symbols for stations in compressional quadrants.
128    Set the color [Default is black].
129
130.. _-N:
131
132**-N**
133    Does **not** skip symbols that fall outside map border [Default plots points inside border only].
134
135.. _-Q:
136
137**-Q**\ *mode*\ [*args*]
138    Sets one or more attributes; repeatable. The various combinations are
139
140    **-Qe**\ [pen]
141        Outline symbols in extensive quadrants using *pen* or the default pen (see |-W|).
142
143    **-Qf**\ [pen]
144        Outline the focal sphere using *pen* or the default pen (see |-W|).
145
146    **-Qg**\ [pen]
147        Outline symbols in compressional quadrants using *pen* or the default pen (see |-W|).
148
149    **-Qh**
150        Use special format derived from HYPO71 output
151
152    **-Qs**\ *half-size*\ [**+v**\ *v_size*\ [*vecspecs*]]
153        Plots S polarity azimuth. S polarity is in last column. Append **+v** to select a vector
154        and append head size and any vector specifications.  If **+v** is given without arguments then we
155	default to **+v**\ 0.3i+e+gblack [Default is a line segment].
156        Give *half-size* in default units (unless **c**, **i**, or **p** is appended).
157        See `Vector Attributes`_ for specifying additional attributes.
158
159    **-Qt**\ *pen*
160        Set pen color to write station code. Default uses the default pen (see |-W|).
161
162.. _-T:
163
164**-T**\ [**+a**\ *angle*][**+f**\ *font*][**+j**\ *justify*][**+o**\ *dx*\[/*dy*]]
165    Write station code near symbols.
166
167    Optionally append **+a**\ *angle* to change the text angle;
168    **+f**\ *font* to set the font of the text;
169    append **+j**\ *justify* to change the text location relative to the symbol;
170    append **+o** to offset the text string by *dx*/*dy*.
171    [Default to write station code above the symbol; the default font size is 12p]
172
173.. |Add_-U| replace:: |Add_-U_links|
174.. include:: ../../explain_-U.rst_
175    :start-after: **Syntax**
176    :end-before: **Description**
177
178.. |Add_-V| replace:: |Add_-V_links|
179.. include:: /explain_-V.rst_
180    :start-after: **Syntax**
181    :end-before: **Description**
182
183.. _-W:
184
185**-W**\ [**-**\|\ **+**][*pen*][*attr*] :ref:`(more ...) <-Wpen_attrib>`
186    Set current pen attributes [Default pen is default,black,solid].
187
188.. |Add_-XY| replace:: |Add_-XY_links|
189.. include:: ../../explain_-XY.rst_
190    :start-after: **Syntax**
191    :end-before: **Description**
192
193.. |Add_-di| unicode:: 0x20 .. just an invisible code
194.. include:: ../../explain_-di.rst_
195
196.. |Add_-e| unicode:: 0x20 .. just an invisible code
197.. include:: ../../explain_-e.rst_
198
199.. include:: ../../explain_-icols.rst_
200.. include:: ../../explain_-qi.rst_
201.. include:: ../../explain_-t.rst_
202
203.. include:: ../../explain_colon.rst_
204.. include:: ../../explain_help.rst_
205
206.. include:: ../../explain_vectors.rst_
207
208.. module_common_ends
209
210Examples
211--------
212
213.. include:: ../../oneliner_info.rst_
214
215::
216
217    gmt polar -R239/240/34/35.2 -JM8c -N -Sc0.4 -D239.5/34.5 -M5 -pdf test << END
218    #stat azim ih pol
219    0481 11 147 c
220    6185 247 120 d
221    0485 288 114 +
222    0490 223 112 -
223    0487 212 109 .
224    END
225
226Use special format derived from HYPO71 output::
227
228    gmt polar -R239/240/34/35.2 -JM8c -N -Sc0.4 -D239:30E/34:30N -M5 -Qh -pdf test <<END
229    #Date Or. time stat azim ih
230    910223 1 22 0481 11 147 ipu0
231    910223 1 22 6185 247 120 ipd0
232    910223 1 22 0485 288 114 epu0
233    910223 1 22 0490 223 112 epd0
234    910223 1 22 0487 212 109 epu0
235    END
236
237.. include:: meca_notes.rst_
238
239See Also
240--------
241
242:doc:`meca`,
243:doc:`coupe`,
244:doc:`gmt </gmt>`, :doc:`basemap </basemap>`, :doc:`plot </plot>`
245