/
psxy.c
2932 lines (2749 loc) · 148 KB
/
psxy.c
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
/*--------------------------------------------------------------------
*
* Copyright (c) 1991-2023 by the GMT Team (https://www.generic-mapping-tools.org/team.html)
* See LICENSE.TXT file for copying and redistribution conditions.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3 or any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* Contact info: www.generic-mapping-tools.org
*--------------------------------------------------------------------*/
/*
* Author: Paul Wessel
* Date: 1-JAN-2010
* Version: 6 API
*
* Brief synopsis: psxy will read <x,y> points and plot symbols, lines,
* or polygons on maps.
*
* Note on KEYS: S?(=2 means if -S~|q then we may possibly take optional crossing line file, else the ? is set to ! for skipping it.
* The "2" means we must skip two characters (q|~ and f|x) before finding the dataset file name
*/
#include "gmt_dev.h"
#include "longopt/psxy_inc.h"
#define THIS_MODULE_CLASSIC_NAME "psxy"
#define THIS_MODULE_MODERN_NAME "plot"
#define THIS_MODULE_LIB "core"
#define THIS_MODULE_PURPOSE "Plot lines, polygons, and symbols in 2-D"
#define THIS_MODULE_KEYS "<D{,CC(,T-<,S?(=2,ZD(,>X}"
#define THIS_MODULE_NEEDS "Jd"
#define THIS_MODULE_OPTIONS "-:>BJKOPRUVXYabdefghilpqtw" GMT_OPT("Mmc")
/* Control structure for psxy */
#define PSXY_E_OPT "-E[x|y|X|Y][+a|A][+c[l|f]][+n][+p<pen>][+w<width>[/<cap>]]"
struct PSXY_CTRL {
bool no_RJ_needed; /* Special case of -T and no -B when -R -J is not required */
struct PSXY_A { /* -A[m|y|p|x|r|t<step>] */
bool active;
unsigned int mode;
double step;
} A;
struct PSXY_C { /* -C<cpt> or -C<color1>,<color2>[,<color3>,...] */
bool active;
char *file;
} C;
struct PSXY_D { /* -D<dx>/<dy> */
bool active;
double dx, dy;
} D;
struct PSXY_E { /* -E[x|y|X|Y][+a|A][+c[l|f]][+n][+p<pen>][+w<width>[/<cap>]] */
bool active;
bool LU; /* True if asymmetrical deviations are instead lower/upper values */
unsigned int xbar, ybar; /* 0 = not used, 1 = error bar, 2 = asymmetrical error bar, 3 = box-whisker, 4 = notched box-whisker */
unsigned int mode; /* 0 = normal, 1 = -C applies to error pen color, 2 = -C applies to symbol fill & error pen color */
double width; /* Width of whisker symbol [7p] */
double cap; /* Width of error bar cap or whisker [7p] */
struct GMT_PEN pen;
} E;
struct PSXY_F { /* -F<mode> */
bool active;
struct GMT_SEGMENTIZE S;
} F;
struct PSXY_G { /* -G<fill>|+z */
bool active;
bool set_color;
unsigned int sequential;
struct GMT_FILL fill;
} G;
struct PSXY_H { /* -H read overall scaling factor for symbol size and pen width */
bool active;
unsigned int mode;
double value;
} H;
struct PSXY_I { /* -I[<intensity>] */
bool active;
unsigned int mode; /* 0 if constant, 1 if read from file (symbols only) */
double value;
} I;
struct PSXY_L { /* -L[+xl|r|x0][+yb|t|y0][+e|E][+p<pen>] */
bool active;
bool polygon; /* true when just -L is given */
int outline; /* true when +p<pen> is given */
unsigned int mode; /* Which side for the anchor */
unsigned int anchor; /* 0 not used, 1 = x anchors, 2 = y anchors, 3 = +/-dy, 4 = -dy1, +dy2 */
double value;
struct GMT_PEN pen;
} L;
struct PSXY_N { /* -N[r|c] */
bool active;
unsigned int mode;
} N;
struct PSXY_S { /* -S */
bool active;
char *arg;
} S;
struct PSXY_T { /* -T */
bool active;
} T;
struct PSXY_W { /* -W<pen>[+z] */
bool active;
bool cpt_effect;
bool set_color;
unsigned int sequential;
struct GMT_PEN pen;
} W;
struct PSXY_Z { /* -Z<value>[+t|T] */
bool active;
unsigned set_transp;
double value;
char *file;
} Z;
};
#define EBAR_CAP_WIDTH 7.0 /* Error bar cap width */
enum Psxy_ebartype {
EBAR_NONE = 0,
EBAR_NORMAL = 1,
EBAR_ASYMMETRICAL = 2,
EBAR_WHISKER = 3,
EBAR_NOTCHED_WHISKER = 4};
enum Psxy_cliptype {
PSXY_CLIP_REPEAT = 0,
PSXY_CLIP_NO_REPEAT,
PSXY_NO_CLIP_REPEAT,
PSXY_NO_CLIP_NO_REPEAT};
enum Psxy_poltype {
PSXY_POL_X = 1,
PSXY_POL_Y,
PSXY_POL_SYMM_DEV,
PSXY_POL_ASYMM_DEV,
PSXY_POL_ASYMM_ENV};
enum Psxy_scaletype {
PSXY_READ_SCALE = 0,
PSXY_CONST_SCALE = 1};
static void *New_Ctrl (struct GMT_CTRL *GMT) { /* Allocate and initialize a new control structure */
struct PSXY_CTRL *C;
C = gmt_M_memory (GMT, NULL, 1, struct PSXY_CTRL);
/* Initialize values whose defaults are not 0/false/NULL */
C->E.pen = C->W.pen = GMT->current.setting.map_default_pen;
gmt_init_fill (GMT, &C->G.fill, -1.0, -1.0, -1.0); /* Default is no fill */
C->E.width = C->E.cap = EBAR_CAP_WIDTH * GMT->session.u2u[GMT_PT][GMT_INCH]; /* 7p */
C->N.mode = PSXY_CLIP_REPEAT;
return (C);
}
static void Free_Ctrl (struct GMT_CTRL *GMT, struct PSXY_CTRL *C) { /* Deallocate control structure */
if (!C) return;
gmt_M_str_free (C->C.file);
gmt_M_str_free (C->S.arg);
gmt_freepen (GMT, &C->W.pen);
gmt_M_free (GMT, C);
}
GMT_LOCAL void psxy_plot_x_errorbar (struct GMT_CTRL *GMT, struct PSL_CTRL *PSL, double x, double y, double delta_x[], double error_width2, int line, int kind) {
double x_0, y_0, x_1, x_2, y_1, y_2;
bool tip1, tip2;
unsigned int first = 0, second = (kind == EBAR_ASYMMETRICAL) ? 1 : 0; /* first and second are either both 0 or second is 1 for asymmetrical bars */
tip1 = tip2 = (error_width2 > 0.0);
gmt_geo_to_xy (GMT, x - fabs (delta_x[first]), y, &x_1, &y_1);
gmt_geo_to_xy (GMT, x + fabs (delta_x[second]), y, &x_2, &y_2);
if (gmt_M_is_dnan (x_1)) {
gmt_geo_to_xy (GMT, x, y, &x_0, &y_0);
x_1 = MIN (GMT->current.proj.rect[XLO], x_0);
tip1 = false;
GMT_Report (GMT->parent, GMT_MSG_WARNING, "X error bar exceeded domain near line %d. Left bar point reset to %g\n", line, x_1);
}
if (gmt_M_is_dnan (x_2)) {
gmt_geo_to_xy (GMT, x, y, &x_0, &y_0);
x_2 = MAX (GMT->current.proj.rect[XHI], x_0);
tip2 = false;
GMT_Report (GMT->parent, GMT_MSG_WARNING, "X error bar exceeded domain near line %d. Right bar point reset to %g\n", line, x_1);
}
PSL_plotsegment (PSL, x_1, y_1, x_2, y_2);
if (tip1) PSL_plotsegment (PSL, x_1, y_1 - error_width2, x_1, y_1 + error_width2);
if (tip2) PSL_plotsegment (PSL, x_2, y_2 - error_width2, x_2, y_2 + error_width2);
}
GMT_LOCAL void psxy_plot_y_errorbar (struct GMT_CTRL *GMT, struct PSL_CTRL *PSL, double x, double y, double delta_y[], double error_width2, int line, int kind) {
double x_0, y_0, x_1, x_2, y_1, y_2;
bool tip1, tip2;
unsigned int first = 0, second = (kind == EBAR_ASYMMETRICAL) ? 1 : 0; /* first and second are either both 0 or second is 1 for asymmetrical bars */
tip1 = tip2 = (error_width2 > 0.0);
gmt_geo_to_xy (GMT, x, y - fabs (delta_y[first]), &x_1, &y_1);
gmt_geo_to_xy (GMT, x, y + fabs (delta_y[second]), &x_2, &y_2);
if (gmt_M_is_dnan (y_1)) {
gmt_geo_to_xy (GMT, x, y, &x_0, &y_0);
y_1 = MIN (GMT->current.proj.rect[YLO], y_0);
tip1 = false;
GMT_Report (GMT->parent, GMT_MSG_WARNING, "Y error bar exceeded domain near line %d. Bottom bar point reset to %g\n", line, y_1);
}
if (gmt_M_is_dnan (y_2)) {
gmt_geo_to_xy (GMT, x, y, &x_0, &y_0);
y_2 = MAX (GMT->current.proj.rect[YHI], y_0);
tip2 = false;
GMT_Report (GMT->parent, GMT_MSG_WARNING, "Y error bar exceeded domain near line %d. Top bar point reset to %g\n", line, y_1);
}
PSL_plotsegment (PSL, x_1, y_1, x_2, y_2);
if (tip1) PSL_plotsegment (PSL, x_1 - error_width2, y_1, x_1 + error_width2, y_1);
if (tip2) PSL_plotsegment (PSL, x_2 - error_width2, y_2, x_2 + error_width2, y_2);
}
GMT_LOCAL void psxy_plot_x_whiskerbar (struct GMT_CTRL *GMT, struct PSL_CTRL *PSL, double x, double y, double hinge[], double whisk_width2, double error_width2, double rgb[], int line, int kind) {
unsigned int i;
static unsigned int q[4] = {0, 25, 75, 100};
double xx[4], yy[4], yL, yH;
for (i = 0; i < 4; i++) { /* for 0, 25, 75, 100% hinges */
gmt_geo_to_xy (GMT, hinge[i], y, &xx[i], &yy[i]);
if (gmt_M_is_dnan (xx[i])) {
GMT_Report (GMT->parent, GMT_MSG_WARNING, "X %d %% hinge exceeded domain near line %d\n", q[i], line);
xx[i] = (i < 2) ? GMT->current.proj.rect[XLO] : GMT->current.proj.rect[XHI];
}
}
yL = yy[1] - whisk_width2; /* B-W start */
yH = yy[2] + whisk_width2; /* B-W end */
yy[1] -= error_width2; /* Cap ends */
yy[2] += error_width2;
PSL_plotsegment (PSL, xx[0], yy[1], xx[0], yy[2]); /* Left whisker */
PSL_plotsegment (PSL, xx[0], yy[0], xx[1], yy[0]);
PSL_plotsegment (PSL, xx[3], yy[1], xx[3], yy[2]); /* Right whisker */
PSL_plotsegment (PSL, xx[3], yy[0], xx[2], yy[0]);
PSL_setfill (PSL, rgb, 1);
if (kind == EBAR_NOTCHED_WHISKER) { /* Notched box-n-whisker plot */
double xp[10], yp[10], s, p;
s = 1.57 * (xx[2] - xx[1]) / sqrt(hinge[4]); /* 5th term in hinge has n */
xp[0] = xp[9] = xx[1];
xp[1] = xp[8] = ((p = (x - s)) < xp[0]) ? xp[0] : p;
xp[2] = xp[7] = x;
xp[4] = xp[5] = xx[2];
xp[3] = xp[6] = ((p = (x + s)) > xp[4]) ? xp[4] : p;
yp[0] = yp[1] = yp[3] = yp[4] = yL;
yp[5] = yp[6] = yp[8] = yp[9] = yH;
yp[2] = yy[0] - 0.5 * error_width2;
yp[7] = yy[0] + 0.5 * error_width2;
PSL_plotpolygon (PSL, xp, yp, 10);
PSL_plotsegment (PSL, x, yp[7], x, yp[2]); /* Median line */
}
else {
PSL_plotbox (PSL, xx[1], yL, xx[2], yH); /* Main box */
PSL_plotsegment (PSL, x, yL, x, yH); /* Median line */
}
}
GMT_LOCAL void psxy_plot_y_whiskerbar (struct GMT_CTRL *GMT, struct PSL_CTRL *PSL, double x, double y, double hinge[], double whisk_width2, double error_width2, double rgb[], int line, int kind) {
unsigned int i;
static unsigned int q[4] = {0, 25, 75, 100};
double xx[4], yy[4], xL, xH;
for (i = 0; i < 4; i++) { /* for 0, 25, 75, 100% hinges */
gmt_geo_to_xy (GMT, x, hinge[i], &xx[i], &yy[i]);
if (gmt_M_is_dnan (yy[i])) {
GMT_Report (GMT->parent, GMT_MSG_WARNING, "Y %d %% hinge exceeded domain near line %d\n", q[i], line);
yy[i] = (i < 2) ? GMT->current.proj.rect[YLO] : GMT->current.proj.rect[YHI];
}
}
xL = xx[1] - whisk_width2; /* B-W start */
xH = xx[2] + whisk_width2; /* B-W end */
xx[1] -= error_width2; /* Cap ends */
xx[2] += error_width2;
PSL_plotsegment (PSL, xx[1], yy[0], xx[2], yy[0]); /* bottom whisker */
PSL_plotsegment (PSL, xx[0], yy[0], xx[0], yy[1]);
PSL_plotsegment (PSL, xx[1], yy[3], xx[2], yy[3]); /* Top whisker */
PSL_plotsegment (PSL, xx[0], yy[3], xx[0], yy[2]);
PSL_setfill (PSL, rgb, 1);
if (kind == EBAR_NOTCHED_WHISKER) { /* Notched box-n-whisker plot */
double xp[10], yp[10], s, p;
s = 1.57 * (yy[2] - yy[1]) / sqrt(hinge[4]); /* 5th term in hinge has n */
xp[0] = xp[1] = xp[3] = xp[4] = xH;
xp[5] = xp[6] = xp[8] = xp[9] = xL;
xp[2] = xx[0] + 0.5 * error_width2;
xp[7] = xx[0] - 0.5 * error_width2;
yp[0] = yp[9] = yy[1];
yp[1] = yp[8] = ((p = (y - s)) < yp[0]) ? yp[0] : p;
yp[2] = yp[7] = y;
yp[4] = yp[5] = yy[2];
yp[3] = yp[6] = ((p = (y + s)) > yp[4]) ? yp[4] : p;
PSL_plotpolygon (PSL, xp, yp, 10);
PSL_plotsegment (PSL, xp[7], y, xp[2], y); /* Median line */
}
else {
PSL_plotbox (PSL, xH, yy[2], xL, yy[1]); /* Main box */
PSL_plotsegment (PSL, xL, y, xH, y); /* Median line */
}
}
GMT_LOCAL void psxy_decorate_debug (struct GMT_CTRL *GMT, struct PSL_CTRL *PSL, struct GMT_DECORATE *G) {
uint64_t row;
double size[1] = {0.05};
/* If called we simply draw the helper lines or points to assist in debug */
gmt_setpen (GMT, &G->debug_pen);
if (G->fixed) { /* Place a small open circle at each fixed point */
PSL_setfill (PSL, GMT->session.no_rgb, PSL_OUTLINE);
for (row = 0; row < (uint64_t)G->f_n; row++)
PSL_plotsymbol (PSL, G->f_xy[0][row], G->f_xy[1][row], size, PSL_CIRCLE);
}
else if (G->crossing) { /* Draw a thin line */
uint64_t seg;
unsigned int *pen = NULL;
struct GMT_DATASEGMENT *S = NULL;
for (seg = 0; seg < G->X->n_segments; seg++) {
S = G->X->table[0]->segment[seg]; /* Current segment */
pen = gmt_M_memory (GMT, NULL, S->n_rows, unsigned int);
for (row = 1, pen[0] = PSL_MOVE; row < S->n_rows; row++) pen[row] = PSL_DRAW;
gmt_plot_line (GMT, S->data[GMT_X], S->data[GMT_Y], pen, S->n_rows, PSL_LINEAR);
gmt_M_free (GMT, pen);
}
}
}
GMT_LOCAL int psxy_convert_eps_to_def (struct GMT_CTRL *GMT, char *in_name, char *path) {
/* Replace an EPS file with a simple 1-liner custom file using an inline EPS command P instead.
* path is updated to point to the replacement temp file */
FILE *fp = NULL;
if ((fp = gmt_create_tempfile (GMT->parent, "gmt_epssymbol", ".def", path)) == NULL) /* Not good... */
return GMT_RUNTIME_ERROR;
fprintf (fp, "# Custom symbol for placing a single EPS file\n0 0 1 %s %c\n", in_name, GMT_SYMBOL_EPS); /* The EPS placement item */
fclose (fp);
return GMT_NOERROR;
}
GMT_LOCAL int psxy_plot_decorations (struct GMT_CTRL *GMT, struct GMT_DATASET *D, struct GMT_DECORATE *G, bool decorate_custom) {
/* Accept the dataset D with records of {x, y, size, angle, symbol} and plot rotated symbols at those locations.
* Note: The x,y are projected coordinates in inches, hence our -R -J choice below. */
unsigned int type = 0, pos = 0;
bool l_active = GMT->common.l.active;
size_t len;
char string[GMT_VF_LEN] = {""}, buffer[GMT_BUFSIZ] = {""}, tmp_file[PATH_MAX] = {""}, kode[2] = {'K', 'k'};
char name[GMT_BUFSIZ] = {""}, path[PATH_MAX] = {""}, *symbol_code = G->symbol_code;
FILE *fp = NULL;
gmt_set_dataset_minmax (GMT, D); /* Determine min/max for each column and add up total records */
if (D->n_records == 0) /* No symbols to plot */
return GMT_NOERROR;
GMT->common.l.active = false; /* Since this call to psxy is not meant to do -l anyway */
/* Here we have symbols. Open up a virtual input file for the call to psxy */
if (GMT_Open_VirtualFile (GMT->parent, GMT_IS_DATASET, GMT_IS_POINT, GMT_IN|GMT_IS_REFERENCE, D, string) != GMT_NOERROR)
return (GMT->parent->error);
if (decorate_custom) { /* Must find the custom symbol */
if ((type = gmt_locate_custom_symbol (GMT, &symbol_code[1], name, path, &pos)) == 0) return (GMT_RUNTIME_ERROR);
if (type == GMT_CUSTOM_EPS) { /* Must replace an EPS symbol with a simple 1-liner custom file */
/* Update data file trailing text with new symbol name */
uint64_t seg, row;
struct GMT_DATASEGMENT *S = NULL;
if (psxy_convert_eps_to_def (GMT, &symbol_code[1], path))
return GMT_RUNTIME_ERROR;
sprintf (name, "k%s", path); name[strlen(name)-4] = '\0'; /* Chop off extension in temp symbol file name */
for (seg = 0; seg < D->n_segments; seg++) {
S = D->table[0]->segment[seg];
for (row = 0; row < S->n_rows; row++) {
gmt_M_str_free (S->text[row]); /* Free old name */
S->text[row] = strdup (name); /* Allocate and store new name */
}
}
type = GMT_CUSTOM_DEF; /* Update the symbol type */
}
}
if (G->debug) psxy_decorate_debug (GMT, GMT->PSL, G); /* Debugging lines and points */
if (GMT->parent->tmp_dir) /* Make unique file in temp dir */
sprintf (tmp_file, "%s/GMT_symbol%d.def", GMT->parent->tmp_dir, (int)getpid());
else /* Make unique file in current dir */
sprintf (tmp_file, "GMT_symbol%d.def", (int)getpid());
GMT_Report (GMT->parent, GMT_MSG_DEBUG, "Number of decorated line symbols: %d\n", (int)D->n_records);
GMT_Report (GMT->parent, GMT_MSG_DEBUG, "Temporary decorated line symbol .def file created: %s\n", tmp_file);
if ((fp = fopen (tmp_file, "w")) == NULL) { /* Disaster */
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Unable to create symbol file needed for decorated lines: %s\n", tmp_file);
return GMT_ERROR_ON_FOPEN;
}
if (type == GMT_CUSTOM_DEF) { /* Use the user's custom symbol but add the rotation requirement */
FILE *fpc = fopen (path, "r"); /* We know the file exists from earlier parsing */
bool first = true;
while (fgets (buffer, GMT_BUFSIZ, fpc)) {
if (buffer[0] == '#') { fprintf (fp, "%s", buffer); continue; } /* Pass comments */
if (!strncmp (buffer, "N: ", 3U)) {
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Decorated lines cannot use custom symbols that expect extra parameters: %s\n", name);
fclose (fpc);
return (GMT_RUNTIME_ERROR);
}
if (first) { /* Insert our count and rotation as first actionable macro command */
fprintf (fp, "# Rotated custom symbol, read size and rotation from data file\nN: 1 o\n$1 R\n");
first = false;
}
fprintf (fp, "%s", buffer); /* Pass remaining lines unchanged */
}
fclose (fpc);
}
else /* Make a rotated plain symbol of type picked up from input file */
fprintf (fp, "# Rotated standard symbol, need size, rotation and symbol code from data file\nN: 1 o\n$1 R\n0 0 1 ?\n");
fclose (fp);
len = strlen (tmp_file) - 4; /* Position of the '.' since we know extension is .def */
tmp_file[len] = '\0'; /* Temporarily hide the ".def" extension */
/* Use -Sk for custom; otherwise -SK since our kustom symbol has a variable standard symbol ? that we must get from each data records */
sprintf (buffer, "-R%g/%g/%g/%g -Jx1i -O -K -S%c%s %s --GMT_HISTORY=readonly", GMT->current.proj.rect[XLO], GMT->current.proj.rect[XHI],
GMT->current.proj.rect[YLO], GMT->current.proj.rect[YHI], kode[decorate_custom], tmp_file, string);
GMT_Report (GMT->parent, GMT_MSG_INFORMATION, "Calling psxy with args %s\n", buffer);
if (GMT_Call_Module (GMT->parent, "psxy", GMT_MODULE_CMD, buffer) != GMT_NOERROR) /* Plot all the symbols */
return (GMT->parent->error);
if (GMT_Close_VirtualFile (GMT->parent, string) != GMT_NOERROR)
return (GMT->parent->error);
tmp_file[len] = '.'; /* Restore the ".def" extension so we can delete the file (unless -Vd) */
if (gmt_M_is_verbose (GMT, GMT_MSG_DEBUG)) { /* Leave the symbol def and txt files in the temp directory */
char tmp_file2[GMT_LEN64] = {""};
bool was = GMT->current.setting.io_header[GMT_OUT]; /* Save current setting */
GMT_Report (GMT->parent, GMT_MSG_DEBUG, "Temporary symbol file for decorated lines saved: %s\n", tmp_file);
if (GMT->parent->tmp_dir) /* Make unique file in tmp dir */
sprintf (tmp_file2, "%s/GMT_symbol%d.txt", GMT->parent->tmp_dir, (int)getpid());
else /* Make unique file in current dir */
sprintf (tmp_file2, "GMT_symbol%d.txt", (int)getpid());
sprintf (buffer, "-R -J -O -K -SK%s %s", tmp_file, tmp_file2);
GMT_Set_Comment (GMT->parent, GMT_IS_DATASET, GMT_COMMENT_IS_TEXT | GMT_COMMENT_IS_COMMAND, buffer, D);
GMT_Report (GMT->parent, GMT_MSG_DEBUG, "Temporary data file for decorated lines saved: %s\n", tmp_file2);
gmt_set_tableheader (GMT, GMT_OUT, true); /* We need to ensure we write the header here */
if (GMT_Write_Data (GMT->parent, GMT_IS_DATASET, GMT_IS_FILE, GMT_IS_POINT, GMT_IO_RESET, NULL, tmp_file2, D) != GMT_NOERROR) {
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Unable to write file: %s\n", tmp_file2);
}
gmt_set_tableheader (GMT, GMT_OUT, was); /* Restore what we had */
}
else {
if (gmt_remove_file (GMT, tmp_file)) /* Just remove the symbol def file */
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Failed to delete file: %s\n", tmp_file);
}
GMT->common.l.active = l_active; /* Reset in case it was set */
return GMT_NOERROR;
}
GMT_LOCAL void psxy_plot_end_vectors (struct GMT_CTRL *GMT, double *x, double *y, uint64_t n, struct GMT_PEN *P) {
/* Maybe add vector heads. Here, x,y are in inches on the plot */
unsigned int k, current[2] = {0,0}, next[2] = {1,0};
double dim[PSL_MAX_DIMS], angle, s, c, L;
char *end[2] = {"start", "end"};
if (n < 2) return; /* No line of mine */
if (P->end[0].V == NULL && P->end[1].V == NULL) return; /* No arrow heads requested */
current[1] = (unsigned int)n-1; next[1] = (unsigned int)n-2;
PSL_command (GMT->PSL, "V\n");
GMT->PSL->current.linewidth = -1.0; /* Will be changed by next PSL_setlinewidth */
gmt_M_memset (dim, PSL_MAX_DIMS, double);
for (k = 0; k < 2; k++) {
if (P->end[k].V == NULL) continue;
P->end[k].V->v.status |= PSL_VEC_LINE; /* Flag so head is not skipped due to "short" vector */
/* Add vector heads to this end */
PSL_comment (GMT->PSL, "Add vector head to %s of line\n", end[k]);
angle = d_atan2d (y[current[k]] - y[next[k]], x[current[k]] - x[next[k]]);
sincosd (angle, &s, &c);
L = (P->end[k].V->v.v_kind[1] == PSL_VEC_TERMINAL) ? 1e-3 : P->end[k].length;
P->end[k].V->v.v_width = (float)(P->end[k].V->v.pen.width * GMT->session.u2u[GMT_PT][GMT_INCH]); /* Set symbol pen width */
dim[PSL_VEC_XTIP] = x[current[k]] + c * L;
dim[PSL_VEC_YTIP] = y[current[k]] + s * L;
dim[PSL_VEC_TAIL_WIDTH] = P->end[k].V->v.v_width;
dim[PSL_VEC_HEAD_LENGTH] = P->end[k].V->v.h_length;
dim[PSL_VEC_HEAD_WIDTH] = P->end[k].V->v.h_width;
dim[PSL_VEC_HEAD_SHAPE] = P->end[k].V->v.v_shape;
dim[PSL_VEC_STATUS] = (double)P->end[k].V->v.status;
dim[PSL_VEC_HEAD_TYPE_BEGIN] = (double)P->end[k].V->v.v_kind[0];
dim[PSL_VEC_HEAD_TYPE_END] = (double)P->end[k].V->v.v_kind[1];
dim[PSL_VEC_TRIM_BEGIN] = (double)P->end[k].V->v.v_trim[0];
dim[PSL_VEC_TRIM_END] = (double)P->end[k].V->v.v_trim[1];
if (P->end[k].V->v.status & PSL_VEC_OUTLINE2) { /* Gave specific head outline pen */
PSL_defpen (GMT->PSL, "PSL_vecheadpen", P->end[k].V->v.pen.width, P->end[k].V->v.pen.style, P->end[k].V->v.pen.offset, P->end[k].V->v.pen.rgb);
dim[PSL_VEC_HEAD_PENWIDTH] = P->end[k].V->v.pen.width;
}
else { /* Set default based on line pen */
PSL_defpen (GMT->PSL, "PSL_vecheadpen", 0.5 * P->width, P->style, P->offset, P->rgb);
dim[PSL_VEC_HEAD_PENWIDTH] = 0.5 * P->width;
}
gmt_setfill (GMT, &P->end[k].V->v.fill, (P->end[k].V->v.status & PSL_VEC_OUTLINE2) == PSL_VEC_OUTLINE2);
PSL_plotsymbol (GMT->PSL, x[current[k]], y[current[k]], dim, PSL_VECTOR);
}
GMT->PSL->current.linewidth = -1.0; /* Will be changed by next PSL_setlinewidth */
PSL_command (GMT->PSL, "U\n");
}
GMT_LOCAL bool psxy_is_stroke_symbol (int symbol) {
/* Return true if cross, x, y, - symbols */
if (symbol == PSL_CROSS) return true;
if (symbol == PSL_XDASH) return true;
if (symbol == PSL_YDASH) return true;
if (symbol == PSL_PLUS) return true;
return false;
}
static int usage (struct GMTAPI_CTRL *API, int level) {
/* This displays the psxy synopsis and optionally full usage information */
const char *name = gmt_show_name_and_purpose (API, THIS_MODULE_LIB, THIS_MODULE_CLASSIC_NAME, THIS_MODULE_PURPOSE);
const char *mod_name = &name[4]; /* To skip the leading gmt for usage messages */
const char *T[2] = {" [-T]", ""};
if (level == GMT_MODULE_PURPOSE) return (GMT_NOERROR);
GMT_Usage (API, 0, "usage: %s [<table>] %s %s [-A[m|p|r|t|x|y]] [%s] [-C<cpt>] [-D<dx>/<dy>] [%s] [-F%s] [-G<fill>|+z] "
"[-H[<scale>]] [-I[<intens>]] %s[%s] [-N[c|r]] %s%s [-S[<symbol>][<size>]]%s [%s] [%s] [-W[<pen>][<attr>]] [%s] [%s] "
"[-Z<value>|<file>[+t|T]] [%s] [%s] %s[%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s] [%s]\n",
name, GMT_J_OPT, GMT_Rgeoz_OPT, GMT_B_OPT, PSXY_E_OPT, GMT_SEGMENTIZE3, API->K_OPT, PLOT_L_OPT, API->O_OPT, API->P_OPT,
T[API->GMT->current.setting.run_mode], GMT_U_OPT, GMT_V_OPT, GMT_X_OPT, GMT_Y_OPT, GMT_a_OPT, GMT_bi_OPT, API->c_OPT,
GMT_di_OPT, GMT_e_OPT, GMT_f_OPT, GMT_g_OPT, GMT_h_OPT, GMT_i_OPT, GMT_l_OPT, GMT_p_OPT, GMT_q_OPT, GMT_tv_OPT,
GMT_w_OPT, GMT_colon_OPT, GMT_PAR_OPT);
if (level == GMT_SYNOPSIS) return (GMT_MODULE_SYNOPSIS);
GMT_Message (API, GMT_TIME_NONE, " REQUIRED ARGUMENTS:\n");
GMT_Option (API, "<,J-Z,R");
GMT_Message (API, GMT_TIME_NONE, "\n OPTIONAL ARGUMENTS:\n");
GMT_Usage (API, 1, "\n-A[m|p|r|t|x|y]");
GMT_Usage (API, -2, "Suppress drawing geographic line segments as great circle arcs, i.e., draw "
"straight lines instead. Six optional directives instead convert paths to staircase curves:");
GMT_Usage (API, 3, "m: First follow meridians, then parallels when connecting geographic points.");
GMT_Usage (API, 3, "p: First follow parallels, then meridians when connecting geographic point.");
GMT_Usage (API, 3, "r: First follow radius, then theta for staircase curves for Polar projection.");
GMT_Usage (API, 3, "t: First follow theta, then radius for staircase curves for Polar projection.");
GMT_Usage (API, 3, "x: First follow x, then y for staircase curves for Cartesian projections.");
GMT_Usage (API, 3, "y: First follow y, then x for staircase curves for Cartesian projections.");
GMT_Option (API, "B-");
GMT_Usage (API, 1, "\n-C<cpt>|<color1>,<color2>[,<color3>,...]");
GMT_Usage (API, -2, "Assign symbol colors based on z-value in 3rd column. "
"Note: requires -S. Without -S, %s excepts lines/polygons "
"and looks for -Z<value> options in each segment header. Then, color is "
"applied for polygon fill (-L) or polygon pen (no -L).", mod_name);
GMT_Usage (API, 1, "\n-D<dx>/<dy>.");
GMT_Usage (API, -2, "Offset symbol or line positions by <dx>/<dy> [no offset].");
GMT_Usage (API, 1, "\n%s", PSXY_E_OPT);
GMT_Usage (API, -2, "Draw (symmetrical) standard error bars for x and/or y. "
"If X or Y are specified then a box-and-whisker diagram is drawn instead, "
"requiring four extra columns with the 0%%, 25%%, 75%%, and 100%% quantiles. "
"The x or y coordinate is expected to represent the 50%% quantile. Optional modifiers:");
GMT_Usage (API, 3, "+a Select asymmetrical errors (reads two columns) [symmetrical, reads one column].");
GMT_Usage (API, 3, "+A As +a, but reads lower and upper bounds instead.");
GMT_Usage (API, 3, "+p Set the error bar <pen> attributes.");
GMT_Usage (API, 3, "+n Select notched box-and whisker (notch width represents uncertainty "
"in the median); a 5th extra column with the sample size is required via the input.");
GMT_Usage (API, 3, "+w Change error bar cap width or box-and-whisker body and whisker widths via <width> [%gp]. Use +w<width>/<cap> to set both separately.", EBAR_CAP_WIDTH);
GMT_Usage (API, -2, "The settings of -W, -G affect the appearance of the 25-75%% box. "
"Given -C, use +cl to apply CPT color to error pen and +cf for error fill [both].");
gmt_segmentize_syntax (API->GMT, 'F', 1);
gmt_fill_syntax (API->GMT, 'G', NULL, "Specify color or pattern [no fill].");
GMT_Usage (API, -2, "The -G option can be present in all segment headers (not with -S). "
"To assign fill color via -Z, give -G+z).");
GMT_Usage (API, 1, "\n-H[<scale>]");
GMT_Usage (API, -2, "Scale symbol sizes (set via -S or input column) by factors read from scale column. "
"The scale column follows the symbol size column. Alternatively, append a fixed <scale>.");
GMT_Usage (API, 1, "\n-I[<intens>]");
GMT_Usage (API, -2, "Use the intensity to modulate the fill color (requires -C or -G). "
"If no intensity is given we expect it to follow symbol size in the data record.");
GMT_Option (API, "K");
GMT_Usage (API, 1, "\n%s", PLOT_L_OPT);
GMT_Usage (API, -2, "Force closed polygons, or append modifiers to build polygon from a line:");
GMT_Usage (API, 3, "+d Symmetrical envelope around y(x) using deviations dy(x) from col 3.");
GMT_Usage (API, 3, "+D Asymmetrical envelope around y(x) using deviations dy1(x) and dy2(x) from cols 3-4.");
GMT_Usage (API, 3, "+b Asymmetrical envelope around y(x) using bounds yl(x) and yh(x) from cols 3-4.");
GMT_Usage (API, 3, "+x Connect 1st and last point to anchor points at l (xmin), r (xmax), or x0.");
GMT_Usage (API, 3, "+y Connect 1st and last point to anchor points at b (ymin), t (ymax), or y0.");
GMT_Usage (API, 3, "+p Draw polygon outline with <pen> [no outline].");
GMT_Usage (API, -2, "The polygon created may be painted via -G.");
GMT_Usage (API, 1, "\n-N[c|r]");
GMT_Usage (API, -2, "Do Not skip or clip symbols that fall outside the map border [clipping is on]:");
GMT_Usage (API, 3, "r: Turn off clipping and plot repeating symbols for periodic maps.");
GMT_Usage (API, 3, "c: Retain clipping but turn off plotting of repeating symbols for periodic maps.");
GMT_Usage (API, -2, "[Default will clip or skip symbols that fall outside and plot repeating symbols].");
GMT_Usage (API, -2, "Note: May also be used with lines or polygons but no periodicity will be honored.");
GMT_Option (API, "O,P");
GMT_Usage (API, 1, "\n-S[<symbol>][<size>]");
GMT_Usage (API, -2, "Select symbol type and symbol size (in %s). Choose from these symbols:",
API->GMT->session.unit_name[API->GMT->current.setting.proj_length_unit]);
GMT_Usage (API, 2, "\n%s Basic geometric symbol. Append one:", GMT_LINE_BULLET);
GMT_Usage (API, -3, "-(xdash), +(plus), st(a)r, (b|B)ar, (c)ircle, (d)iamond, (e)llipse, "
"(f)ront, octa(g)on, (h)exagon, (i)nvtriangle, (j)rotated rectangle, "
"(k)ustom, (l)etter, (m)athangle, pe(n)tagon, (p)oint, (q)uoted line, (r)ectangle, "
"(R)ounded rectangle, (s)quare, (t)riangle, (v)ector, (w)edge, (x)cross, (y)dash, or "
"=(geovector, i.e., great or small circle vectors) or ~(decorated line).");
GMT_Usage (API, -3, "If no size is specified, then the 3rd column must have sizes. "
"If no symbol is specified, then last column must have symbol codes. "
"[Note: if -C is selected then 3rd means 4th column, etc.]. "
"Symbols A, C, D, G, H, I, N, S, T are adjusted to have same area "
"as a circle of the specified diameter.");
GMT_Usage (API, 2, "\n%s Bar: -Sb|B[<size_x|size_y>[c|i|p|q]][+b|B[<base>]][+v|i<nz>][+s[<gap>]]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "Place horizontal or vertical bars. Use upper case -SB for horizontal bars "
"(<base> then refers to x and width may be in y-units) [Default is vertical]. Append size "
"and use unit q if size is quantity given in x-input units [Default is %s]. Available modifiers:",
API->GMT->session.unit_name[API->GMT->current.setting.proj_length_unit]);
GMT_Usage (API, 3, "+B Heights are measured relative to <base> [relative to origin].");
GMT_Usage (API, 3, "+b Set <base>. Alternatively, leave <base> off to read it from file.");
GMT_Usage (API, 3, "+i Increments are given instead or values for multiband bars.");
GMT_Usage (API, 3, "+s Side-by-side placement of multiband bars [stacked multiband bars]. "
"Optionally, append <gap> between bars in fraction (or percent) of <size> [no gap].");
GMT_Usage (API, 3, "+v For multi-band bars, append <nbands>; then <nbands> values will "
"be read from file instead of just one.");
GMT_Usage (API, -3, "Multiband bars requires -C with one color per band (values 0, 1, ...). "
"For -SB the input band values are x (or dx) values instead of y (or dy). ");
GMT_Usage (API, 2, "\n%s Decorated line: -S~[d|n|l|s|x]<info>[:<symbolinfo>]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "The <code><info> settings control placement of symbols along lines. Select from these codes:");
gmt_cont_syntax (API->GMT, 3, 2);
GMT_Usage (API, 3, "<symbolinfo> controls the symbol attributes. Choose optional modifiers:");
gmt_label_syntax (API->GMT, 2, 2);
GMT_Usage (API, 2, "\n%s Ellipse: If not given, then direction, major, and minor axis must be in columns 3-5. "
"If -SE rather than -Se is selected, %s will expect azimuth, and "
"axes [in km], and convert azimuths based on map projection. "
"Use -SE- for a degenerate ellipse (circle) with only its diameter given "
"in column 3, or append a fixed diameter to -SE instead. "
"Append any of the units in %s to the axes, and "
"if reading dimensions from file, just append the unit [Default is k]. "
"For linear projection and -SE we scale the axes by the map scale.", GMT_LINE_BULLET, mod_name, GMT_LEN_UNITS_DISPLAY);
GMT_Usage (API, 2, "\n%s Rotatable Rectangle: If not given, we read direction, width and height from columns 3-5. "
"If -SJ rather than -Sj is selected, %s will expect azimuth, and "
"dimensions [in km] and convert azimuths based on map projection. "
"Use -SJ- for a degenerate rectangle (square w/no rotation) with one dimension given "
"in column 3, or append a fixed dimension to -SJ instead. "
"Append any of the units in %s to the axes, and "
"if reading dimensions from file, just append the unit [Default is k]. "
"For linear projection and -SJ we scale dimensions by the map scale.", GMT_LINE_BULLET, mod_name, GMT_LEN_UNITS_DISPLAY);
GMT_Usage (API, 2, "\n%s Front: -Sf<spacing>[/<ticklen>][+r|l][+f|t|s|c|b|v][+o<offset>][+p<pen>]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "If <spacing> is negative it means the number of gaps instead. "
"If <spacing> has a leading + then <spacing> is used exactly [adjusted to fit line length]. "
"If not given, <ticklen> defaults to 15%% of <spacing>. Append various modifiers:");
GMT_Usage (API, 3, "+l Plot symbol to the left of the front [centered].");
GMT_Usage (API, 3, "+r Plot symbol to the right of the front [centered].");
GMT_Usage (API, 3, "+i Make main front line invisible [drawn using pen settings from -W].");
GMT_Usage (API, 3, "+b Plot square when centered, half-square otherwise.");
GMT_Usage (API, 3, "+c Plot full circle when centered, half-circle otherwise.");
GMT_Usage (API, 3, "+f Plot centered cross-tick or tick only in specified direction [Default].");
GMT_Usage (API, 3, "+s Plot left-or right-lateral strike-slip arrows. Optionally append the arrow angle [20].");
GMT_Usage (API, 3, "+S Same as +s but with curved arrow-heads.");
GMT_Usage (API, 3, "+t Plot diagonal square when centered, directed triangle otherwise.");
GMT_Usage (API, 3, "+o Plot first symbol when along-front distance is <offset> [0].");
GMT_Usage (API, 3, "+p Append <pen> for front symbol outline; if no <pen> then no outline [Outline with -W pen].");
GMT_Usage (API, 3, "+v Plot two inverted triangles, directed inverted triangle otherwise.");
GMT_Usage (API, -3, "Only one of +b|c|f|i|s|S|t|v may be selected.");
GMT_Usage (API, 2, "\n%s Kustom: -Sk|K<symbolname>[/<size>]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "Append <symbolname> immediately after 'k|K'; this will look for "
"<symbolname>.def or <symbolname>.eps in the current directory, in $GMT_USERDIR, "
"or in $GMT_SHAREDIR (searched in that order). Give full path if located elsewhere. "
"Use upper case 'K' if your custom symbol refers a variable symbol, ?.");
gmt_list_custom_symbols (API->GMT);
GMT_Usage (API, 2, "\n%s Letter: -Sl[<size>]+t<string>[a|A<angle>][+f<font>][+j<justify]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "Specify <size> of letter; append required and optional modifiers:");
GMT_Usage (API, 3, "+t Specify <string> to use (required).");
GMT_Usage (API, 3, "+a Set text angle relative to horizontal [0]. Use +A if map azimuth.");
GMT_Usage (API, 3, "+f Set specific <font> for text placement [FONT_ANNOT_PRIMARY].");
GMT_Usage (API, 3, "+j Change the text justification via <justify> [CM].");
GMT_Usage (API, 2, "\n%s Mathangle: radius, start, and stop directions of math angle must be in columns 3-5. "
"If -SM rather than -Sm is used, we draw straight angle symbol if 90 degrees.", GMT_LINE_BULLET);
gmt_vector_syntax (API->GMT, 0, 3);
GMT_Usage (API, 2, "\n%s Quoted line: -Sq[d|n|l|s|x]<info>[:<labelinfo>]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "The <code><info> settings control placement of labels along lines. Select from these codes:");
gmt_cont_syntax (API->GMT, 3, 1);
GMT_Usage (API, 3, "<labelinfo> controls the label attributes. Choose from these choices:");
gmt_label_syntax (API->GMT, 2, 1);
GMT_Usage (API, 2, "\n%s Rectangle: If not given, the x- and y-dimensions must be in columns 3-4. "
"Append +s if instead the diagonal corner coordinates are given in columns 3-4.", GMT_LINE_BULLET);
GMT_Usage (API, 2, "\n%s Rounded rectangle: If not given, the x- and y-dimensions and corner radius must be in columns 3-5.", GMT_LINE_BULLET);
GMT_Usage (API, 2, "\n%s Vector: -Sv|V<size>[+a<angle>][+b][+e][+h<shape>][+j<just>][+l][+m][+n[<norm>[/<min>]]][+o<lon>/<lat>][+q][+r][+s][+t[b|e]<trim>][+z]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "Direction and length must be in columns 3-4. "
"If -SV rather than -Sv is selected, %s will expect azimuth and "
"length and convert azimuths based on the chosen map projection.", mod_name);
gmt_vector_syntax (API->GMT, 19, 3);
GMT_Usage (API, 2, "\n%s Wedge: -Sw|W[<outerdiameter>[/<startdir>/<stopdir>]][+a[<dr>][+i<inner_diameter>][+r[<da>]]]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "Append [<outerdiameter>[<startdir><stopdir>]] or we read these parameters from file from column 3. "
"If -SW rather than -Sw is selected, specify two azimuths instead of directions. "
"-SW: Specify <outerdiameter><unit> with units either from %s or %s [Default is k]. "
"-Sw: Specify <outerdiameter><unit> with units from %s [Default is %s].", GMT_LEN_UNITS_DISPLAY, GMT_DIM_UNITS_DISPLAY, GMT_DIM_UNITS_DISPLAY,
API->GMT->session.unit_name[API->GMT->current.setting.proj_length_unit]);
GMT_Usage (API, 3, "+a Just draw arc(s), optionally specify <dr> increment [wedge].");
GMT_Usage (API, 3, "+i Append nonzero <innerdiameter>; we read it from file if not appended.");
GMT_Usage (API, 3, "+r Just draw radial lines, optionally specify <da> increment [wedge].");
GMT_Usage (API, 2, "\n%s Geovector: -S=<size>[+a<angle>][+b][+e][+h<shape>][+j<just>][+l][+m][+n[<norm>[/<min>]]][+o<lon>/<lat>][+q][+r][+s][+t[b|e]<trim>][+z]", GMT_LINE_BULLET);
GMT_Usage (API, -3, "Azimuth and length must be in columns 3-4. "
"Append any of the units in %s to length [k].", GMT_LEN_UNITS_DISPLAY);
gmt_vector_syntax (API->GMT, 3+32, 3);
if (API->GMT->current.setting.run_mode == GMT_CLASSIC) /* -T has no purpose in modern mode */
GMT_Usage (API, 1, "\n-T Ignore all input files.");
GMT_Option (API, "U,V");
gmt_pen_syntax (API->GMT, 'W', NULL, "Set pen attributes [Default pen is %s].", NULL, 15);
GMT_Usage (API, 2, "To assign pen outline color via -Z, append +z.");
GMT_Option (API, "X");
GMT_Usage (API, 1, "\n-Z<value>|<file>[+t|T]");
GMT_Usage (API, -2, "Use <value> with -C<cpt> to determine <color> instead of via -G<color> or -W<pen>. "
"Use <file> to get per-line or polygon <values>. Two modifiers can also be used: ");
GMT_Usage (API, 3, "+t Expect transparency (0-100%%) instead of z-value in the last column of <file>.");
GMT_Usage (API, 3, "+T Expect both transparency (0-100%%) and z-value in last two columns of <file>.");
GMT_Usage (API, -2, "Control if the outline or fill (for polygons only) are affected: ");
GMT_Usage (API, 3, "%s To use <color> for fill, also select -G+z. ", GMT_LINE_BULLET);
GMT_Usage (API, 3, "%s To use <color> for an outline pen, also select -W<pen>+z.", GMT_LINE_BULLET);
GMT_Option (API, "a,bi");
if (gmt_M_showusage (API)) GMT_Usage (API, 2, "Default <ncols> is the required number of columns.");
GMT_Option (API, "c,di,e,f,g,h,i,l,p,qi,T,w,:,.");
return (GMT_MODULE_USAGE);
}
GMT_LOCAL unsigned int psxy_old_W_parser (struct GMTAPI_CTRL *API, struct PSXY_CTRL *Ctrl, char *text) {
unsigned int j = 0, n_errors = 0;
if (text[j] == '-') {Ctrl->W.pen.cptmode = 1; j++;}
if (text[j] == '+') {Ctrl->W.pen.cptmode = 3; j++;}
if (text[j] && gmt_getpen (API->GMT, &text[j], &Ctrl->W.pen)) {
gmt_pen_syntax (API->GMT, 'W', NULL, "sets pen attributes [Default pen is %s]:", NULL, 15);
n_errors++;
}
return n_errors;
}
GMT_LOCAL unsigned int psxy_old_E_parser (struct GMTAPI_CTRL *API, struct PSXY_CTRL *Ctrl, char *text) {
unsigned int j = 0, j0, n_errors = 0;
char txt_a[GMT_LEN256] = {""};
while (text[j] && text[j] != '/') {
switch (text[j]) {
case 'x': /* Error bar for x */
Ctrl->E.xbar = EBAR_NORMAL;
if (text[j+1] == '+') { Ctrl->E.xbar = EBAR_ASYMMETRICAL; j++;}
break;
case 'X': /* Box-whisker instead */
Ctrl->E.xbar = EBAR_WHISKER;
if (text[j+1] == 'n') {Ctrl->E.xbar = EBAR_NOTCHED_WHISKER; j++;}
break;
case 'y': /* Error bar for y */
Ctrl->E.ybar = EBAR_NORMAL;
if (text[j+1] == '+') { Ctrl->E.ybar = EBAR_ASYMMETRICAL; j++;}
break;
case 'Y': /* Box-whisker instead */
Ctrl->E.ybar = EBAR_WHISKER;
if (text[j+1] == 'n') {Ctrl->E.ybar = EBAR_NOTCHED_WHISKER; j++;}
break;
case '+': /* Only allowed for -E+ as shorthand for -Ex+y+ */
if (j == 0) Ctrl->E.xbar = Ctrl->E.ybar = EBAR_ASYMMETRICAL;
break;
default: /* Get error 'cap' width */
strncpy (txt_a, &text[j], GMT_LEN256);
j0 = 0;
while (txt_a[j0] && txt_a[j0] != '/') j0++;
txt_a[j0] = 0;
Ctrl->E.width = Ctrl->E.cap = gmt_M_to_inch (API->GMT, txt_a);
while (text[j] && text[j] != '/') j++;
j--;
break;
}
j++;
}
if (text[j] == '/') {
j++;
if (text[j] == '-') {Ctrl->E.mode = 1; j++;}
if (text[j] == '+') {Ctrl->E.mode = 2; j++;}
if (text[j] && gmt_getpen (API->GMT, &text[j], &Ctrl->E.pen)) {
gmt_pen_syntax (API->GMT, 'E', NULL, "sets error bar pen attributes", NULL, 0);
n_errors++;
}
}
return (n_errors);
}
static int parse (struct GMT_CTRL *GMT, struct PSXY_CTRL *Ctrl, struct GMT_OPTION *options, struct GMT_SYMBOL *S) {
/* This parses the options provided to psxy and sets parameters in Ctrl.
* Note Ctrl has already been initialized and non-zero default values set.
* Any GMT common options will override values set previously by other commands.
* It also replaces any file names specified as input or output with the data ID
* returned when registering these sources/destinations with the API.
*/
unsigned int n_errors = 0, ztype, n_files = 0;
int j;
char txt_a[GMT_LEN256] = {""}, txt_b[GMT_LEN256] = {""}, *c = NULL;
struct GMT_OPTION *opt = NULL;
struct GMTAPI_CTRL *API = GMT->parent;
for (opt = options; opt; opt = opt->next) { /* Process all the options given */
switch (opt->option) {
case '<': /* Skip input files after checking they exist */
if (GMT_Get_FilePath (API, GMT_IS_DATASET, GMT_IN, GMT_FILE_REMOTE, &(opt->arg))) n_errors++;
n_files++;
break;
/* Processes program-specific parameters */
case 'A': /* Turn off draw_arc mode */
n_errors += gmt_M_repeated_module_option (API, Ctrl->A.active);
switch (opt->arg[0]) {
case 'm': case 'y': case 'r': Ctrl->A.mode = GMT_STAIRS_Y; break;
case 'p': case 'x': case 't': Ctrl->A.mode = GMT_STAIRS_X; break;
#ifdef DEBUG
default: Ctrl->A.step = atof (opt->arg); break; /* Undocumented test feature */
#endif
}
break;
case 'C': /* Vary symbol color with z */
n_errors += gmt_M_repeated_module_option (API, Ctrl->C.active);
gmt_M_str_free (Ctrl->C.file);
if (opt->arg[0]) Ctrl->C.file = strdup (opt->arg);
break;
case 'D':
n_errors += gmt_M_repeated_module_option (API, Ctrl->D.active);
if ((j = sscanf (opt->arg, "%[^/]/%s", txt_a, txt_b)) < 1) {
GMT_Report (API, GMT_MSG_ERROR, "Option -D: Give x [and y] offsets\n");
n_errors++;
}
else {
Ctrl->D.dx = gmt_M_to_inch (GMT, txt_a);
Ctrl->D.dy = (j == 2) ? gmt_M_to_inch (GMT, txt_b) : Ctrl->D.dx;
}
break;
case 'E': /* Get info for error bars and box-whisker bars */
n_errors += gmt_M_repeated_module_option (API, Ctrl->E.active);
if (gmt_found_modifier (GMT, opt->arg, "aAcnpw")) {
/* New parser for -E[x|y|X|Y][+a|A][+cl|f][+n][+p<pen>][+w<width>[/<cap>] */
char p[GMT_LEN64] = {""}, *s = NULL;
unsigned int pos = 0;
bool whisker = false;
j = 0;
while (opt->arg[j] != '+' && j < 2) { /* Process one or two selections */
switch (opt->arg[j]) {
case 'x': Ctrl->E.xbar = EBAR_NORMAL; break; /* Error bar for x */
case 'y': Ctrl->E.ybar = EBAR_NORMAL; break; /* Error bar for x */
case 'X': Ctrl->E.xbar = EBAR_WHISKER; whisker = true; break; /* Box-whisker for x */
case 'Y': Ctrl->E.ybar = EBAR_WHISKER; whisker = true; break; /* Box-whisker for y */
default:
GMT_Report (API, GMT_MSG_ERROR, "Option -E: Unrecognized error bar selection %c\n", opt->arg[j]);
n_errors++; break;
}
j++;
}
if (j == 0) Ctrl->E.xbar = Ctrl->E.ybar = EBAR_NORMAL; /* Default is both x and y error bars */
while (gmt_getmodopt (GMT, 'E', &(opt->arg[j]), "aAcnpw", &pos, p, &n_errors) && n_errors == 0) {
switch (p[0]) {
case 'A': /* Asymmetrical error bars (lower/upper values)*/
Ctrl->E.LU = true;
/* Fall through on purpose */
case 'a': /* Asymmetrical error bars (-devL/+dev_U) */
if (Ctrl->E.xbar == EBAR_NORMAL) Ctrl->E.xbar = EBAR_ASYMMETRICAL;
if (Ctrl->E.ybar == EBAR_NORMAL) Ctrl->E.ybar = EBAR_ASYMMETRICAL;
break;
case 'c': /* Control CPT usage for fill or pen or both */
switch (p[1]) {
case 'l': Ctrl->E.mode = 1; break;
case 'f': Ctrl->E.mode = 2; break;
default: Ctrl->E.mode = 3; break;
}
break;
case 'n': /* Notched box-and-whisker */
if (Ctrl->E.xbar == EBAR_WHISKER) Ctrl->E.xbar = EBAR_NOTCHED_WHISKER;
if (Ctrl->E.ybar == EBAR_WHISKER) Ctrl->E.ybar = EBAR_NOTCHED_WHISKER;
break;
case 'p': /* Error bar pen */
if (p[1] && gmt_getpen (GMT, &p[1], &Ctrl->E.pen)) {
gmt_pen_syntax (GMT, 'E', NULL, "sets error bar pen attributes", NULL, 0);
n_errors++;
}
break;
case 'w': /* Error bar cap width and or box-and-whisker body width */
if ((s = strchr (p, '/'))) { /* Got separate arguments for whisker width and cap width */
if (whisker) { /* OK, process the two arguments */
sscanf (&p[1], "%[^/]/%s", txt_a, txt_b);
Ctrl->E.width = gmt_M_to_inch (GMT, txt_a);
Ctrl->E.cap = gmt_M_to_inch (GMT, txt_b);
}
else { /* Cannot give two arguments for error bars */
GMT_Report (API, GMT_MSG_ERROR, "Option -E: Cannot give two values for error bar cap width\n");
n_errors++;
}
}
else/* Use same value for box-and-whisker width and cap width */
Ctrl->E.width = Ctrl->E.cap = gmt_M_to_inch (GMT, &p[1]);
break;
default: break; /* These are caught in gmt_getmodopt so break is just for Coverity */
}
}
}
else /* Old parsing of -E[x[+]|y[+]|X|Y][n][cap][/[+|-]<pen>] */
n_errors += psxy_old_E_parser (API, Ctrl, opt->arg);
GMT_Report (API, GMT_MSG_DEBUG, "Settings for -E: x = %d y = %d\n", Ctrl->E.xbar, Ctrl->E.ybar);
break;
case 'F':
n_errors += gmt_M_repeated_module_option (API, Ctrl->F.active);
n_errors += gmt_parse_segmentize (GMT, opt->option, opt->arg, 0, &(Ctrl->F.S));
break;
case 'G': /* Set fill for symbols or polygon */
n_errors += gmt_M_repeated_module_option (API, Ctrl->G.active);
if (strncmp (opt->arg, "+z", 2U) == 0)
Ctrl->G.set_color = true;
else if (!opt->arg[0] || gmt_getfill (GMT, opt->arg, &Ctrl->G.fill)) {
gmt_fill_syntax (GMT, 'G', NULL, " "); n_errors++;
}
if (Ctrl->G.fill.rgb[0] < -4.0) Ctrl->G.sequential = irint (Ctrl->G.fill.rgb[0]+7.0);
break;
case 'H': /* Overall symbol/pen scale column provided */
n_errors += gmt_M_repeated_module_option (API, Ctrl->H.active);
if (opt->arg[0]) { /* Gave a fixed scale - no reading from file */
Ctrl->H.value = atof (opt->arg);
Ctrl->H.mode = PSXY_CONST_SCALE;
}
break;
case 'I': /* Adjust symbol color via intensity */
n_errors += gmt_M_repeated_module_option (API, Ctrl->I.active);
if (opt->arg[0])
Ctrl->I.value = atof (opt->arg);
else
Ctrl->I.mode = 1;
break;
case 'L': /* Close line segments */
n_errors += gmt_M_repeated_module_option (API, Ctrl->L.active);
if ((c = strstr (opt->arg, "+b")) != NULL) /* Build asymmetric polygon from lower and upper bounds */
Ctrl->L.anchor = PSXY_POL_ASYMM_ENV;
else if ((c = strstr (opt->arg, "+d")) != NULL) /* Build symmetric polygon from deviations about y(x) */
Ctrl->L.anchor = PSXY_POL_SYMM_DEV;
else if ((c = strstr (opt->arg, "+D")) != NULL) /* Build asymmetric polygon from deviations about y(x) */
Ctrl->L.anchor = PSXY_POL_ASYMM_DEV;
else if ((c = strstr (opt->arg, "+x")) != NULL) { /* Parse x anchors for a polygon */
switch (c[2]) {
case 'l': Ctrl->L.mode = XLO; break; /* Left side anchors */
case 'r': Ctrl->L.mode = XHI; break; /* Right side anchors */
default: Ctrl->L.mode = ZLO; Ctrl->L.value = atof (&c[2]); break; /* Arbitrary x anchor */
}
Ctrl->L.anchor = PSXY_POL_X;
}
else if ((c = strstr (opt->arg, "+y")) != NULL) { /* Parse y anchors for a polygon */
switch (c[2]) {
case 'b': Ctrl->L.mode = YLO; break; /* Bottom side anchors */
case 't': Ctrl->L.mode = YHI; break; /* Top side anchors */
default: Ctrl->L.mode = ZHI; Ctrl->L.value = atof (&c[2]); break; /* Arbitrary y anchor */
}
Ctrl->L.anchor = PSXY_POL_Y;
}
else /* Just force a closed polygon */
Ctrl->L.polygon = true;
if ((c = strstr (opt->arg, "+p")) != NULL) { /* Want outline */
if (c[2] && gmt_getpen (GMT, &c[2], &Ctrl->L.pen)) {
gmt_pen_syntax (GMT, 'W', NULL, "sets pen attributes [Default pen is %s]:", NULL, 3);
n_errors++;
}
Ctrl->L.outline = 1;
}
break;
case 'N': /* Do not skip points outside border */
n_errors += gmt_M_repeated_module_option (API, Ctrl->N.active);
if (opt->arg[0] == 'r') Ctrl->N.mode = PSXY_NO_CLIP_REPEAT;
else if (opt->arg[0] == 'c') Ctrl->N.mode = PSXY_CLIP_NO_REPEAT;
else if (opt->arg[0] == '\0') Ctrl->N.mode = PSXY_NO_CLIP_NO_REPEAT;
else {
GMT_Report (API, GMT_MSG_ERROR, "Option -N: Unrecognized argument %s\n", opt->arg);
n_errors++;
}
break;
case 'S': /* Get symbol [and size] */
n_errors += gmt_M_repeated_module_option (API, Ctrl->S.active);
Ctrl->S.arg = strdup (opt->arg);
break;
case 'T': /* Skip all input files */
n_errors += gmt_M_repeated_module_option (API, Ctrl->T.active);
n_errors += gmt_get_no_argument (GMT, opt->arg, opt->option, 0);
break;
case 'W': /* Set line attributes */
n_errors += gmt_M_repeated_module_option (API, Ctrl->W.active);
if ((c = strstr (opt->arg, "+z"))) {
Ctrl->W.set_color = true;
c[0] = '\0'; /* Chop off this modifier */
}
if (opt->arg[0] == '-' || (opt->arg[0] == '+' && opt->arg[1] != 'c')) { /* Definitively old-style args */