-
Notifications
You must be signed in to change notification settings - Fork 377
/
Copy pathgrdvector.c
893 lines (813 loc) · 42.7 KB
/
grdvector.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
/*--------------------------------------------------------------------
*
* Copyright (c) 1991-2025 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
*--------------------------------------------------------------------*/
/*
* Brief synopsis: grdvector reads 2 grid files that contains the 2 components of a vector
* field (cartesian or polar) and plots vectors at the grid positions.
*
* Author: Paul Wessel
* Date: 1-JAN-2010
* Version: 6 API
*/
#define THIS_MODULE_CLASSIC_NAME "grdvector"
#define THIS_MODULE_MODERN_NAME "grdvector"
#define THIS_MODULE_LIB "core"
#define THIS_MODULE_PURPOSE "Plot vector field from two component grids"
#define THIS_MODULE_KEYS "<G{2,CC(,>X}"
#define THIS_MODULE_NEEDS "Jg"
#include "gmt_dev.h"
#include "longopt/grdvector_inc.h"
#define THIS_MODULE_OPTIONS "->BJKOPRUVXYflptxy" GMT_OPT("c")
struct GRDVECTOR_CTRL {
struct GRDVECTOR_In {
bool active;
char *file[2];
} In;
struct GRDVECTOR_A { /* -A */
bool active;
} A;
struct GRDVECTOR_C { /* -C<cpt>[+i<dz>] */
bool active;
double dz;
char *file;
} C;
struct GRDVECTOR_G { /* -G<fill> */
bool active;
struct GMT_FILL fill;
} G;
struct GRDVECTOR_I { /* -I[x]<dx>[/<dy>] */
bool active;
unsigned int mode;
} I;
struct GRDVECTOR_N { /* -N */
bool active;
} N;
struct GRDVECTOR_Q { /* -Q<size>[+<mods>] */
bool active;
struct GMT_SYMBOL S;
} Q;
struct GRDVECTOR_S { /* -S[l|i]<length|scale>[<unit>][+c[[slon/]slat][+s<scaleval>] */
bool active;
bool constant;
bool invert;
bool reference;
bool origin;
char unit;
char symbol;
unsigned int smode; /* 0 means got slon, slat, 1 means got just slat, 2 means got neither */
double slon, slat; /* Map point where a geovector scale is computed for legend */
double factor;
double scale_value;
} S;
struct GRDVECTOR_T { /* -T */
bool active;
} T;
struct GRDVECTOR_W { /* -W<pen> */
bool active;
bool cpt_effect;
struct GMT_PEN pen;
} W;
struct GRDVECTOR_Z { /* -Z */
bool active;
} Z;
};
static void *New_Ctrl (struct GMT_CTRL *GMT) { /* Allocate and initialize a new control structure */
struct GRDVECTOR_CTRL *C = NULL;
char unit[5] = "cimp";
C = gmt_M_memory (GMT, NULL, 1, struct GRDVECTOR_CTRL);
/* Initialize values whose defaults are not 0/false/NULL */
gmt_init_fill (GMT, &C->G.fill, -1.0, -1.0, -1.0);
C->Q.S.symbol = PSL_VECTOR;
C->W.pen = GMT->current.setting.map_default_pen;
C->S.factor = 1.0;
C->S.unit = unit[GMT->current.setting.proj_length_unit];
return (C);
}
static void Free_Ctrl (struct GMT_CTRL *GMT, struct GRDVECTOR_CTRL *C) { /* Deallocate control structure */
if (!C) return;
gmt_M_str_free (C->In.file[GMT_IN]);
gmt_M_str_free (C->In.file[GMT_OUT]);
gmt_M_str_free (C->C.file);
gmt_M_free (GMT, C);
}
static int usage (struct GMTAPI_CTRL *API, int level) {
const char *name = gmt_show_name_and_purpose (API, THIS_MODULE_LIB, THIS_MODULE_CLASSIC_NAME, THIS_MODULE_PURPOSE);
if (level == GMT_MODULE_PURPOSE) return (GMT_NOERROR);
GMT_Usage (API, 0, "usage: %s <gridx> <gridy> %s [-A] [%s] [-C%s] [-G<fill>] [-I[x]<dx>[/<dy>]] "
"%s[-N] %s%s[-Q<params>] [%s] [-S[i|l]<length>|<scale>[+c[<slon>/]<slat>][+s<refsize>]] [-T] [%s] [%s] [-W<pen>] [%s] [%s] [-Z] "
"%s [%s] [%s] [%s] [%s] [%s]\n", name, GMT_J_OPT, GMT_B_OPT, CPT_OPT_ARGS, API->K_OPT, API->O_OPT, API->P_OPT,
GMT_Rgeo_OPT, GMT_U_OPT, GMT_V_OPT, GMT_X_OPT, GMT_Y_OPT, API->c_OPT, GMT_f_OPT, GMT_l_OPT, GMT_p_OPT, GMT_t_OPT, GMT_PAR_OPT);
if (level == GMT_SYNOPSIS) return (GMT_MODULE_SYNOPSIS);
GMT_Message (API, GMT_TIME_NONE, " REQUIRED ARGUMENTS:\n");
GMT_Usage (API, 1, "\n<gridx> <gridy> are grid files with the two vector components.");
GMT_Option (API, "J-");
GMT_Message (API, GMT_TIME_NONE, "\n OPTIONAL ARGUMENTS:\n");
GMT_Usage (API, 1, "\n-A Grids have polar (r, theta) components [Default is Cartesian (x, y) components].");
GMT_Option (API, "B-");
gmt_explain_cpt_input (API, 'C');
gmt_fill_syntax (API->GMT, 'G', NULL, "Select vector fill [Default is outlines only].");
GMT_Usage (API, 1, "\n-I[x]<dx>[/<dy>]");
GMT_Usage (API, -2, "Plot only those nodes that are <dx> and <dy> apart [Default is all nodes]. "
"Optionally, use -Ix<fact>[/<yfact>] to give multiples of grid spacing.");
GMT_Option (API, "K");
GMT_Usage (API, 1, "\n-N Do Not clip vectors that exceed the map boundaries [Default will clip].");
GMT_Option (API, "O,P");
GMT_Usage (API, 1, "\n-Q<params>");
GMT_Usage (API, -2, "Modify vector attributes [Default gives stick-plot].");
gmt_vector_syntax (API->GMT, 15, 3);
GMT_Option (API, "R");
GMT_Usage (API, 1, "\n-S[i|l]<length>|<scale>[+c[<slon>/]<slat>][+s<refsize>]");
GMT_Usage (API, -2, "Set lengths for vectors in <data-units> per length unit (e.g., 10 nTesla/yr per cm).");
GMT_Usage (API, 2, "%s Cartesian vectors: Append %s to indicate cm, inch, or point as the desired plot length unit [%s]. "
"These vectors are straight and plot lengths are independent of projection.",
GMT_LINE_BULLET, GMT_DIM_UNITS_DISPLAY, API->GMT->session.unit_name[API->GMT->current.setting.proj_length_unit]);
GMT_Usage (API, 2, "%s Geographic vectors: Alternatively give <data-units> per map distance unit "
"by appending any of the distance units in %s to the length. "
"These vectors may curve and plot lengths may depend on the projection.",
GMT_LINE_BULLET, GMT_LEN_UNITS_DISPLAY);
GMT_Usage (API, -2, "Optional directives:");
GMT_Usage (API, 3, "i: The given <scale> is the reciprocal scale, e.g., in %s or km per <data-unit>.",
API->GMT->session.unit_name[API->GMT->current.setting.proj_length_unit]);
GMT_Usage (API, 3, "l: Fixed length (in given unit) for all vectors (also sets <refsiz>).");
GMT_Usage (API, -2, "Optional modifiers:");
GMT_Usage (API, 3, "+c Set point where geovector <refsize> should apply. If no arguments we select the center of the map. "
"Alternatively, give +c<slat> (with central longitude) or +c<slon>/<slat> for a specific point.");
GMT_Usage (API, 3, "+s The given <refsiz> is the value used for the optional legend entry (via -l) [<length>].");
GMT_Usage (API, -2, "Note: Use -V to see the min, max, and mean vector length of plotted vectors.");
GMT_Usage (API, 1, "\n-T Transform angles for Cartesian grids when x- and y-scales differ [Leave alone].");
GMT_Option (API, "U,V");
gmt_pen_syntax (API->GMT, 'W', NULL, "Set pen attributes.", NULL, 0);
GMT_Usage (API, -2, "Default pen attributes [%s].", gmt_putpen(API->GMT, &API->GMT->current.setting.map_default_pen));
GMT_Option (API, "X");
GMT_Usage (API, 1, "\n-Z The theta grid provided has azimuths rather than directions (implies -A).");
GMT_Option (API, "c,f,l,p,t,.");
return (GMT_MODULE_USAGE);
}
static int parse (struct GMT_CTRL *GMT, struct GRDVECTOR_CTRL *Ctrl, struct GMT_OPTION *options) {
/* This parses the options provided to grdvector 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, n_files = 0;
int j;
size_t len;
char txt_a[GMT_LEN256] = {""}, txt_b[GMT_LEN256] = {""}, txt_c[GMT_LEN256] = {""}, *c = NULL;
struct GMT_OPTION *opt = NULL;
struct GMTAPI_CTRL *API = GMT->parent;
/* First determine what type of vector to plot */
for (opt = options; opt; opt = opt->next) {
if (opt->option != 'S') continue; /* Skip until we find -S */
j = (strchr ("li", opt->arg[0])) ? 1 : 0; /* Possibly skip leading -Si or -Sl */
while (opt->arg[j] && strchr (GMT_LEN_UNITS GMT_DIM_UNITS, opt->arg[j]) == NULL) j++; /* Skip digits etc until we hit first unit or end of string */
if (opt->arg[j] && strchr (GMT_LEN_UNITS, opt->arg[j]) && gmt_M_is_geographic (GMT, GMT_IN))
Ctrl->S.symbol = '='; /* Selected a geo-vector */
else if (opt->arg[j] && strchr (GMT_DIM_UNITS, opt->arg[j]))
Ctrl->S.symbol = 'v'; /* Selected a Cartesian vector */
else { /* No useful info, select Cartesian with a warning */
GMT_Report (API, GMT_MSG_WARNING, "No units specified in -S. Selecting Cartesian vector symbol\n");
Ctrl->S.symbol = 'v'; /* Selected a Cartesian vector */
}
}
for (opt = options; opt; opt = opt->next) { /* Process all the options given */
switch (opt->option) {
case '<': /* Input file (only two are accepted) */
Ctrl->In.active = true;
if (n_files >= 2) {n_errors++; continue; }
n_errors += gmt_get_required_file (GMT, opt->arg, opt->option, 0, GMT_IS_GRID, GMT_IN, GMT_FILE_REMOTE, &(Ctrl->In.file[n_files]));
n_files++;
break;
/* Processes program-specific parameters */
case 'A': /* Polar data grids */
n_errors += gmt_M_repeated_module_option (API, Ctrl->A.active);
n_errors += gmt_get_no_argument (GMT, opt->arg, opt->option, 0);
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);
gmt_cpt_interval_modifier (GMT, &(Ctrl->C.file), &(Ctrl->C.dz));
break;
case 'E': /* Center vectors [OBSOLETE; use modifier +jc in -Q ] */
if (gmt_M_compat_check (GMT, 4)) {
GMT_Report (API, GMT_MSG_COMPAT, "Option -E is deprecated; use modifier +jc in -Q instead.\n");
Ctrl->Q.S.v.status |= PSL_VEC_JUST_C;
}
else
n_errors += gmt_default_option_error (GMT, opt);
break;
case 'G': /* Set fill for vectors */
n_errors += gmt_M_repeated_module_option (API, Ctrl->G.active);
if (gmt_getfill (GMT, opt->arg, &Ctrl->G.fill)) {
gmt_fill_syntax (GMT, 'G', NULL, " ");
n_errors++;
}
break;
case 'I': /* Only use gridnodes GMT->common.R.inc[GMT_X],GMT->common.R.inc[GMT_Y] apart */
n_errors += gmt_M_repeated_module_option (API, Ctrl->I.active);
if (opt->arg[0] == 'x') Ctrl->I.mode = 1;
n_errors += gmt_parse_inc_option (GMT, 'I', &opt->arg[Ctrl->I.mode]);
break;
case 'N': /* Do not clip at border */
n_errors += gmt_M_repeated_module_option (API, Ctrl->N.active);
n_errors += gmt_get_no_argument (GMT, opt->arg, opt->option, 0);
break;
case 'Q': /* Vector plots, with parameters */
n_errors += gmt_M_repeated_module_option (API, Ctrl->Q.active);
if (gmt_M_compat_check (GMT, 4) && (strchr (opt->arg, '/') && !strchr (opt->arg, '+'))) { /* Old-style args */
if (gmt_M_is_geographic (GMT, GMT_IN))
GMT_Report (API, GMT_MSG_COMPAT, "Vector arrowwidth/headlength/headwidth is deprecated for geo-vectors; see -Q documentation.\n");
Ctrl->Q.S.v.status = PSL_VEC_END + PSL_VEC_FILL + PSL_VEC_OUTLINE;
Ctrl->Q.S.size_x = VECTOR_HEAD_LENGTH * GMT->session.u2u[GMT_PT][GMT_INCH]; /* 9p */
Ctrl->Q.S.v.h_length = (float)Ctrl->Q.S.size_x; /* 9p */
Ctrl->Q.S.v.v_angle = 60.0f;
Ctrl->Q.S.v.pen = GMT->current.setting.map_default_pen;
for (j = 0; opt->arg[j] && opt->arg[j] != 'n'; j++);
if (opt->arg[j]) { /* Normalize option used */
Ctrl->Q.S.v.v_norm = (float)gmt_M_to_inch (GMT, &opt->arg[j+1]); /* Getting inches directly here */
n_errors += gmt_M_check_condition (GMT, Ctrl->Q.S.v.v_norm <= 0.0, "Option -Qn: No reference length given\n");
opt->arg[j] = '\0'; /* Temporarily chop of the n<norm> string */
}
if (opt->arg[0] && opt->arg[1] != 'n') { /* We specified the three parameters */
if (sscanf (opt->arg, "%[^/]/%[^/]/%s", txt_a, txt_b, txt_c) != 3) {
GMT_Report (API, GMT_MSG_ERROR, "Option -Q: Could not decode arrowwidth/headlength/headwidth\n");
n_errors++;
}
else { /* Turn the old args into new +a<angle> and pen width */
Ctrl->Q.S.v.v_width = (float)gmt_M_to_inch (GMT, txt_a);
Ctrl->Q.S.v.pen.width = gmt_M_to_points (GMT, txt_a);
Ctrl->Q.S.v.h_length = (float)gmt_M_to_inch (GMT, txt_b);
Ctrl->Q.S.v.h_width = (float)gmt_M_to_inch (GMT, txt_c);
}
}
if (Ctrl->Q.S.v.v_norm > 0.0) opt->arg[j] = 'n'; /* Restore the n<norm> string */
Ctrl->Q.S.v.status |= (PSL_VEC_JUST_B + PSL_VEC_FILL); /* Start filled vector at node location */
Ctrl->Q.S.symbol = GMT_SYMBOL_VECTOR_V4;
}
else {
Ctrl->Q.S.symbol = Ctrl->S.symbol;
if (opt->arg[0] == '+') { /* No size (use default), just attributes */
Ctrl->Q.S.size_x = VECTOR_HEAD_LENGTH * GMT->session.u2u[GMT_PT][GMT_INCH]; /* 9p */
n_errors += gmt_parse_vector (GMT, Ctrl->S.symbol, opt->arg, &Ctrl->Q.S);
}
else { /* Size, plus possible attributes */
j = sscanf (opt->arg, "%[^+]%s", txt_a, txt_b); /* txt_a should be symbols size with any +<modifiers> in txt_b */
if (j == 1) txt_b[0] = 0; /* No modifiers present, set txt_b to empty */
Ctrl->Q.S.size_x = gmt_M_to_inch (GMT, txt_a); /* Length of vector */
n_errors += gmt_parse_vector (GMT, Ctrl->S.symbol, txt_b, &Ctrl->Q.S);
}
/* Must possibly change v_norm to inches if given in another Cartesian unit */
if (Ctrl->Q.S.u_set && Ctrl->Q.S.u != GMT_INCH) {
Ctrl->Q.S.v.v_norm *= GMT->session.u2u[Ctrl->Q.S.u][GMT_INCH]; /* Since we are not reading this again we change to inches */
Ctrl->Q.S.u = GMT_INCH;
}
if (Ctrl->Q.S.v.status & PSL_VEC_COMPONENTS) {
GMT_Report (API, GMT_MSG_ERROR, "Option -Q: Cannot use modifier +z; see -A for Cartesian [Default] versus polar component grids\n");
n_errors++;
}
}
break;
case 'S': /* Scale -S[l|i]<length|scale>[<unit>][+c[<slon>/]<slat>][+s<ref_value>] */
n_errors += gmt_M_repeated_module_option (API, Ctrl->S.active);
if ((c = gmt_first_modifier (GMT, opt->arg, "cs"))) {
unsigned int pos = 0;
txt_a[0] = 0;
while (gmt_getmodopt (GMT, 'S', c, "cs", &pos, txt_a, &n_errors) && n_errors == 0) {
switch (txt_a[0]) {
case 'c': /* Set point for geovector legende reference size */
if (Ctrl->S.symbol == 'v') {
GMT_Report (API, GMT_MSG_ERROR, "Option -S : No vector scale point is allowed for Cartesian vector\n");
n_errors++;
}
else { /* Selected geovector */
int n = (txt_a[1]) ? sscanf (&txt_a[1], "%[^/]/%s", txt_b, txt_c) : 0;
switch (n) {
case 0: /* Pick map middle, compute later */
Ctrl->S.smode = 2;
break;
case 1: /* Pick central meridian plus given latitude */
Ctrl->S.smode = 1;
if (gmt_verify_expectations (GMT, GMT_IS_LAT, gmt_scanf (GMT, txt_b, GMT_IS_LAT, &(Ctrl->S.slat)), txt_b)) {
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Option -%c: Failed to parse latitude for +c modifier\n", opt->option);
n_errors++;
}
break;
default: /* Got both lon and lat of scale point */
if (gmt_verify_expectations (GMT, GMT_IS_LON, gmt_scanf (GMT, txt_b, GMT_IS_LON, &(Ctrl->S.slon)), txt_b)) {
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Option -%c: Failed to parse longitude for +c modifier\n", opt->option);
n_errors++;
}
if (gmt_verify_expectations (GMT, GMT_IS_LAT, gmt_scanf (GMT, txt_c, GMT_IS_LAT, &(Ctrl->S.slat)), txt_c)) {
GMT_Report (GMT->parent, GMT_MSG_ERROR, "Option -%c: Failed to parse latitude for +c modifier\n", opt->option);
n_errors++;
}
break;
}
Ctrl->S.origin = true;
}
break;
case 's': /* Gave reference scale value for legend */
Ctrl->S.scale_value = atof (&txt_a[1]);
if (Ctrl->S.scale_value > 0.0) Ctrl->S.reference = true;
break;
default:
n_errors++;
break;
}
}
c[0] = '\0'; /* Chop off all modifiers so range can be determined */
}
len = strlen (opt->arg) - 1; /* Location of expected unit */
j = (opt->arg[0] == 'i') ? 1 : 0; /* j = 1 if -Si was selected */
if (strchr (GMT_DIM_UNITS GMT_LEN_UNITS, (int)opt->arg[len])) /* Recognized plot length or map distance unit character */
Ctrl->S.unit = opt->arg[len];
else if (! (opt->arg[len] == '.' || isdigit ((int)opt->arg[len]))) { /* Not decimal point or digit at the end means trouble */
GMT_Report (API, GMT_MSG_ERROR, "Option -S: Unrecognized length unit %c\n", opt->arg[len]);
n_errors++;
}
if (opt->arg[0] == 'l') { /* Want a fixed length for all vectors (ignore magnitudes) */
Ctrl->S.constant = true;
Ctrl->S.factor = atof (&opt->arg[1]);
if (c == NULL) Ctrl->S.scale_value = Ctrl->S.factor; /* Also sets the ref scale unless already set */
}
else /* Get the length or scale */
Ctrl->S.factor = atof (&opt->arg[j]);
if (j == 1) Ctrl->S.invert = true; /* True for both l and i */
if (c) c[0] = '+'; /* Restore modifier */
break;
case 'T': /* Rescale Cartesian angles */
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 (gmt_getpen (GMT, opt->arg, &Ctrl->W.pen)) {
gmt_pen_syntax (GMT, 'W', NULL, " ", NULL, 0);
n_errors++;
}
if (Ctrl->W.pen.cptmode) Ctrl->W.cpt_effect = true;
break;
case 'Z': /* Azimuths given */
n_errors += gmt_M_repeated_module_option (API, Ctrl->Z.active);
n_errors += gmt_get_no_argument (GMT, opt->arg, opt->option, 0);
Ctrl->A.active = true;
break;
default: /* Report bad options */
n_errors += gmt_default_option_error (GMT, opt);
break;
}
}
if (!Ctrl->W.active) { /* Accept -W default pen for stem */
GMT_Report (API, GMT_MSG_DEBUG, "Option -W: Not given so we accept default pen\n");
Ctrl->W.active = true;
}
if (!Ctrl->G.active && (Ctrl->Q.S.v.status & PSL_VEC_FILL2)) { /* Gave fill via +g instead */
GMT_Report (API, GMT_MSG_DEBUG, "Option -G: Not given but -Q+g was set so we use it to fill head\n");
gmt_M_rgb_copy (Ctrl->G.fill.rgb, Ctrl->Q.S.v.fill.rgb);
Ctrl->G.active = true;
}
gmt_consider_current_cpt (API, &Ctrl->C.active, &(Ctrl->C.file));
n_errors += gmt_M_check_condition (GMT, !GMT->common.J.active, "Must specify a map projection with the -J option\n");
n_errors += gmt_M_check_condition (GMT, GMT->common.R.active[ISET] && (GMT->common.R.inc[GMT_X] <= 0.0 || GMT->common.R.inc[GMT_Y] <= 0.0),
"Option -I: Must specify positive increments\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->S.reference && Ctrl->S.symbol == '=' && !Ctrl->S.origin, "Option -S: For geovector reference length you must specify location or latitude via +c\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->S.factor == 0.0 && !Ctrl->S.constant, "Option -S: Scale must be nonzero\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->S.factor <= 0.0 && Ctrl->S.constant, "Option -Sl: Length must be positive\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->S.constant && Ctrl->Q.S.v.v_norm > 0.0,
"Option -Sl, -Q options: Cannot use -Q..n<size> with -Sl\n");
n_errors += gmt_M_check_condition (GMT, !(Ctrl->G.active || Ctrl->W.active || Ctrl->C.active),
"Must specify at least one of -G, -W, -C\n");
n_errors += gmt_M_check_condition (GMT, n_files != 2, "Must specify two input grid files\n");
n_errors += gmt_M_check_condition (GMT, Ctrl->W.cpt_effect && !Ctrl->C.active, "Option -W: modifier +c only makes sense if -C is given\n");
return (n_errors ? GMT_PARSE_ERROR : GMT_NOERROR);
}
#define bailout(code) {gmt_M_free_options (mode); return (code);}
#define Return(code) {Free_Ctrl (GMT, Ctrl); gmt_end_module (GMT, GMT_cpy); bailout (code);}
EXTERN_MSC int GMT_grdvector (void *V_API, int mode, void *args) {
openmp_int row, col, col_0, row_0, d_col, d_row;
unsigned int justify, k, n_warn[3] = {0, 0, 0}, warn;
int error = 0;
bool Geographic;
uint64_t ij;
double tmp, x, y, plot_x, plot_y, x_off, y_off, f, headpen_width = 0.0;
double x2, y2, wesn[4], value, vec_data_length, vec_azim, scaled_vec_length, c, s, dim[PSL_MAX_DIMS];
struct GMT_GRID *Grid[2] = {NULL, NULL};
struct GMT_PALETTE *P = NULL;
struct GMT_PEN last_headpen;
struct GRDVECTOR_CTRL *Ctrl = NULL;
struct GMT_CTRL *GMT = NULL, *GMT_cpy = NULL; /* General GMT internal parameters */
struct GMT_OPTION *options = NULL;
struct PSL_CTRL *PSL = NULL; /* General PSL internal parameters */
struct GMTAPI_CTRL *API = gmt_get_api_ptr (V_API); /* Cast from void to GMTAPI_CTRL pointer */
/*----------------------- Standard module initialization and parsing ----------------------*/
if (API == NULL) return (GMT_NOT_A_SESSION);
if (mode == GMT_MODULE_PURPOSE) return (usage (API, GMT_MODULE_PURPOSE)); /* Return the purpose of program */
options = GMT_Create_Options (API, mode, args); if (API->error) return (API->error); /* Set or get option list */
if ((error = gmt_report_usage (API, options, 0, usage)) != GMT_NOERROR) bailout (error); /* Give usage if requested */
/* Parse the command-line arguments */
if ((GMT = gmt_init_module (API, THIS_MODULE_LIB, THIS_MODULE_CLASSIC_NAME, THIS_MODULE_KEYS, THIS_MODULE_NEEDS, module_kw, &options, &GMT_cpy)) == NULL) bailout (API->error); /* Save current state */
if (GMT_Parse_Common (API, THIS_MODULE_OPTIONS, options)) Return (API->error);
Ctrl = New_Ctrl (GMT); /* Allocate and initialize a new control structure */
if ((error = parse (GMT, Ctrl, options)) != 0) Return (error);
/*---------------------------- This is the grdvector main code ----------------------------*/
gmt_M_memset (&last_headpen, 1, struct GMT_PEN); /* Initilaize members to zero */
GMT_Report (API, GMT_MSG_INFORMATION, "Processing input grids\n");
d_col = d_row = 1;
col_0 = row_0 = 0;
if (!(strcmp (Ctrl->In.file[0], "=") || strcmp (Ctrl->In.file[1], "="))) {
GMT_Report (API, GMT_MSG_ERROR, "Piping of grid files not supported!\n");
Return (GMT_RUNTIME_ERROR);
}
for (k = 0; k < 2; k++) {
if ((Grid[k] = GMT_Read_Data (API, GMT_IS_GRID, GMT_IS_FILE, GMT_IS_SURFACE, GMT_CONTAINER_ONLY, NULL, Ctrl->In.file[k], NULL)) == NULL) { /* Get header only */
Return (API->error);
}
if ((API->error = gmt_img_sanitycheck (GMT, Grid[k]->header))) { /* Used map projection on a Mercator (cartesian) grid */
Return (API->error);
}
gmt_grd_init (GMT, Grid[k]->header, options, true);
}
if (!gmt_grd_domains_match (GMT, Grid[0], Grid[1], "input component")) {
Return (GMT_RUNTIME_ERROR);
}
/* Determine what wesn to pass to map_setup */
if (!GMT->common.R.active[RSET]) /* -R was not set so we use the grid domain */
gmt_set_R_from_grd (GMT, Grid[0]->header);
if (gmt_map_setup (GMT, GMT->common.R.wesn)) Return (GMT_PROJECTION_ERROR);
/* Determine the wesn to be used to read the grid file */
if (!gmt_grd_setregion (GMT, Grid[0]->header, wesn, BCR_BILINEAR) || !gmt_grd_setregion (GMT, Grid[1]->header, wesn, BCR_BILINEAR)) {
/* No grid to plot; just do empty map and return */
if (GMT_End_IO (API, GMT_IN, 0) != GMT_NOERROR) { /* Disables further data input */
Return (API->error);
}
GMT_Report (API, GMT_MSG_WARNING, "No data within specified region\n");
if ((PSL = gmt_plotinit (GMT, options)) == NULL) Return (GMT_RUNTIME_ERROR);
gmt_plane_perspective (GMT, GMT->current.proj.z_project.view_plane, GMT->current.proj.z_level);
gmt_set_basemap_orders (GMT, GMT_BASEMAP_FRAME_AFTER, GMT_BASEMAP_GRID_AFTER, GMT_BASEMAP_ANNOT_AFTER);
GMT->current.map.frame.order = GMT_BASEMAP_AFTER; /* Move to last order since only calling gmt_map_basemap once */
gmt_plotcanvas (GMT); /* Fill canvas if requested */
gmt_map_basemap (GMT);
gmt_plane_perspective (GMT, -1, 0.0);
gmt_plotend (GMT);
Return (GMT_NOERROR);
}
/* Read data */
for (k = 0; k < 2; k++) if (GMT_Read_Data (API, GMT_IS_GRID, GMT_IS_FILE, GMT_IS_SURFACE, GMT_DATA_ONLY, wesn, Ctrl->In.file[k], Grid[k]) == NULL) { /* Get data */
Return (API->error);
}
if (Ctrl->C.active) {
double v_data_min, v_data_max;
if (Ctrl->A.active) { /* Polar grid, just use min/max of radius grid */
v_data_min = Grid[0]->header->z_min;
v_data_max = Grid[0]->header->z_max;
}
else { /* Find min/max vector lengths from the components */
v_data_min = DBL_MAX; v_data_max = 0.0;
gmt_M_grd_loop (GMT, Grid[GMT_X], row, col, ij) {
vec_data_length = hypot (Grid[GMT_X]->data[ij], Grid[GMT_Y]->data[ij]);
if (vec_data_length < v_data_min) v_data_min = vec_data_length;
if (vec_data_length > v_data_max) v_data_max = vec_data_length;
}
}
if ((P = gmt_get_palette (GMT, Ctrl->C.file, GMT_CPT_OPTIONAL, v_data_min, v_data_max, Ctrl->C.dz)) == NULL) {
Return (API->error);
}
}
Geographic = (gmt_M_is_geographic (GMT, GMT_IN)); /* Will be overridden if c|i|p units for scaling is selected */
if (!Ctrl->S.invert) {
double was = Ctrl->S.factor;
Ctrl->S.factor = 1.0 / Ctrl->S.factor; /* Turn length into a scale */
GMT_Report (API, GMT_MSG_INFORMATION, "Vector scale of %g <data-unit>/%c converts to %g %c/<data-unit>.\n", was, Ctrl->S.unit, Ctrl->S.factor, Ctrl->S.unit);
}
if (!Ctrl->S.reference) Ctrl->S.scale_value = 1.0 / Ctrl->S.factor; /* Default reference if not set */
if (Ctrl->S.smode) { /* Need to set final slon, slat */
if (Ctrl->S.smode == 2)
gmt_xy_to_geo (GMT, &Ctrl->S.slon, &Ctrl->S.slat, 0.5 * GMT->current.map.width, 0.5 * GMT->current.map.height);
else
Ctrl->S.slon = GMT->current.proj.central_meridian;
GMT_Report (API, GMT_MSG_INFORMATION, "Geovector reference length true at the middle of the map, at lon = %g and lat = %g\n", Ctrl->S.slon, Ctrl->S.slat);
}
switch (Ctrl->S.unit) { /* Adjust for possible unit selection */
/* First three choices will give straight vectors scaled from user length to plot lengths */
case 'c':
Ctrl->S.factor *= GMT->session.u2u[GMT_CM][GMT_INCH];
Geographic = false;
break;
case 'i':
Ctrl->S.factor *= GMT->session.u2u[GMT_INCH][GMT_INCH];
Geographic = false;
break;
case 'p':
Ctrl->S.factor *= GMT->session.u2u[GMT_PT][GMT_INCH];
Geographic = false;
break;
/* Remaining choices will give geo vectors scaled from user length to distance lengths [dmsefkMnu] */
case 'd':
Ctrl->S.factor *= GMT->current.proj.KM_PR_DEG;
break;
case 'm':
Ctrl->S.factor *= (GMT->current.proj.KM_PR_DEG / GMT_DEG2MIN_F);
break;
case 's':
Ctrl->S.factor *= (GMT->current.proj.KM_PR_DEG / GMT_DEG2SEC_F);
break;
case 'e':
Ctrl->S.factor *= (1 / METERS_IN_A_KM); /* 1 is "meters in a meter" ... */
break;
case 'f':
Ctrl->S.factor *= (METERS_IN_A_FOOT / METERS_IN_A_KM);
break;
case 'k':
/* Already in km */
break;
case 'M':
Ctrl->S.factor *= (METERS_IN_A_MILE / METERS_IN_A_KM);
break;
case 'n':
Ctrl->S.factor *= (METERS_IN_A_NAUTICAL_MILE / METERS_IN_A_KM);
break;
case 'u':
Ctrl->S.factor *= (METERS_IN_A_SURVEY_FOOT / METERS_IN_A_KM);
break;
default:
GMT_Report (API, GMT_MSG_ERROR, "Bad scale unit %c\n", Ctrl->S.unit);
Return (GMT_RUNTIME_ERROR);
break;
}
if (Geographic) { /* Now that we know this we make sure -T is disabled if given */
if (Ctrl->T.active) { /* This is a mistake */
Ctrl->T.active = false;
GMT_Report (API, GMT_MSG_ERROR, "-T does not apply to geographic grids - ignored\n");
}
GMT_Report (API, GMT_MSG_DEBUG, "Great-circle geo-vectors will be drawn. Scale converting user lengths to km is %g\n", Ctrl->S.factor);
}
else {
GMT_Report (API, GMT_MSG_DEBUG, "Cartesian straight vectors will be drawn\n");
GMT_Report (API, GMT_MSG_DEBUG, "Cartesian straight vectors will be drawn. Scale converting user lengths to inches is %g\n", Ctrl->S.factor);
}
if (Ctrl->Q.active) { /* Prepare vector parameters */
if (Ctrl->Q.S.symbol != GMT_SYMBOL_VECTOR_V4) Ctrl->Q.S.v.v_width = (float)(Ctrl->W.pen.width * GMT->session.u2u[GMT_PT][GMT_INCH]);
gmt_init_vector_param (GMT, &Ctrl->Q.S, true, Ctrl->W.active, &Ctrl->W.pen, Ctrl->G.active, &Ctrl->G.fill);
}
if ((PSL = gmt_plotinit (GMT, options)) == NULL) Return (GMT_RUNTIME_ERROR);
gmt_plane_perspective (GMT, GMT->current.proj.z_project.view_plane, GMT->current.proj.z_level);
gmt_set_basemap_orders (GMT, Ctrl->N.active ? GMT_BASEMAP_FRAME_BEFORE : GMT_BASEMAP_FRAME_AFTER, GMT_BASEMAP_GRID_BEFORE, GMT_BASEMAP_ANNOT_AFTER);
gmt_plotcanvas (GMT); /* Fill canvas if requested */
gmt_map_basemap (GMT);
gmt_setpen (GMT, &Ctrl->W.pen);
if (!Ctrl->C.active) gmt_setfill (GMT, &Ctrl->G.fill, Ctrl->W.active);
if (!Ctrl->N.active) gmt_map_clip_on (GMT, GMT->session.no_rgb, 3);
if (Ctrl->I.mode) { /* Gave multiplier so get actual strides */
GMT->common.R.inc[GMT_X] *= Grid[0]->header->inc[GMT_X];
GMT->common.R.inc[GMT_Y] *= Grid[0]->header->inc[GMT_Y];
}
if (GMT->common.R.inc[GMT_X] != 0.0 && GMT->common.R.inc[GMT_Y] != 0.0) { /* Coarsen the output interval. The new -Idx/dy must be integer multiples of the grid dx/dy */
struct GMT_GRID_HEADER_HIDDEN *HH = gmt_get_H_hidden (Grid[0]->header);
double val = GMT->common.R.inc[GMT_Y] * HH->r_inc[GMT_Y]; /* Should be ~ an integer within 1 ppm */
d_row = urint (val);
if (d_row == 0 || fabs ((d_row - val)/d_row) > GMT_CONV6_LIMIT) {
GMT_Report (API, GMT_MSG_ERROR, "New y grid spacing (%.12lg) is not a multiple of actual grid spacing (%.12g) [within %g]\n", GMT->common.R.inc[GMT_Y], Grid[0]->header->inc[GMT_Y], GMT_CONV6_LIMIT);
Return (GMT_RUNTIME_ERROR);
}
GMT->common.R.inc[GMT_Y] = d_row * Grid[0]->header->inc[GMT_Y]; /* Get exact y-increment in case of slop */
val = GMT->common.R.inc[GMT_X] * HH->r_inc[GMT_X];
d_col = urint (val);
if (d_col == 0 || fabs ((d_col - val)/d_col) > GMT_CONV6_LIMIT) {
GMT_Report (API, GMT_MSG_ERROR, "New x grid spacing (%.12g) is not a multiple of actual grid spacing (%.12g) [within %g]\n", GMT->common.R.inc[GMT_X], Grid[0]->header->inc[GMT_X], GMT_CONV6_LIMIT);
Return (GMT_RUNTIME_ERROR);
}
GMT->common.R.inc[GMT_X] = d_col * Grid[0]->header->inc[GMT_X]; /* Get exact x-increment in case of slop */
/* Determine starting row/col for straddled access */
tmp = ceil (Grid[0]->header->wesn[YHI] / GMT->common.R.inc[GMT_Y]) * GMT->common.R.inc[GMT_Y];
if (tmp > Grid[0]->header->wesn[YHI]) tmp -= GMT->common.R.inc[GMT_Y];
row_0 = urint ((Grid[0]->header->wesn[YHI] - tmp) * HH->r_inc[GMT_Y]);
tmp = floor (Grid[0]->header->wesn[XLO] / GMT->common.R.inc[GMT_X]) * GMT->common.R.inc[GMT_X];
if (tmp < Grid[0]->header->wesn[XLO]) tmp += GMT->common.R.inc[GMT_X];
col_0 = urint ((tmp - Grid[0]->header->wesn[XLO]) * HH->r_inc[GMT_X]);
}
dim[PSL_VEC_HEAD_SHAPE] = Ctrl->Q.S.v.v_shape; /* head shape, type, and status do not change inside the loop */
dim[PSL_VEC_STATUS] = (double)Ctrl->Q.S.v.status;
dim[PSL_VEC_HEAD_TYPE_BEGIN] = (double)Ctrl->Q.S.v.v_kind[0];
dim[PSL_VEC_HEAD_TYPE_END] = (double)Ctrl->Q.S.v.v_kind[1];
if (Ctrl->Q.S.v.status & PSL_VEC_OUTLINE2) { /* Vector head outline pen specified separately */
PSL_defpen (PSL, "PSL_vecheadpen", Ctrl->Q.S.v.pen.width, Ctrl->Q.S.v.pen.style, Ctrl->Q.S.v.pen.offset, Ctrl->Q.S.v.pen.rgb);
headpen_width = Ctrl->Q.S.v.pen.width;
}
else { /* Reset to default pen */
if (Ctrl->W.active) { /* Vector head outline pen default is half that of stem pen */
PSL_defpen (PSL, "PSL_vecheadpen", Ctrl->W.pen.width, Ctrl->W.pen.style, Ctrl->W.pen.offset, Ctrl->W.pen.rgb);
headpen_width = 0.5 * Ctrl->W.pen.width;
}
}
if (Ctrl->W.cpt_effect) { /* Should color apply to pen, fill, or both [fill] */
if ((Ctrl->W.pen.cptmode & 2) == 0 && !Ctrl->G.active) /* Turn off CPT fill */
gmt_M_rgb_copy (Ctrl->G.fill.rgb, GMT->session.no_rgb);
}
if (gmt_M_is_verbose (GMT, GMT_MSG_INFORMATION) || (GMT->common.l.active && !Ctrl->S.reference)) { /* Report or find min/max/mean scaled vector length */
double v_scaled_min = DBL_MAX, v_scaled_max = -DBL_MAX, v_scaled_mean = 0.0;
double v_data_min = DBL_MAX, v_data_max = -DBL_MAX, v_data_mean = 0.0;
uint64_t v_n = 0;
char v_unit[GMT_LEN8] = {""};
for (row = row_0; row < (openmp_int)Grid[1]->header->n_rows; row += d_row) {
y = gmt_M_grd_row_to_y (GMT, row, Grid[0]->header); /* Latitude OR y OR radius */
for (col = col_0; col < (openmp_int)Grid[1]->header->n_columns; col += d_col) {
ij = gmt_M_ijp (Grid[0]->header, row, col);
if (gmt_M_is_fnan (Grid[0]->data[ij]) || gmt_M_is_fnan (Grid[1]->data[ij])) continue; /* Cannot plot NaN-vectors */
x = gmt_M_grd_col_to_x (GMT, col, Grid[0]->header); /* Longitude OR x OR theta [or azimuth] */
if (!Ctrl->N.active) { /* Throw out vectors whose node is outside */
gmt_map_outside (GMT, x, y);
if (abs (GMT->current.map.this_x_status) > 1 || abs (GMT->current.map.this_y_status) > 1) continue;
}
if (Ctrl->A.active) { /* Got r,theta grids */
vec_data_length = Grid[0]->data[ij];
if (vec_data_length == 0.0) continue; /* No length = no plotting */
if (vec_data_length < 0.0) /* Interpret negative lengths to mean pointing in opposite direction 180-degrees off */
vec_data_length = -vec_data_length;
}
else { /* Cartesian component grids: Convert to polar form of radius, theta */
vec_data_length = hypot (Grid[GMT_X]->data[ij], Grid[GMT_Y]->data[ij]);
if (vec_data_length == 0.0) continue; /* No length = no plotting */
}
scaled_vec_length = (Ctrl->S.constant) ? Ctrl->S.factor : vec_data_length * Ctrl->S.factor;
/* scaled_vec_length is now in inches (Cartesian) or km (Geographic) */
if (vec_data_length < v_data_min) v_data_min = vec_data_length;
if (vec_data_length > v_data_max) v_data_max = vec_data_length;
v_data_mean += vec_data_length;
if (scaled_vec_length < v_scaled_min) v_scaled_min = scaled_vec_length;
if (scaled_vec_length > v_scaled_max) v_scaled_max = scaled_vec_length;
v_scaled_mean += scaled_vec_length;
v_n++;
}
}
if (v_n) { /* Compute the means */
v_data_mean /= v_n;
v_scaled_mean /= v_n;
}
if (Geographic) /* Since regardless of unit chosen, we end up with a length in km */
sprintf (v_unit, "km");
else { /* Report length in selected unit and scale results to match */
strcpy (v_unit, API->GMT->session.unit_name[API->GMT->current.setting.proj_length_unit]);
v_scaled_min *= GMT->session.u2u[GMT_INCH][GMT->current.setting.proj_length_unit];
v_scaled_max *= GMT->session.u2u[GMT_INCH][GMT->current.setting.proj_length_unit];
v_scaled_mean *= GMT->session.u2u[GMT_INCH][GMT->current.setting.proj_length_unit];
}
GMT_Report (API, GMT_MSG_INFORMATION, "Minimum length of data vector (user unit) : %g\n", v_data_min);
GMT_Report (API, GMT_MSG_INFORMATION, "Maximum length of data vector (user unit) : %g\n", v_data_max);
GMT_Report (API, GMT_MSG_INFORMATION, "Mean length of the data vector (user unit) : %g\n", v_data_mean);
if (!Ctrl->S.constant) { /* No point reporting the mean of n identical vectors */
GMT_Report (API, GMT_MSG_INFORMATION, "Minimum length of scaled vector in %4s : %g\n", v_unit, v_scaled_min);
GMT_Report (API, GMT_MSG_INFORMATION, "Maximum length of scaled vector in %4s : %g\n", v_unit, v_scaled_max);
GMT_Report (API, GMT_MSG_INFORMATION, "Mean length of the scaled vector in %4s : %g\n", v_unit, v_scaled_mean);
}
}
PSL_command (GMT->PSL, "V\n");
if (GMT->common.l.active) { /* Do auto-legend */
char was = Ctrl->Q.S.symbol;
Ctrl->Q.S.symbol = 'v'; /* Even geovectors are drawn as Cartesian in the legend */
if (Ctrl->S.symbol == 'v') /* This gives vector length in inches */
scaled_vec_length = Ctrl->S.scale_value * Ctrl->S.factor;
else { /* Here we get geovector km length which will need to be converted to plot length in inches */
double scale1 = gmt_inch_to_degree_scale (GMT, Ctrl->S.slon, Ctrl->S.slat, 0.0); /* Get scale in two orthogonal directions */
double scale2 = gmt_inch_to_degree_scale (GMT, Ctrl->S.slon, Ctrl->S.slat, 90.0);
double scale = 0.5 * (scale1 + scale2); /* Use the mean scale */
scaled_vec_length = Ctrl->S.scale_value * Ctrl->S.factor; /* This is now in km */
scaled_vec_length /= (float)GMT->current.proj.DIST_KM_PR_DEG; /* Convert km to degrees */
scaled_vec_length /= scale; /* Now in inches suitable for reference vector in legend */
}
GMT->common.l.item.size = scaled_vec_length;
gmt_add_legend_item (API, &Ctrl->Q.S, Ctrl->G.active, &(Ctrl->G.fill), Ctrl->W.active, &(Ctrl->W.pen), &(GMT->common.l.item), NULL);
Ctrl->Q.S.symbol = was; /* Restore to original type */
}
for (row = row_0; row < (openmp_int)Grid[1]->header->n_rows; row += d_row) {
y = gmt_M_grd_row_to_y (GMT, row, Grid[0]->header); /* Latitude OR y OR radius */
for (col = col_0; col < (openmp_int)Grid[1]->header->n_columns; col += d_col) {
ij = gmt_M_ijp (Grid[0]->header, row, col);
if (gmt_M_is_fnan (Grid[0]->data[ij]) || gmt_M_is_fnan (Grid[1]->data[ij])) continue; /* Cannot plot NaN-vectors */
x = gmt_M_grd_col_to_x (GMT, col, Grid[0]->header); /* Longitude OR x OR theta [or azimuth] */
if (!Ctrl->N.active) { /* Throw out vectors whose node is outside */
gmt_map_outside (GMT, x, y);
if (abs (GMT->current.map.this_x_status) > 1 || abs (GMT->current.map.this_y_status) > 1) continue;
}
if (Ctrl->A.active) { /* Got r,theta grids */
vec_data_length = Grid[0]->data[ij];
if (vec_data_length == 0.0) continue; /* No length = no plotting */
vec_azim = Grid[1]->data[ij];
value = vec_data_length;
if (vec_data_length < 0.0) { /* Interpret negative lengths to mean pointing in opposite direction 180-degrees off */
vec_data_length = -vec_data_length;
vec_azim += 180.0;
}
if (!Ctrl->Z.active) vec_azim = 90.0 - vec_azim; /* Convert theta to azimuth */
}
else { /* Cartesian component grids: Convert to polar form of radius, theta */
vec_data_length = hypot (Grid[GMT_X]->data[ij], Grid[GMT_Y]->data[ij]);
if (vec_data_length == 0.0) continue; /* No length = no plotting */
vec_azim = 90.0 - atan2d (Grid[GMT_Y]->data[ij], Grid[GMT_X]->data[ij]); /* Convert dy,dx to azimuth */
value = vec_data_length;
}
if (Ctrl->C.active) { /* Get color based on the vector length */
gmt_get_fill_from_z (GMT, P, value, &Ctrl->G.fill);
}
if (Ctrl->W.cpt_effect) { /* Should color apply to pen, fill, or both [fill] */
if (Ctrl->W.pen.cptmode & 1) { /* Change pen color via CPT */
gmt_M_rgb_copy (Ctrl->W.pen.rgb, Ctrl->G.fill.rgb);
if (!gmt_M_same_pen (Ctrl->W.pen, last_headpen)) { /* Since color may have changed */
PSL_defpen (PSL, "PSL_vecheadpen", Ctrl->W.pen.width, Ctrl->W.pen.style, Ctrl->W.pen.offset, Ctrl->W.pen.rgb);
last_headpen = Ctrl->W.pen;
}
}
}
if (Ctrl->C.active) { /* Update pen and fill color settings */
if (!Ctrl->Q.active) /* Must update stick pen */
gmt_M_rgb_copy (Ctrl->W.pen.rgb, Ctrl->G.fill.rgb);
gmt_setpen (GMT, &Ctrl->W.pen);
if (Ctrl->Q.active) gmt_setfill (GMT, &Ctrl->G.fill, Ctrl->W.active);
gmt_init_vector_param (GMT, &Ctrl->Q.S, true, Ctrl->W.active, &Ctrl->W.pen, true, &Ctrl->G.fill);
}
scaled_vec_length = (Ctrl->S.constant) ? Ctrl->S.factor : vec_data_length * Ctrl->S.factor;
/* scaled_vec_length is now in inches (Cartesian) or km (Geographic) */
if (Geographic) { /* Draw great-circle geo-vectors */
Ctrl->Q.S.v.value = vec_data_length;
warn = gmt_geo_vector (GMT, x, y, vec_azim, scaled_vec_length, &Ctrl->W.pen, &Ctrl->Q.S);
n_warn[warn]++;
}
else { /* Draw straight Cartesian vectors */
gmt_geo_to_xy (GMT, x, y, &plot_x, &plot_y);
if (gmt_M_is_geographic (GMT, GMT_IN)) /* Must align azimuth with local north */
vec_azim = 90.0 - gmt_azim_to_angle (GMT, x, y, 0.1, vec_azim);
if (Ctrl->T.active) /* Deal with negative scales in x and/or y which affect the azimuths */
gmt_flip_azim_d (GMT, &vec_azim);
vec_azim = 90.0 - vec_azim; /* Transform azimuths to plot angle */
if (GMT->current.proj.projection_GMT == GMT_POLAR) { /* Must rotate azimuth since circular projection */
double x_orient;
x_orient = (GMT->current.proj.got_azimuths) ? -(x + GMT->current.proj.p_base_angle) : x - GMT->current.proj.p_base_angle - 90.0;
vec_azim += x_orient;
}
vec_azim *= D2R; /* vec_azim is now in radians */
sincos (vec_azim, &s, &c);
x2 = plot_x + scaled_vec_length * c;
y2 = plot_y + scaled_vec_length * s;
justify = PSL_vec_justify (Ctrl->Q.S.v.status); /* Return justification as 0-2 */
if (justify) { /* Justify vector at center, or tip [beginning] */
x_off = justify * 0.5 * (x2 - plot_x); y_off = justify * 0.5 * (y2 - plot_y);
plot_x -= x_off; plot_y -= y_off;
x2 -= x_off; y2 -= y_off;
}
n_warn[0]++;
if (!Ctrl->Q.active) { /* Just a vector stem: line segment */
PSL_plotsegment (PSL, plot_x, plot_y, x2, y2);
continue;
}
/* Must plot a vector head */
dim[PSL_VEC_XTIP] = x2;
dim[PSL_VEC_YTIP] = y2;
dim[PSL_VEC_TAIL_WIDTH] = Ctrl->Q.S.v.v_width;
dim[PSL_VEC_HEAD_LENGTH] = Ctrl->Q.S.v.h_length;
dim[PSL_VEC_HEAD_WIDTH] = Ctrl->Q.S.v.h_width;
dim[PSL_VEC_HEAD_PENWIDTH] = headpen_width; /* Possibly shrunk head pen width */
f = gmt_get_vector_shrinking (GMT, &(Ctrl->Q.S.v), vec_data_length, scaled_vec_length); /* Vector attribute shrinking factor or 1 */
if (f < 1.0) { /* Scale arrow attributes down with length */
for (k = 2; k <= 4; k++) dim[k] *= f;
dim[PSL_VEC_HEAD_PENWIDTH] *= f;
}
if (Ctrl->Q.S.symbol == GMT_SYMBOL_VECTOR_V4) { /* Do the deprecated GMT4 vector polygon instead */
int v4_outline = Ctrl->W.active;
double *this_rgb = NULL;
if (Ctrl->G.active || Ctrl->C.active)
this_rgb = Ctrl->G.fill.rgb;
else
this_rgb = GMT->session.no_rgb;
if (v4_outline) gmt_setpen (GMT, &Ctrl->W.pen);
if (Ctrl->Q.S.v.status & PSL_VEC_BEGIN) v4_outline += 8; /* Double-headed */
psl_vector_v4 (PSL, plot_x, plot_y, dim, this_rgb, v4_outline);
}
else
PSL_plotsymbol (PSL, plot_x, plot_y, dim, PSL_VECTOR);
}
}
}
PSL_command (GMT->PSL, "U\n");
PSL->current.linewidth = 0.0; /* Since we changed things under clip; this will force it to be set next */
if (!Ctrl->N.active) gmt_map_clip_off (GMT);
gmt_map_basemap (GMT);
gmt_plane_perspective (GMT, -1, 0.0);
gmt_plotend (GMT);
GMT_Report (API, GMT_MSG_INFORMATION, "%d vectors plotted successfully\n", n_warn[0]);
if (n_warn[1]) GMT_Report (API, GMT_MSG_INFORMATION, "%d vector heads had length exceeding the vector length and were skipped. Consider the +n<norm> modifier to -Q\n", n_warn[1]);
if (n_warn[2]) GMT_Report (API, GMT_MSG_INFORMATION, "%d vector heads had to be scaled more than implied by +n<norm> since they were still too long. Consider changing the +n<norm> modifier to -Q\n", n_warn[2]);
Return (GMT_NOERROR);
}