Register
Login
Resources
Docs Blog Datasets Glossary Case Studies Tutorials & Webinars
Product
Data Engine LLMs Platform Enterprise
Pricing Explore
Connect to our Discord channel

gmt.conf.rst 54 KB

You have to be logged in to leave a comment. Sign In
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
  1. .. index:: ! gmt.conf
  2. ********
  3. gmt.conf
  4. ********
  5. Configuration for GMT
  6. Description
  7. -----------
  8. The following is a list of the parameters that are user-definable in
  9. GMT. The parameter names are always given in **UPPER CASE**. The
  10. parameter values are case-insensitive unless otherwise noted. The system
  11. defaults are given in brackets [ for SI (or US) ].
  12. Note that default distances and lengths below are
  13. given in both cm or inch; the chosen default depends on your choice of
  14. default unit (see :term:`PROJ_LENGTH_UNIT`). You can explicitly specify
  15. the unit used for distances and lengths by appending **c** (cm), **i**
  16. (inch), or **p** (points). When no unit is indicated the value will be
  17. assumed to be in the unit set by :term:`PROJ_LENGTH_UNIT`. Several
  18. parameters take only **true** or **false**. Finally, most of these
  19. parameters can be changed on-the-fly via the **--PARAMETER**\ =\ *VALUE*
  20. option to any GMT program. However, a few are static and are only
  21. read via the **gmt.conf** file; these are labeled (static).
  22. Common Specifications
  23. ---------------------
  24. The full explanation for how to specify pens, pattern fills, colors, and
  25. fonts can be found in the :doc:`gmt` man page.
  26. ================================= ================
  27. THEMATIC SUB-SECTIONS *prefix*
  28. ================================= ================
  29. `COLOR Parameters`_ **COLOR_**
  30. `DIR Parameters`_ **DIR_**
  31. `FONT Parameters`_ **FONT_**
  32. `FORMAT Parameters`_ **FORMAT_**
  33. `GMT Miscellaneous Parameters`_ **GMT_**
  34. `I/O Parameters`_ **IO_**
  35. `MAP Parameters`_ **MAP_**
  36. `Projection Parameters`_ **PROJ_**
  37. `PostScript Parameters`_ **PS_**
  38. `Calendar/Time Parameters`_ **TIME_**
  39. ================================= ================
  40. .. _COLOR Parameters:
  41. COLOR Parameters
  42. ~~~~~~~~~~~~~~~~
  43. .. glossary::
  44. **COLOR_BACKGROUND**
  45. Color used for the background of images (i.e., when z < lowest color
  46. table entry) [black].
  47. **COLOR_FOREGROUND**
  48. Color used for the foreground of images (i.e., when z > highest
  49. color table entry) [white].
  50. **COLOR_HSV_MAX_S**
  51. Maximum saturation (0-1) assigned for most positive intensity value [0.1].
  52. **COLOR_HSV_MIN_S**
  53. Minimum saturation (0-1) assigned for most negative intensity value [1.0].
  54. **COLOR_HSV_MAX_V**
  55. Maximum value (0-1) assigned for most positive intensity value [1.0].
  56. **COLOR_HSV_MIN_V**
  57. Minimum value (0-1) assigned for most negative intensity value [0.3].
  58. **COLOR_MODEL**
  59. Selects in which color space a CPT should be interpolated.
  60. By default, color interpolation takes place directly on the RGB
  61. values which can produce some unexpected hues, whereas interpolation
  62. directly on the HSV values better preserves those hues. The choices
  63. are: **none** (default: use whatever the **COLOR_MODEL** setting in the
  64. CPT demands), **rgb** (force interpolation in RGB),
  65. **hsv** (force interpolation in HSV), **cmyk** (assumes colors are
  66. in CMYK but interpolates in RGB).
  67. **COLOR_NAN**
  68. Color used for the non-defined areas of images (i.e., where z = NaN) [127.5].
  69. .. _DIR Parameters:
  70. DIR Parameters
  71. ~~~~~~~~~~~~~~
  72. .. glossary::
  73. **DIR_CACHE**
  74. Cache directory where we save remote filenames starting in **@** (e.g., @hotspots.txt) [~/.gmt/cache].
  75. **DIR_DATA**
  76. Session data directory. Overrides the value of the environment variable **$GMT_DATADIR**
  77. (see :ref:`Directory parameters` in the CookBook).
  78. **DIR_DCW**
  79. Path to optional Digital Chart of the World polygon files.
  80. **DIR_GSHHG**
  81. Path to GSHHG files. Defaults to **$GMT_SHAREDIR**/coast if empty.
  82. .. _FONT Parameters:
  83. FONT Parameters
  84. ~~~~~~~~~~~~~~~
  85. .. glossary::
  86. **FONT**
  87. Sets the default for all fonts, except :term:`FONT_LOGO`. This setting is
  88. not included in the **gmt.conf** file.
  89. **FONT_ANNOT**
  90. Sets both :term:`FONT_ANNOT_PRIMARY` and :term:`FONT_ANNOT_SECONDARY` to the value specified.
  91. This setting is not included in the **gmt.conf** file.
  92. **FONT_ANNOT_PRIMARY**
  93. Font used for primary annotations, etc. [12p,Helvetica,black]. When
  94. **+** is prepended, scale fonts, offsets and tick-lengths relative
  95. to :term:`FONT_ANNOT_PRIMARY`.
  96. **FONT_ANNOT_SECONDARY**
  97. Font to use for time axis secondary annotations
  98. [14p,Helvetica,black].
  99. **FONT_HEADING**
  100. Font to use when plotting headings above subplots [32p,Helvetica,black].
  101. **FONT_LABEL**
  102. Font to use when plotting labels below axes [16p,Helvetica,black].
  103. **FONT_LOGO**
  104. Font to use for text plotted as part of the GMT time logo
  105. [8p,Helvetica,black].
  106. **FONT_TAG**
  107. Font to use for subplot panel tags such as a), ii)
  108. [20p,Helvetica,black].
  109. **FONT_TITLE**
  110. Font to use when plotting titles over graphs [24p,Helvetica,black].
  111. .. _FORMAT Parameters:
  112. FORMAT Parameters
  113. ~~~~~~~~~~~~~~~~~
  114. .. glossary::
  115. **FORMAT_CLOCK_IN**
  116. Formatting template that indicates how an input clock string is
  117. formatted. This template is then used to guide the reading of clock
  118. strings in data fields. To properly decode 12-hour clocks, append am
  119. or pm (or upper case) to match your data records. As examples, try
  120. hh:mm, hh:mm:ssAM, etc. [hh:mm:ss].
  121. **FORMAT_CLOCK_MAP**
  122. Formatting template that indicates how an output clock string is to
  123. be plotted. This template is then used to guide the formatting of
  124. clock strings in plot annotations. See :term:`FORMAT_CLOCK_OUT` for
  125. details. [hh:mm:ss].
  126. **FORMAT_CLOCK_OUT**
  127. Formatting template that indicates how an output clock string is to
  128. be formatted. This template is then used to guide the writing of
  129. clock strings in data fields. To use a floating point format for the
  130. smallest unit (e.g., seconds), append .xxx, where the number of x
  131. indicates the desired precision. If no floating point is indicated
  132. then the smallest specified unit will be rounded off to nearest
  133. integer. For 12-hour clocks, append am, AM, a.m., or A.M. (GMT
  134. will replace a\|A with p\|P for pm). If your template starts with a
  135. leading hyphen (-) then each integer item (y,m,d) will be printed
  136. without leading zeros (default uses fixed width formats). As
  137. examples, try hh:mm, hh.mm.ss, hh:mm:ss.xxxx, hha.m., etc.
  138. [hh:mm:ss]. If the format is simply - then no clock is output and
  139. the ISO T divider between date and clock is omitted.
  140. **FORMAT_DATE_IN**
  141. Formatting template that indicates how an input date string is
  142. formatted. This template is then used to guide the reading of date
  143. strings in data fields. You may specify either Gregorian calendar
  144. format or ISO week calendar format. Gregorian calendar: Use any
  145. combination of yyyy (or yy for 2-digit years; if so see
  146. :term:`TIME_Y2K_OFFSET_YEAR`), mm (or o for abbreviated month name in
  147. the current time language), and dd, with or without delimiters. For
  148. day-of-year data, use jjj instead of mm and/or dd. Examples can be
  149. ddmmyyyy, yy-mm-dd, dd-o-yyyy, yyyy/dd/mm, yyyy-jjj, etc. ISO
  150. Calendar: Expected template is yyyy[-]W[-]ww[-]d, where ww is ISO
  151. week and d is ISO week day. Either template must be consistent,
  152. e.g., you cannot specify months if you do not specify years.
  153. Examples are yyyyWwwd, yyyy-Www, etc. [yyyy-mm-dd].
  154. **FORMAT_DATE_MAP**
  155. Formatting template that indicates how an output date string is to
  156. be plotted. This template is then used to guide the plotting of date
  157. strings in data fields. See :term:`FORMAT_DATE_OUT` for details. In
  158. addition, you may use a single o instead of mm (to plot month name)
  159. and u instead of W[-]ww to plot "Week ##". Both of these text
  160. strings will be affected by the :term:`GMT_LANGUAGE`,
  161. :term:`FORMAT_TIME_PRIMARY_MAP` and :term:`FORMAT_TIME_SECONDARY_MAP`
  162. setting. [yyyy-mm-dd].
  163. **FORMAT_DATE_OUT**
  164. Formatting template that indicates how an output date string is to
  165. be formatted. This template is then used to guide the writing of
  166. date strings in data fields. You may specify either Gregorian
  167. calendar format or ISO week calendar format. Gregorian calendar: Use
  168. any combination of yyyy (or yy for 2-digit years; if so see
  169. :term:`TIME_Y2K_OFFSET_YEAR`), mm (or o for abbreviated month name in
  170. the current time language), and dd, with or without delimiters. For
  171. day-of-year data, use jjj instead of mm and/or dd. As examples, try
  172. yy/mm/dd, yyyy=jjj, dd-o-yyyy, dd-mm-yy, yy-mm, etc. ISO Calendar:
  173. Expected template is yyyy[-]W[-]ww[-]d, where ww is ISO week and d
  174. is ISO week day. Either template must be consistent, e.g., you
  175. cannot specify months if you do not specify years. As examples, try
  176. yyyyWww, yy-W-ww-d, etc. If your template starts with a leading
  177. hyphen (-) then each integer item (y,m,d) will be printed without
  178. leading zeros (default uses fixed width formats) [yyyy-mm-dd]. If
  179. the format is simply - then no date is output and the ISO T divider
  180. between date and clock is omitted.
  181. **FORMAT_GEO_MAP**
  182. Formatting template that indicates how an output geographical
  183. coordinate is to be plotted. This template is then used to guide the
  184. plotting of geographical coordinates in data fields. See
  185. :term:`FORMAT_GEO_OUT` for details. In addition, you can append A
  186. which plots the absolute value of the coordinate. The default is
  187. ddd:mm:ss. Not all items may be plotted as this depends on the
  188. annotation interval.
  189. **FORMAT_GEO_OUT**
  190. Formatting template that indicates how an output geographical
  191. coordinate is to be formatted. This template is then used to guide
  192. the writing of geographical coordinates in data fields. The template
  193. is in general of the form [±]D or [±]ddd[:mm[:ss]][.xxx][F].
  194. By default, longitudes will be reported in the range [-180,180]. The
  195. various terms have the following purpose:
  196. - **D**: Use :term:`FORMAT_FLOAT_OUT` for floating point degrees [default].
  197. - **+D**: Output longitude in the range [0,360]
  198. - **-D**: Output longitude in the range [-360,0]
  199. - **ddd**: Fixed format integer degrees
  200. - **:**: Delimiter used
  201. - **mm**: Fixed format integer arc minutes
  202. - **ss**: Fixed format integer arc seconds
  203. - **.xxx**: Floating fraction of previous integer field, fixed width.
  204. - **F**: Encode sign using WESN suffix
  205. - **G**: Same as **F** but with a leading space before suffix
  206. **FORMAT_FLOAT_MAP**
  207. Format (C language printf syntax) to be used when plotting double
  208. precision floating point numbers along plot frames and contours.
  209. For geographic coordinates, see :term:`FORMAT_GEO_MAP`. [%.12lg].
  210. **FORMAT_FLOAT_OUT**
  211. Format (C language printf syntax) to be used when printing double
  212. precision floating point numbers to output files. For geographic
  213. coordinates, see :term:`FORMAT_GEO_OUT`. [%.12lg]. To give some
  214. columns a separate format, supply one or more comma-separated
  215. *cols*:*format* specifications, where *cols* can be specific columns
  216. (e.g., 5 for 6th since 0 is the first) or a range of columns (e.g.,
  217. 3-7). The last specification without column information will
  218. override the format for all other columns. Alternatively, you can
  219. list N space-separated formats and these apply to the first N
  220. columns.
  221. **FORMAT_TIME_MAP**
  222. Sets both :term:`FORMAT_TIME_PRIMARY_MAP` and :term:`FORMAT_TIME_SECONDARY_MAP` to the value specified.
  223. This setting is not included in the **gmt.conf** file.
  224. **FORMAT_TIME_PRIMARY_MAP**
  225. Controls how primary month-, week-, and weekday-names are formatted.
  226. Choose among **full**, **abbreviated**, and **character**. If the
  227. leading **f**, **a**, or **c** are replaced with **F**, **A**, and
  228. **C** the entire annotation will be in upper case [full].
  229. **FORMAT_TIME_SECONDARY_MAP**
  230. Controls how secondary month-, week-, and weekday-names are
  231. formatted. Choose among **full**, **abbreviated**, and
  232. **character**. If the leading **f**, **a**, or **c** are replaced
  233. with **F**, **A**, and **C** the entire annotation will be in upper case [full].
  234. **FORMAT_TIME_STAMP**
  235. Defines the format of the time information in the UNIX time stamp.
  236. This format is parsed by the C function **strftime**, so that
  237. virtually any text can be used (even not containing any time
  238. information) [%Y %b %d %H:%M:%S].
  239. .. _GMT Miscellaneous Parameters:
  240. GMT Miscellaneous Parameters
  241. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  242. .. glossary::
  243. **GMT_AUTO_DOWNLOAD**
  244. Determines if GMT is allowed to automatically download datasets and
  245. files from the remote server selected via :term:`GMT_DATA_SERVER`. Default
  246. is *on* but you can turn this off by setting it to *off*.
  247. **GMT_COMPATIBILITY**
  248. Determines if the current GMT version should be able to parse command-line
  249. options for a prior major release. Specify the major release version number,
  250. e.g., 4-6. If 4 is set we will parse obsolete GMT 4 options and issue warnings; if 5
  251. is set then parsing GMT 4 only syntax will result in errors [4]; likewise
  252. for 6: obsolete syntax from early GMT 5 will be considered errors.
  253. **GMT_DATA_SERVER**
  254. Address of the data directory on the remote server [The SOEST server].
  255. **GMT_DATA_SERVER_LIMIT**
  256. Upper limit on the size of remote file to download [unlimited]. Give
  257. the maximum file size in bytes, or append k, m, or g for kilo-, mega-,
  258. or giga-bytes.
  259. **GMT_DATA_UPDATE_INTERVAL**
  260. Specifies how often we update the local catalog of data available on
  261. the remote server and pruning expired data sets [1d]. Allowable time
  262. units are **d** (days), **w** (week), **o** (month, here 30 days).
  263. **GMT_EXPORT_TYPE**
  264. This setting is only used by external interfaces and controls the
  265. data type used for table entries. Choose from double,
  266. single, [u]long, [u]int, [u]short, and [u]char [Default is double].
  267. **GMT_EXTRAPOLATE_VAL**
  268. Determines what to do if extrapolating beyond the data domain.
  269. Choose among 'NaN', 'extrap' or 'extrapval,val' (without quotes). In
  270. the first case return NaN for any element of x that is outside range
  271. [Default]. Second case lets the selected algorithm compute the
  272. extrapolation values. Third case sets the extrapolation values to
  273. the constant value passed in 'val' (this value must off course be
  274. numeric).
  275. **GMT_CUSTOM_LIBS**
  276. Comma-separated list of GMT-compliant shared libraries that extend
  277. the capability of GMT with additional custom modules [none]. Alternatively,
  278. provide a directory name, that MUST end with a slash (or back slash),
  279. to use all shared libraries in that directory. On Windows, if the dir
  280. name is made up only of a single slash ('/') search inside a subdirectory
  281. called 'gmt_plugins' of the directory that contains the 'gmt' executable.
  282. See the API documentation for how to build your own shared modules.
  283. **GMT_FFT**
  284. Determines which Fast Fourier Transform (FFT) should be used among
  285. those that have been configured during installation. Choose from
  286. **auto** (pick the most suitable for the task among available
  287. algorithms), **fftw**\ [,\ *planner_flag*] (The Fastest Fourier
  288. Transform in the West), **accelerate** (Use the Accelerate Framework
  289. under OS X; Note, that the number of samples to be processed must be
  290. a base 2 exponent), **kiss**, (Kiss FFT), **brenner** Brenner Legacy
  291. FFT [auto].
  292. FFTW can "learn" how to optimally compute Fourier transforms on the
  293. current hardware and OS by computing several FFTs and measuring
  294. their execution time. This so gained "Wisdom" will be stored in and
  295. reloaded from the file fftw_wisdom_<hostname> in **$GMT_USERDIR** or, if
  296. **$GMT_USERDIR** is not writable, in the current directory. To use this
  297. feature append *planner_flag*, which can be one of *measure*,
  298. *patient*, and *exhaustive*; see FFTW reference for details. The
  299. default FFTW planner flag is *estimate*, i.e., pick a (probably
  300. sub-optimal) plan quickly. **Note**: If you need a single transform of a
  301. given size only, the one-time cost of the smart planner becomes
  302. significant. In that case, stick to the default planner, *estimate*,
  303. based on heuristics.
  304. **GMT_GRAPHICS_FORMAT**
  305. Default graphics format in modern mode [pdf].
  306. **GMT_HISTORY**
  307. Passes the history of past common command options via the
  308. gmt.history file. The different values for this setting are:
  309. **true**, **readonly**, **false**, to either read and write to the
  310. gmt.history file, only read, or not use the file at all [true].
  311. **GMT_INTERPOLANT**
  312. Determines if linear (linear), Akima's spline (akima), natural cubic
  313. spline (cubic) or no interpolation (none) should be used for 1-D
  314. interpolations in various programs [akima].
  315. **GMT_LANGUAGE**
  316. Language to use when plotting calendar and map items such as months and
  317. days, map annotations and cardinal points. Select from:
  318. .. hlist::
  319. :columns: 3
  320. - *CN1*: Simplified Chinese
  321. - *CN2*: Traditional Chinese
  322. - *DE*: German
  323. - *DK*: Danish
  324. - *EH*: Basque
  325. - *ES*: Spanish
  326. - *FI*: Finnish
  327. - *FR*: French
  328. - *GR*: Greek
  329. - *HI*: Hawaiian
  330. - *HU*: Hungarian
  331. - *IE*: Irish
  332. - *IL*: Hebrew
  333. - *IS*: Icelandic
  334. - *IT*: Italian
  335. - *JP*: Japanese
  336. - *KR*: Korean
  337. - *NL*: Dutch
  338. - *NO*: Norwegian
  339. - *PL*: Polish
  340. - *PT*: Portuguese
  341. - *RU*: Russian
  342. - *SE*: Swedish
  343. - *SG*: Scottish Gaelic
  344. - *TO*: Tongan
  345. - *TR*: Turkish
  346. - *UK*: British English
  347. - *US*: US English
  348. If your language is not supported, please examine the
  349. **$GMT_SHAREDIR**/localization/gmt_us.locale file and make a similar file. Please
  350. submit it to the GMT Developers for official inclusion. Custom
  351. language files can be placed in directories **$GMT_SHAREDIR**/localization
  352. or ~/.gmt. **Note**: Some of these languages may require you to also
  353. change the :term:`PS_CHAR_ENCODING` setting.
  354. **GMT_MAX_CORES**
  355. Sets the upper limit on the number of cores any multi-threaded module might
  356. use (whether **-x** is selected or not) [0, i.e., as many as are available].
  357. **GMT_TRIANGULATE**
  358. Determines if we use the **Watson** [Default] or **Shewchuk**
  359. algorithm (if configured during installation) for triangulation.
  360. Note that Shewchuk is required for operations involving Voronoi
  361. constructions.
  362. **GMT_VERBOSE**
  363. (**-V**) Determines the level of verbosity used by GMT
  364. programs. Choose among 7 levels; each level adds to the verbosity of
  365. the lower levels: **q**\ uiet, **e**\ rrors, **w**\ arnings,
  366. **t**\ imings (for slow algorithms only), **i**\ nformation,
  367. **c**\ ompatibility warnings, and **d**\ ebugging messages [**w**].
  368. .. _I/O Parameters:
  369. I/O Parameters
  370. ~~~~~~~~~~~~~~
  371. .. glossary::
  372. **IO_COL_SEPARATOR**
  373. This setting determines what character will separate ASCII output
  374. data columns written by GMT. Choose from tab, space, comma, and
  375. none [tab].
  376. **IO_FIRST_HEADER**
  377. This setting determines if the first segment header is written when
  378. there is only a single segment (for multiple segment it must be written).
  379. By default, such single-segment headers are only written if the header
  380. has contents. Choose from always, never, or maybe [maybe].
  381. **IO_GRIDFILE_FORMAT**
  382. Default file format for grids, with optional scale, offset and
  383. invalid value, written as *ff*\ [**+s**\ *scale*][**+o**\ *offset*][**+n**\ *invalid*]. The
  384. 2-letter format indicator can be one of [**abcegnrs**][**bsifd**]. See
  385. :doc:`grdconvert` and Section :ref:`grid-file-format` of the
  386. GMT Technical Reference and Cookbook for more information.
  387. You may the scale as *a* for auto-adjusting the scale and/or offset of
  388. packed integer grids (=\ *ID*\ **+s**\ *a* is a shorthand for
  389. =\ *ID*\ **+s**\ *a*\ **+o**\ *a*). When *invalid* is omitted
  390. the appropriate value for the given format is used (NaN or largest negative). [nf].
  391. **IO_GRIDFILE_SHORTHAND**
  392. If true, all grid file names are examined to see if they use the
  393. file extension shorthand discussed in Section :ref:`grid-file-format` of the GMT
  394. Technical Reference and Cookbook. If false, no filename expansion is done [false].
  395. **IO_HEADER**
  396. (**-h**) Specifies whether input/output ASCII files have header record(s) or not [false].
  397. **IO_HEADER_MARKER**
  398. Give a string from which any character will indicate a header record in
  399. an incoming ASCII data table if found in the first position [#%!;"']. If another marker
  400. should be used for output than the first character in the list, then append a single
  401. character for the output header record marker. The two sets must be separated by a comma.
  402. **Note**: A maximum of 7 input markers can be specified.
  403. **IO_LONLAT_TOGGLE**
  404. (**-:**) Set if the first two columns of input and output files
  405. contain (latitude,longitude) or (y,x) rather than the expected
  406. (longitude,latitude) or (x,y). false means we have (x,y) both on
  407. input and output. true means both input and output should be (y,x).
  408. IN means only input has (y,x), while OUT means only output should be (y,x). [false].
  409. **IO_N_HEADER_RECS**
  410. Specifies how many header records to expect if **-h** is used [0].
  411. **Note**: This will skip the specified number of records regardless of
  412. what they are. Since any records starting with # is automatically
  413. considered a header you will only specify a non-zero number in order
  414. to skip headers that do not conform to that convention.
  415. **IO_NAN_RECORDS**
  416. Determines what happens when input records containing NaNs for *x*
  417. or *y* (and in some cases *z*) are read. This may happen, for instance,
  418. when there is text or other junk present instead of data coordinates, and
  419. the conversion to a data value fails and yields a NaN. Choose between **skip**,
  420. which will report how many bad records were skipped, and **pass** [Default],
  421. which will quietly pass these records on to the calling
  422. programs. For most programs this will result in output records with
  423. NaNs as well, but some will interpret these NaN records to indicate
  424. gaps in a series; programs may then use that information to detect
  425. segmentation (if applicable).
  426. **IO_NC4_CHUNK_SIZE**
  427. Sets the default chunk size for the vertical (**lat**, **y**) and
  428. horizontal (**lon**, **x**) dimensions of
  429. the **z** variable. Very large chunk sizes and sizes smaller than
  430. 128 should be avoided because they can lead to unexpectedly bad
  431. performance. Note that a chunk of a single precision floating point
  432. variable of size 2896x2896 completely fills the chunk cache of
  433. 32 MiB. Specify the chunk size for each dimension separated by a
  434. comma, or **a**\ uto for optimally chosen chunk sizes in the range
  435. [128,256). Setting :term:`IO_NC4_CHUNK_SIZE` will produce netCDF version 4
  436. files, which can only be read with the netCDF 4 library, unless all
  437. dimensions are less than 128 or **c**\ lassic is specified for
  438. classic netCDF. [auto]
  439. **IO_NC4_DEFLATION_LEVEL**
  440. Sets the compression level for netCDF4 files upon output. Values
  441. allowed are integers from 0 (no compression) to 9 (maximum
  442. compression). Enabling a low compression level can dramatically
  443. improve performance and reduce the size of certain data. While
  444. higher compression levels further reduce the data size, they do so
  445. at the cost of extra processing time. This parameter does not
  446. apply to classic netCDF files. [3]
  447. **IO_SEGMENT_BINARY**
  448. Determines how binary data records with all values set to NaN are
  449. interpreted. Such records are considered to be encoded segment
  450. headers in binary files provided the number of columns equals or
  451. exceeds the current setting of IO_SEGMENT_BINARY [2]. Specify 0
  452. or "off" to deactivate the segment header determination.
  453. **IO_SEGMENT_MARKER**
  454. This holds the character we expect to indicate a segment header in
  455. an incoming ASCII data or text table [>]. If this marker should be
  456. different for output then append another character for the output
  457. segment marker. The two characters must be separated by a comma. Two
  458. marker characters have special meaning: B means "blank line" and
  459. will treat blank lines as initiating a new segment, whereas N means
  460. "NaN record" and will treat records with all NaNs as initiating a
  461. new segment. If you choose B or N for the output marker then the
  462. normal GMT segment header is replaced by a blank or NaN record,
  463. respectively, and no segment header information is written. To use B
  464. or N as regular segment markers you must escape them with a leading
  465. backslash.
  466. .. _MAP Parameters:
  467. MAP Parameters
  468. ~~~~~~~~~~~~~~
  469. .. glossary::
  470. **MAP_ANNOT_MIN_ANGLE**
  471. If the angle between the map boundary and the annotation baseline is
  472. less than this minimum value (in degrees), the annotation is not
  473. plotted (this may occur for certain oblique projections.) Give a
  474. value in the range [0,90]. [20]
  475. **MAP_ANNOT_MIN_SPACING**
  476. If an annotation would be plotted less than this minimum distance
  477. from its closest neighbor, the annotation is not plotted (this may
  478. occur for certain oblique projections.) [0p]
  479. **MAP_ANNOT_OBLIQUE**
  480. This argument is a comma-separated list of up to seven keywords:
  481. **separate** means longitudes will be annotated on the lower and upper
  482. boundaries only, and latitudes will be annotated on the left and right
  483. boundaries only;
  484. **anywhere** means annotations will occur wherever an imaginary gridline
  485. crosses the map boundaries; **lon_horizontal** means longitude annotations
  486. will be plotted horizontally; **lat_horizontal** means latitude annotations
  487. will be plotted horizontally; **tick_extend** means tick-marks are extended
  488. so the distance from the tip of the oblique tick to the map frame equals
  489. the specified tick length; **tick_normal** means tick-marks will be drawn
  490. normal to the border regardless of gridline angle; **lat_parallel** means
  491. latitude annotations will be plotted parallel to the border. [anywhere].
  492. **MAP_ANNOT_OFFSET**
  493. Sets both :term:`MAP_ANNOT_OFFSET_PRIMARY` and :term:`MAP_ANNOT_OFFSET_SECONDARY` to the value specified.
  494. This setting is not included in the **gmt.conf** file.
  495. **MAP_ANNOT_OFFSET_PRIMARY**
  496. Distance from end of tick-mark to start of annotation [5p].
  497. **MAP_ANNOT_OFFSET_SECONDARY**
  498. Distance from base of primary annotation to the top of the secondary
  499. annotation [5p] (Only applies to time axes with both primary and
  500. secondary annotations).
  501. **MAP_ANNOT_ORTHO**
  502. Determines which axes will get their annotations (for Cartesian
  503. projections) plotted orthogonally to the axes. Combine any **w**,
  504. **e**, **s**, **n**, **z** (uppercase allowed as well). [we] (if nothing specified).
  505. Note that this setting can be overridden via the **+a** modifier in **-B**.
  506. **MAP_DEFAULT_PEN**
  507. Sets the default of all pens related to **-W** options. Prepend
  508. **+** to overrule the color of the parameters
  509. :term:`MAP_GRID_PEN_PRIMARY`, :term:`MAP_GRID_PEN_SECONDARY`,
  510. :term:`MAP_FRAME_PEN`, :term:`MAP_TICK_PEN_PRIMARY`, and
  511. :term:`MAP_TICK_PEN_SECONDARY` by the color of :term:`MAP_DEFAULT_PEN`
  512. [default,black].
  513. **MAP_DEGREE_SYMBOL**
  514. Determines what symbol is used to plot the degree symbol on
  515. geographic map annotations. Choose between ring, degree, colon, or
  516. none [ring].
  517. **MAP_FRAME_AXES**
  518. Sets which axes to draw and annotate. Combine any uppercase **W**,
  519. **E**, **S**, **N**, **Z** to draw and annotate west, east, south,
  520. north and/or vertical (perspective view only) axis. Use lower case
  521. to draw the axis only, but not annotate. Add an optional **+** to
  522. draw a cube of axes in perspective view. [WESN].
  523. **MAP_FRAME_PEN**
  524. Pen attributes used to draw plain map frame [thicker,black].
  525. **MAP_FRAME_TYPE**
  526. Choose between **inside**, **plain** and **fancy** (thick boundary,
  527. alternating black/white frame; append **+** for rounded corners)
  528. [fancy]. For some map projections (e.g., Oblique Mercator), plain is
  529. the only option even if fancy is set as default. In general, fancy
  530. only applies to situations where the projected x and y directions
  531. parallel the longitude and latitude directions (e.g., rectangular
  532. projections, polar projections). For situations where all boundary
  533. ticks and annotations must be inside the maps (e.g., for preparing
  534. geotiffs), chose **inside**. Finally, for Cartesian plots you can
  535. also choose **graph**\ , which adds a vector to the end of each axis.
  536. This works best when you reduce the number of axes plotted to one
  537. per dimension. By default, the vector tip extends the length of each
  538. axis by 7.5%. Alternatively, append ,\ *length*, where the optional *unit*
  539. may be % (then *length* is the alternate extension in percent) or one
  540. of **c**, **i**, or **p** (then *length* is the absolute extension
  541. of the axis to the start of the vector base instead). The vector stem
  542. is set to match :term:`MAP_FRAME_WIDTH`, while the vector
  543. head length and width are 10 and 5 times this width, respectively. You
  544. may control its shape via :term:`MAP_VECTOR_SHAPE`.
  545. **MAP_FRAME_WIDTH**
  546. Width (> 0) of map borders for fancy map frame [5p]. **Note**: For fancy
  547. frames, :term:`MAP_FRAME_PEN` is automatically set to 0.1 times the
  548. :term:`MAP_FRAME_WIDTH` setting.
  549. **MAP_GRID_CROSS_SIZE**
  550. Sets both :term:`MAP_GRID_CROSS_SIZE_PRIMARY` and :term:`MAP_GRID_CROSS_SIZE_SECONDARY` to the value specified.
  551. This setting is not included in the **gmt.conf** file.
  552. **MAP_GRID_CROSS_SIZE_PRIMARY**
  553. Size of grid cross at lon-lat intersections. 0 means draw
  554. continuous gridlines instead. A nonzero size will draw a symmetric grid
  555. cross. Signed sizes have special meaning and imply grid line ticks that
  556. embellish an already drawn set of gridlines: A negative size will only
  557. draw ticks away from Equator and Greenwich, while a positive size will
  558. draw symmetric ticks [0p].
  559. **MAP_GRID_CROSS_SIZE_SECONDARY**
  560. Size of grid cross at secondary lon-lat intersections. 0 means draw
  561. continuous gridlines instead. A nonzero size will draw a symmetric grid
  562. cross. Signed sizes have special meaning and imply grid line ticks that
  563. embellish an already drawn set of gridlines: A negative size will only
  564. draw ticks away from Equator and Greenwich, while a positive size will
  565. draw symmetric ticks [0p].
  566. **MAP_GRID_PEN**
  567. Sets both :term:`MAP_GRID_PEN_PRIMARY` and :term:`MAP_GRID_PEN_SECONDARY` to
  568. the value specified. This setting is not include in the **gmt.conf** file.
  569. **MAP_GRID_PEN_PRIMARY**
  570. Pen attributes used to draw primary grid lines in dpi units or
  571. points (append p) [default,black].
  572. **MAP_GRID_PEN_SECONDARY**
  573. Pen attributes used to draw secondary grid lines in dpi units or
  574. points (append p) [thinner,black].
  575. **MAP_HEADING_OFFSET**
  576. Distance from top of subplot panel titles to the base of the heading [18p].
  577. **MAP_LABEL_OFFSET**
  578. Distance from base of axis annotations to the top of the axis label [8p].
  579. **MAP_LINE_STEP**
  580. Determines the maximum length (> 0) of individual straight
  581. line-segments when drawing arcuate lines [0.75p]
  582. **MAP_LOGO**
  583. (**-U**) Specifies if a GMT logo with system timestamp should be
  584. plotted at the lower left corner of the plot [false].
  585. **MAP_LOGO_POS**
  586. (**-U**) Sets the justification and the position of the
  587. logo/timestamp box relative to the current plot's lower left corner
  588. (i.e., map origin) [BL/-54p/-54p].
  589. **MAP_ORIGIN_X**
  590. (**-X**) Sets the x-coordinate of the origin on the paper for a
  591. new plot [72p]. For an overlay, the default offset is 0.
  592. **MAP_ORIGIN_Y**
  593. (**-Y**) Sets the y-coordinate of the origin on the paper for a
  594. new plot [72p]. For an overlay, the default offset is 0.
  595. **MAP_POLAR_CAP**
  596. Controls the appearance of gridlines near the poles for all
  597. azimuthal projections and a few others in which the geographic poles
  598. are plotted as points (Lambert Conic, Oblique Mercator, Hammer, Mollweide,
  599. Sinusoidal and van der Grinten). Specify either none (in which case there
  600. is no special handling) or *pc_lat*/*pc_dlon*. In that case, normal
  601. gridlines are only drawn between the latitudes
  602. -*pc_lat*/+\ *pc_lat*, and above those latitudes the gridlines are
  603. spaced at the (presumably coarser) *pc_dlon* interval; the two
  604. domains are separated by a small circle drawn at the *pc_lat*
  605. latitude [85/90]. Note for r-theta (polar) projection where r = 0 is
  606. at the center of the plot the meaning of the cap is reversed, i.e.,
  607. the default 85/90 will draw a r = 5 radius circle at the center of
  608. the map with less frequent radial lines there.
  609. **MAP_SCALE_HEIGHT**
  610. Sets the height (> 0) on the map of the map scale bars drawn by
  611. various programs [5p].
  612. **MAP_TICK_LENGTH**
  613. Sets both :term:`MAP_TICK_LENGTH_PRIMARY` and :term:`MAP_TICK_LENGTH_SECONDARY` to the value specified.
  614. This setting is not included in the **gmt.conf** file.
  615. **MAP_TICK_LENGTH_PRIMARY**
  616. The length of a primary major/minor tick-marks [5p/2.5p]. If only
  617. the first value is set, the second is assumed to be 50% of the first.
  618. **MAP_TICK_LENGTH_SECONDARY**
  619. The length of a secondary major/minor tick-marks [15p/3.75p]. If
  620. only the first value is set, the second is assumed to be 25% of the first.
  621. **MAP_TICK_PEN**
  622. Sets both :term:`MAP_TICK_PEN_PRIMARY` and :term:`MAP_TICK_PEN_SECONDARY` to the value specified.
  623. This setting is not included in the **gmt.conf** file.
  624. **MAP_TICK_PEN_PRIMARY**
  625. Pen attributes to be used for primary tick-marks in dpi units or
  626. points (append p) [thinner,black].
  627. **MAP_TICK_PEN_SECONDARY**
  628. Pen attributes to be used for secondary tick-marks in dpi units or
  629. points (append p) [thinner,black].
  630. **MAP_TITLE_OFFSET**
  631. Distance from top of axis annotations (or axis label, if present) to
  632. base of plot title [14p].
  633. **MAP_VECTOR_SHAPE**
  634. Determines the shape of the head of a vector. Normally (i.e., for
  635. vector_shape = 0), the head will be triangular, but can be changed
  636. to an arrow (1) or an open V (2).
  637. Intermediate settings give something in between. Negative values (up
  638. to -2) are allowed as well [0].
  639. .. _Projection Parameters:
  640. Projection Parameters
  641. ~~~~~~~~~~~~~~~~~~~~~
  642. .. glossary::
  643. **PROJ_AUX_LATITUDE**
  644. Only applies when geodesics are approximated by great circle
  645. distances on an equivalent sphere. Select from authalic, geocentric,
  646. conformal, meridional, parametric, or none [authalic]. When not none
  647. we convert any latitude used in the great circle calculation to the
  648. chosen auxiliary latitude before doing the distance calculation. See
  649. also :term:`PROJ_MEAN_RADIUS`.
  650. **PROJ_ELLIPSOID**
  651. The (case sensitive) name of the ellipsoid used for the map projections [WGS-84]. Choose among:
  652. - *Airy*: Applies to Great Britain (1830)
  653. - *Airy-Ireland*: Applies to Ireland in 1965 (1830)
  654. - *Andrae*: Applies to Denmark and Iceland (1876)
  655. - *APL4.9*: Appl. Physics (1965)
  656. - *ATS77*: Average Terrestrial System, Canada Maritime provinces (1977)
  657. - *Australian*: Applies to Australia (1965)
  658. - *Bessel*: Applies to Central Europe, Chile, Indonesia (1841)
  659. - *Bessel-Namibia*: Same as Bessel-Schwazeck (1841)
  660. - *Bessel-NGO1948*: Modified Bessel for NGO 1948 (1841)
  661. - *Bessel-Schwazeck*: Applies to Namibia (1841)
  662. - *Clarke-1858*: Clarke's early ellipsoid (1858)
  663. - *Clarke-1866*: Applies to North America, the Philippines (1866)
  664. - *Clarke-1866-Michigan*: Modified Clarke-1866 for Michigan (1866)
  665. - *Clarke-1880*: Applies to most of Africa, France (1880)
  666. - *Clarke-1880-Arc1950*: Modified Clarke-1880 for Arc 1950 (1880)
  667. - *Clarke-1880-IGN*: Modified Clarke-1880 for IGN (1880)
  668. - *Clarke-1880-Jamaica*: Modified Clarke-1880 for Jamaica (1880)
  669. - *Clarke-1880-Merchich*: Modified Clarke-1880 for Merchich (1880)
  670. - *Clarke-1880-Palestine*: Modified Clarke-1880 for Palestine (1880)
  671. - *CPM*: Comm. des Poids et Mesures, France (1799)
  672. - *Delambre*: Applies to Belgium (1810)
  673. - *Engelis*: Goddard Earth Models (1985)
  674. - *Everest-1830*: India, Burma, Pakistan, Afghanistan, Thailand (1830)
  675. - *Everest-1830-Kalianpur*: Modified Everest for Kalianpur (1956) (1830)
  676. - *Everest-1830-Kertau*: Modified Everest for Kertau, Malaysia & Singapore (1830)
  677. - *Everest-1830-Pakistan*: Modified Everest for Pakistan (1830)
  678. - *Everest-1830-Timbalai*: Modified Everest for Timbalai, Sabah Sarawak (1830)
  679. - *Fischer-1960*: Used by NASA for Mercury program (1960)
  680. - *Fischer-1960-SouthAsia*: Same as Modified-Fischer-1960 (1960)
  681. - *Fischer-1968*: Used by NASA for Mercury program (1968)
  682. - *FlatEarth*: As Sphere, but implies fast "Flat Earth" distance calculations (1984)
  683. - *GRS-67*: International Geodetic Reference System (1967)
  684. - *GRS-80*: International Geodetic Reference System (1980)
  685. - *Hayford-1909*: Same as the International 1924 (1909)
  686. - *Helmert-1906*: Applies to Egypt (1906)
  687. - *Hough*: Applies to the Marshall Islands (1960)
  688. - *Hughes-1980*: Hughes Aircraft Company for DMSP SSM/I grid products (1980)
  689. - *IAG-75*: International Association of Geodesy (1975)
  690. - *Indonesian*: Applies to Indonesia (1974)
  691. - *International-1924*: Worldwide use (1924)
  692. - *International-1967*: Worldwide use (1967)
  693. - *Kaula*: From satellite tracking (1961)
  694. - *Krassovsky*: Used in the (now former) Soviet Union (1940)
  695. - *Lerch*: For geoid modeling (1979)
  696. - *Maupertius*: Really old ellipsoid used in France (1738)
  697. - *Mercury-1960*: Same as Fischer-1960 (1960)
  698. - *MERIT-83*: United States Naval Observatory (1983)
  699. - *Modified-Airy*: Same as Airy-Ireland (1830)
  700. - *Modified-Fischer-1960*: Applies to Singapore (1960)
  701. - *Modified-Mercury-1968*: Same as Fischer-1968 (1968)
  702. - *NWL-10D*: Naval Weapons Lab (Same as WGS-72) (1972)
  703. - *NWL-9D*: Naval Weapons Lab (Same as WGS-66) (1966)
  704. - *OSU86F*: Ohio State University (1986)
  705. - *OSU91A*: Ohio State University (1991)
  706. - *Plessis*: Old ellipsoid used in France (1817)
  707. - *SGS-85*: Soviet Geodetic System (1985)
  708. - *South-American*: Applies to South America (1969)
  709. - *Sphere*: The mean radius in WGS-84 (for spherical/plate tectonics applications) (1984)
  710. - *Struve*: Friedrich Georg Wilhelm Struve (1860)
  711. - *TOPEX*: Used commonly for altimetry (1990)
  712. - *Walbeck*: First least squares solution by Finnish astronomer (1819)
  713. - *War-Office*: Developed by G. T. McCaw (1926)
  714. - *WGS-60*: World Geodetic System (1960)
  715. - *WGS-66*: World Geodetic System (1966)
  716. - *WGS-72*: World Geodetic System (1972)
  717. - *WGS-84*: World Geodetic System [Default] (1984)
  718. - *Web-Mercator*: Spherical Mercator with WGS-84 radius (1984)
  719. - *Moon*: Moon (IAU2000) (2000)
  720. - *Mercury*: Mercury (IAU2000) (2000)
  721. - *Venus*: Venus (IAU2000) (2000)
  722. - *Mars*: Mars (IAU2000) (2000)
  723. - *Jupiter*: Jupiter (IAU2000) (2000)
  724. - *Saturn*: Saturn (IAU2000) (2000)
  725. - *Uranus*: Uranus (IAU2000) (2000)
  726. - *Neptune*: Neptune (IAU2000) (2000)
  727. - *Pluto*: Pluto (IAU2000) (2000)
  728. Note that for some global projections, GMT may use a spherical
  729. approximation of the ellipsoid chosen, setting the flattening to
  730. zero, and using a mean radius. A warning will be given when this
  731. happens. If a different ellipsoid name than those mentioned here is
  732. given, GMT will attempt to parse the name to extract the
  733. semi-major axis (*a* in m) and the flattening. Formats allowed are:
  734. *a* implies a zero flattening
  735. *a*,\ *inv_f* where *inv_f* is the inverse flattening
  736. *a*,\ **b=**\ *b* where *b* is the semi-minor axis (in m)
  737. *a*,\ **f=**\ *f* where *f* is the flattening
  738. This way a custom ellipsoid (e.g., those used for other planets) may
  739. be used. Further note that coordinate transformations in
  740. **mapproject** can also specify specific datums; see the
  741. :doc:`mapproject` man page for further details and how to view
  742. ellipsoid and datum parameters.
  743. **PROJ_GEODESIC**
  744. Selects the algorithm to use for geodesic calculations. Choose between
  745. **Vincenty** [Default], **Rudoe**, or **Andoyer**. The **Andoyer**
  746. algorithm is only approximate (to within a few tens of meters) but is
  747. up to 5 times faster. The **Rudoe** is given for legacy purposes.
  748. The default **Vincenty** is accurate to about 0.5 mm.
  749. **PROJ_LENGTH_UNIT**
  750. Sets the unit length. Choose between **c**\ m, **i**\ nch, or
  751. **p**\ oint [c (or i)]. Note that, in GMT, one point is defined
  752. as 1/72 inch (the PostScript definition), while it is often
  753. defined as 1/72.27 inch in the typesetting industry. There is no
  754. universal definition.
  755. **PROJ_MEAN_RADIUS**
  756. Applies when geodesics are approximated by great circle distances on
  757. an equivalent sphere or when surface areas are computed. Select from
  758. mean (R_1), authalic (R_2), volumetric (R_3), meridional, or
  759. quadratic [authalic].
  760. **PROJ_SCALE_FACTOR**
  761. Changes the default map scale factor used for the Polar
  762. Stereographic [0.9996], UTM [0.9996], and Transverse Mercator [1]
  763. projections in order to minimize areal distortion. Provide a new
  764. scale-factor or leave as default.
  765. .. _PostScript Parameters:
  766. PostScript Parameters
  767. ~~~~~~~~~~~~~~~~~~~~~
  768. .. glossary::
  769. **PS_CHAR_ENCODING**
  770. (static) Names the eight bit character set being used for text in
  771. files and in command line parameters. This allows GMT to ensure
  772. that the PostScript output generates the correct characters on the
  773. plot. Choose from Standard, Standard+, ISOLatin1, ISOLatin1+, and
  774. ISO-8859-x (where x is in the ranges [1,10] or [13,15]). See
  775. Appendix F for details [ISOLatin1+ (or Standard+)]. **Note**: Normally
  776. the character set is written as part of the PostScript header. If
  777. you need to switch to another character set for a later overlay then
  778. you must use **--PS_CHAR_ENCODING**\ =\ *encoding* on the command line and
  779. not via gmt set.
  780. **PS_COLOR_MODEL**
  781. Determines whether PostScript output should use RGB, HSV, CMYK, or
  782. GRAY when specifying color [rgb]. Note if HSV is selected it does
  783. not apply to images which in that case uses RGB. When selecting
  784. GRAY, all colors will be converted to gray scale using YIQ
  785. (television) conversion.
  786. **PS_COMMENTS**
  787. (static) If true we will issue comments in the PostScript file
  788. that explain the logic of operations. These are useful if you need
  789. to edit the file and make changes; otherwise you can set it to false
  790. which yields a somewhat slimmer PostScript file [false].
  791. **PS_CONVERT**
  792. Comma-separated list of optional module arguments that we should
  793. supply when :doc:`psconvert` is called implicitly under modern mode [**A**].
  794. Ignored when psconvert is called on the command line explicitly.
  795. The option arguments must be listed without their leading option hyphen.
  796. **PS_IMAGE_COMPRESS**
  797. Determines if PostScript images are compressed using the Run-Length
  798. Encoding scheme (rle), Lempel-Ziv-Welch compression (lzw), DEFLATE
  799. compression (deflate[,level]), or not at all (none) [deflate,5]. When
  800. specifying deflate, the compression level (1–9) may optionally be
  801. appended.
  802. **PS_LINE_CAP**
  803. Determines how the ends of a line segment will be drawn. Choose
  804. among a *butt* cap (default) where there is no projection beyond the
  805. end of the path, a *round* cap where a semicircular arc with
  806. diameter equal to the line-width is drawn around the end points, and
  807. *square* cap where a half square of size equal to the line-width
  808. extends beyond the end of the path [butt].
  809. **PS_LINE_JOIN**
  810. Determines what happens at kinks in line segments. Choose among a
  811. *miter* join where the outer edges of the strokes for the two
  812. segments are extended until they meet at an angle (as in a picture
  813. frame; if the angle is too acute, a bevel join is used instead, with
  814. threshold set by :term:`PS_MITER_LIMIT`), *round* join where a
  815. circular arc is used to fill in the cracks at the kinks, and *bevel*
  816. join which is a miter join that is cut off so kinks are triangular in shape [miter].
  817. **PS_MEDIA**
  818. *Classic mode:* Sets the physical size of the current plotting paper [a4 or letter].
  819. *Modern mode:* If user selects PostScript output then the above applies as well.
  820. For other graphics formats (PDF and rasters), the media size is determined automatically
  821. by cropping to fit the plot exactly (but see :term:`PS_CONVERT`). However,
  822. if a specific media size is desired then the :term:`PS_MEDIA` may be specified as well.
  823. The following formats (and their widths and heights in points) are recognized:
  824. ======== ======== ======== ========== ======== ========
  825. Media width height Media width height
  826. ======== ======== ======== ========== ======== ========
  827. A0 2380 3368 archA 648 864
  828. A1 1684 2380 archB 864 1296
  829. A2 1190 1684 archC 1296 1728
  830. A3 842 1190 archD 1728 2592
  831. A4 595 842 archE 2592 3456
  832. A5 421 595 flsa 612 936
  833. A6 297 421 halfletter 396 612
  834. A7 210 297 statement 396 612
  835. A8 148 210 note 540 720
  836. A9 105 148 letter 612 792
  837. A10 74 105 legal 612 1008
  838. B0 2836 4008 11x17 792 1224
  839. B1 2004 2836 tabloid 792 1224
  840. B2 1418 2004 ledger 1224 792
  841. B3 1002 1418
  842. B4 709 1002
  843. B5 501 709
  844. ======== ======== ======== ========== ======== ========
  845. For a completely custom format (e.g., for large format plotters) you
  846. may also specify WxH, where W and H are in points unless you append
  847. a unit to each dimension (**c**, **i**, **m** or **p** [Default]).
  848. Additional user-specific formats may be saved as separate line in a
  849. gmt_custom_media.conf file stored in ~/.gmt. Each record would have a
  850. format name followed by width and height of your media in points. For
  851. infinitely long paper rolls (e.g., plotters you can set height = 0).
  852. **PS_MITER_LIMIT**
  853. Sets the threshold angle in degrees (integer in range [0,180]) used
  854. for mitered joins only. When the angle between joining line segments
  855. is smaller than the threshold the corner will be bevelled instead of
  856. mitered. The default threshold is 35 degrees. Setting the threshold
  857. angle to 0 implies the PostScript default of about 11 degrees.
  858. Setting the threshold angle to 180 causes all joins to be beveled.
  859. **PS_PAGE_COLOR**
  860. Sets the color of the imaging background, i.e., the paper [white].
  861. **PS_PAGE_ORIENTATION**
  862. (**-P**) Sets the orientation of the page. Choose portrait or
  863. landscape [landscape]. Only available in GMT classic mode.
  864. **PS_SCALE_X**
  865. Global x-scale (> 0) to apply to plot-coordinates before plotting.
  866. Normally used to shrink the entire output down to fit a specific
  867. height/width [1.0].
  868. **PS_SCALE_Y**
  869. Global y-scale (> 0) to apply to plot-coordinates before plotting.
  870. Normally used to shrink the entire output down to fit a specific
  871. height/width [1.0].
  872. **PS_TRANSPARENCY**
  873. Sets the transparency mode to use when preparing PS for rendering to
  874. PDF. Choose from Color, ColorBurn, ColorDodge, Darken, Difference,
  875. Exclusion, HardLight, Hue, Lighten, Luminosity, Multiply, Normal,
  876. Overlay, Saturation, SoftLight, and Screen [Normal].
  877. .. _Calendar/Time Parameters:
  878. Calendar/Time Parameters
  879. ~~~~~~~~~~~~~~~~~~~~~~~~
  880. .. glossary::
  881. **TIME_EPOCH**
  882. Specifies the value of the calendar and clock at the origin (zero
  883. point) of relative time units (see :term:`TIME_UNIT`). It is a string
  884. of the form yyyy-mm-ddT[hh:mm:ss] (Gregorian) or
  885. yyyy-Www-ddT[hh:mm:ss] (ISO) Default is 1970-01-01T00:00:00, the
  886. origin of the UNIX time epoch.
  887. **TIME_INTERVAL_FRACTION**
  888. Determines if partial intervals at the start and end of an axis
  889. should be annotated. If the range of the partial interval exceeds
  890. the specified fraction of the normal interval stride we will place
  891. the annotation centered on the partial interval [0.5].
  892. **TIME_IS_INTERVAL**
  893. Used when input calendar data should be truncated and adjusted to
  894. the middle of the relevant interval. In the following discussion,
  895. the unit *unit* can be one of these time units: (**y** year, **o**
  896. month, **u** ISO week, **d** day, **h** hour, **m** minute, and
  897. **s** second). **TIME_IS_INTERVAL** can have any of the following
  898. three values: (1) OFF [Default]. No adjustment, time is decoded as
  899. given. (2) +\ *n*\ *unit*. Activate interval adjustment for input by
  900. truncate to previous whole number of *n* units and then center time
  901. on the following interval. (3) -*n*\ *unit*. Same, but center time on
  902. the previous interval. For example, with **TIME_IS_INTERVAL** =
  903. +1o, an input data string like 1999-12 will be interpreted to mean
  904. 1999-12-15T12:00:00.0 (exactly middle of December), while if
  905. **TIME_IS_INTERVAL** = off then that date is interpreted to mean
  906. 1999-12-01T00:00:00.0 (start of December) [off].
  907. **TIME_REPORT**
  908. Controls if a time-stamp should be issued at start of all progress
  909. reports. Choose among **clock** (absolute time stamp),
  910. **elapsed** (time since start of session), or **none**
  911. [none].
  912. **TIME_SYSTEM**
  913. Shorthand for a combination of :term:`TIME_EPOCH` and :term:`TIME_UNIT`,
  914. specifying which time epoch the relative time refers to and what the
  915. units are. Choose from one of the preset systems below (epoch and
  916. units are indicated):
  917. ============ ====================== =========== =====================
  918. TIME_SYSTEM TIME_EPOCH TIME_UNIT Notes
  919. ============ ====================== =========== =====================
  920. JD -4713-11-25T12:00:00 d Julian Date
  921. MJD 1858-11-17T00:00:00 d Modified Julian Date
  922. J2000 2000-01-01T12:00:00 d Astronomical time
  923. S1985 1985-01-01T00:00:00 s Altimetric time
  924. UNIX 1970-01-01T00:00:00 s UNIX time
  925. RD0001 0001-01-01T00:00:00 s
  926. RATA 0000-12-31T00:00:00 d
  927. ============ ====================== =========== =====================
  928. This parameter is not stored in the **gmt.conf** file but is
  929. translated to the respective values of :term:`TIME_EPOCH` and
  930. :term:`TIME_UNIT`.
  931. **TIME_UNIT**
  932. Specifies the units of relative time data since epoch (see
  933. :term:`TIME_EPOCH`). Choose **y** (year - assumes all years are 365.2425
  934. days), **o** (month - assumes all months are of equal length y/12), **d**
  935. (day), **h** (hour), **m** (minute), or **s** (second) [**s**].
  936. **TIME_WEEK_START**
  937. When weeks are indicated on time axes, this parameter determines the
  938. first day of the week for Gregorian calendars. (The ISO weekly
  939. calendar always begins weeks with Monday.) [Monday (or Sunday)].
  940. **TIME_Y2K_OFFSET_YEAR**
  941. When 2-digit years are used to represent 4-digit years (see various
  942. **FORMAT_DATE**\ s), :term:`TIME_Y2K_OFFSET_YEAR` gives the first
  943. year in a 100-year sequence. For example, if
  944. :term:`TIME_Y2K_OFFSET_YEAR` is 1729, then numbers 29 through 99
  945. correspond to 1729 through 1799, while numbers 00 through 28
  946. correspond to 1800 through 1828. [1950].
  947. See Also
  948. --------
  949. :doc:`gmt` , :doc:`gmtdefaults` ,
  950. :doc:`gmtcolors` , :doc:`gmtget` ,
  951. :doc:`gmtset`
Tip!

Press p or to see the previous file or, n or to see the next file

Comments

Loading...