-
Notifications
You must be signed in to change notification settings - Fork 5
/
simplegrid.m
3144 lines (3059 loc) · 115 KB
/
simplegrid.m
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
classdef simplegrid < simpletimeseries
%static
properties(Constant)
%default value of some internal parameters
parameter_list={...
'sp_tol', 1e-8, @num.isscalar;...
'sp_units', 'deg', @ischar;... %TODO: need to convert non-deg units at input/output (internally deg are expected)
'centered', false, @islogical;...
};
%These parameter are considered when checking if two data sets are
%compatible (and only these).
%NOTE: edit this if you add a new parameter (if relevant)
compatible_parameter_list={'sp_units'};
%catchment list: name, lat, lon
catchment_list={...
'Alaska', [ 56 65],[-151 -129];...
'Columbia', [ 38 50],[-125 -110];...
'Mississippi', [ 29 44],[-101 -80];...
'Amazon', [ -17, 3],[ -76 -47];...
'Orinoco' [ 3, 12],[ -72 -59];...
'La Plata', [ -34, -19],[ -65 -50];...
'Greenland', [ 60 85],[ -60 -37];...
'W Sub-Sahara', [ 5 15],[ -15 -1];...
'E Sub-Sahara', [ 1 13],[ 8 35];...
'Congo Zambezi', [ -23 -3],[ 14 38];...
'W Antarctica', [ -80 -70],[-140 -85];...
'E Antarctica', [ -80 -68],[ 80 130];...
'N Australia', [ -24 -10],[ 124 145];...
'Ganges-Brahm', [ 15 30],[ 72 89];...
'Indochina', [ 12 29],[ 93 105];...
'Siberia', [ 57 72],[ 68 109];...
'Volga', [ 53 61],[ 34 56];...
'Danube', [ 43 48],[ 13 28];...
};
% 'Great Lakes', [ 50 67],[-100 -70];...
% 'Severny Island',[ 66 78],[ 38 67];...
end
%read only
properties(SetAccess=private)
loni
lati
end
properties(GetAccess=public,SetAccess=public)
sp_tol
sp_units
centered
end
%calculated only when asked for
properties(Dependent)
lat
lon,lon180,lon360
map
vecmat
list
flatlist
matrix
latSpacing
lonSpacing
latLimit
lonLimit
end
methods(Static)
function out=parameters(varargin)
persistent v
if isempty(v); v=varargs(simplegrid.parameter_list); end
out=v.picker(varargin{:});
end
%% spacing
function out=spacing(in)
out= min(diff(unique(in(:),'sorted')));
if isempty(out); out=1; end
end
function out=getSpacing(lon,lat)
out = [ simplegrid.spacing(lon) simplegrid.spacing(lat) ];
end
function out=spacing_size(lon,lat,radius)
if ~exist('radius','var') || isempty(radius)
radius=gravity.parameters('Rm');
end
out=deg2rad(simplegrid.getSpacing(lon,lat))*radius;
end
function out=sh_lmax(lon,lat)
%NOTICE: this function is the same as:
% floor(gravity.hwl2deg(simplegrid.spacing_size(lon,lat)))
out = min([numel(lat)-1,floor((numel(lon)-1)/2)]);
end
function out=lat_spacing_valid(spacing)
out= isnumeric(spacing) && isscalar(spacing) && mod(180,spacing)==0;
end
function out=lon_spacing_valid(spacing)
out= isnumeric(spacing) && isscalar(spacing) && mod(360,spacing)==0;
end
%% lon and lat handlers
function out=getLimits(lon,lat)
lon=simplegrid.setlon360(lon);
out = [ min(lon(:)) max(lon(:)) min(lat(:)) max(lat(:)) ];
%some sanity
assert(~(any(lon < 0) || any(lon > 360)),'Ilegal longitude domain. Debug needed!')
assert(~(any(lat < -90) || any(lat > 90)),'Ilegal latitude domain. Debug needed!')
end
function out=delta(l,u,n)
out=(u-l)/(n-1);
end
function out=lon_default(n)
%NOTICE: this used to be simply linspace(0,360,n) but that may introduce NaN at 360
%NOTICE: the use of delta may look redundant but linspace is not very accurate and introduces small variations
out=0:simplegrid.delta(0,360,n):360;
%NOTICE: there is particular requirement for having (or not) longitude at degree 360 (degree 0 should be there, if relevant);
% wrap the code under obj.{add|del}360lon for those cases when either is needed
% out=out(1:end-1);
end
function out=lat_default(n)
%NOTICE: this looks redundant but linspace is not very accurate and introduces small variations
out=transpose(-90:simplegrid.delta(-90,90,n):90);
end
function out=lat_stepped(delta_deg)
%NOTICE: this is the same as: out=simplegrid.lat_default((180+delta_deg)/delta_deg);
out=-90:delta_deg:90;
assert(out(end)==90,'Input delta_deg is ilegal because it does not produce a complete latitude domain')
end
function out=lon_stepped(delta_deg)
%NOTICE: this is the same as: out=simplegrid.lon_default((360+delta_deg)/delta_deg);
out=0:delta_deg:360;
assert(out(end)==360,'Input delta_deg is ilegal because it does not produce a complete latitude domain')
end
function out=lat_stepped_length(delta_deg)
if isfinite(delta_deg)
if delta_deg==0
out=inf;
else
out=(180+delta_deg)/delta_deg;
end
else
out=0;
end
end
function out=lon_stepped_length(delta_deg)
if isfinite(delta_deg)
if delta_deg==0
out=inf;
else
out=(360+delta_deg)/delta_deg;
end
else
out=0;
end
end
function out=setlon360(lon)
out=wrapTo360(lon);
end
function out=islon360complete(lon)
lon360=simplegrid.setlon360(lon);
sp_tol=simplegrid.parameters('sp_tol')^2;
out = ...
(lon360(end)-360 )^2<sp_tol && ... %check if lon 360 is already there
(lon360(1) )^2<sp_tol && ... %check if current spatial domain includes longitude 0
(lon360(end-1)+simplegrid.spacing(lon)-360)^2<sp_tol; %check if current spatial domain should have longitude 360
end
function [idx_a,idx_b,out]=common(a,b)
%a(idx_a)=b(idx_b)=out and is the common entries between a and b
[ag,bg]=meshgrid(a,b);
[idx_b,idx_a]=find((ag-bg).^2<simplegrid.parameters('sp_tol')^2);
if nargout>2; out=a(idx_a); end
end
%% vector/matrix representation (lat, lon and t are vectors, map is a 3D matrix with time changing along the right-most dim)
function out=vecmat_valid(vecmat)
try
simplegrid.vecmat_check(vecmat);
out=true;
catch
out=false;
end
end
function out=vecmat_check(vecmat)
%easier names
type='vectmat';
%need structure
if ~isstruct( vecmat); error(['invalid ',type,': not a structure.']); end
%need to check lon/lat fields existence now, before determining if they are uniform
if ~isfield( vecmat,'lon'); error(['invalid ',type,': field ''lon'' is missing.']);end
if ~isfield( vecmat,'lat'); error(['invalid ',type,': field ''lat'' is missing.']);end
if ~isempty(vecmat.lon) && ~isempty(vecmat.lat)
% Calculate the spacing and limits
GridLimits = simplegrid.getLimits( vecmat.lon(:),vecmat.lat(:));
GridSpacing = simplegrid.getSpacing(vecmat.lon(:),vecmat.lat(:));
% build equal-spaced lon and lat
out=struct(...
'lon', GridLimits(1):GridSpacing(1):GridLimits(2),...
'lat',transpose(GridLimits(3):GridSpacing(2):GridLimits(4))...
);
% sanity
if numel(out.lon) ~= numel(vecmat.lon) || any( (out.lon(:)-vecmat.lon(:)).^2>simplegrid.parameters('sp_tol')^2 )
error(['invalid ',type,': field ''lon'' is not an uniform domain.'])
end
if numel(out.lat) ~= numel(vecmat.lat) || any( (out.lat(:)-vecmat.lat(:)).^2>simplegrid.parameters('sp_tol')^2 )
error(['invalid ',type,': field ''lat'' is not an uniform domain.'])
end
else
out=struct('lon',[],'lat',[]);
end
%map
if ~isfield( vecmat,'map'); error(['invalid ',type,': field ''map'' is missing.']);end
if ~isempty( vecmat.map) && ...
~isnumeric( vecmat.map); error(['invalid ',type,': field ''map'' is not numeric.']);end
%lon
if ~isempty( vecmat.lon)
if ~isrow( vecmat.lon); error(['invalid ',type,': field ''lon'' is not a row vector.']);end
if ~isnumeric(vecmat.lon); error(['invalid ',type,': field ''lon'' is not numeric.']);end
if ~isempty( vecmat.map) && ...
numel( vecmat.lon) ~= ...
size( vecmat.map,2); error(['invalid ',type,': field ''lon'' has different nr of elements than rows of ''map''.']);end %#ok<ALIGN>
end
%lat
if ~isempty( vecmat.lat)
if ~iscolumn( vecmat.lat); error(['invalid ',type,': field ''lat'' is not a column vector.']);end
if ~isnumeric(vecmat.lat); error(['invalid ',type,': field ''lat'' is not numeric.']);end
if ~isempty( vecmat.map) && ...
numel( vecmat.lat) ~= ...
size( vecmat.map,1); error(['invalid ',type,': field ''lat'' has different nr of elements than columns of ''map''.']);end %#ok<ALIGN>
end
%t
if ~isfield( vecmat,'t'); error(['invalid ',type,': field ''t'' is missing.']);end
if ~isvector( vecmat.t ); error(['invalid ',type,': field ''t'' is not a vector.']);end
if ~isdatetime(vecmat.t ) && ...
~isnumeric( vecmat.t ); error(['invalid ',type,': field ''t'' is not datetime or numeric.']);end
if ~isempty( vecmat.map) && ...
numel( vecmat.t )~=...
size( vecmat.map,3); error(['invalid ',type,': field ''t'' has different nr of elements than pages of ''map''.']);end %#ok<ALIGN>
end
function out=vecmat_size(vecmat)
out=size(vecmat.map);
end
function vectmat=vecmat_init(t,map,lon,lat)
vectmat=struct('t',t,'lon',simplegrid.setlon360(lon),'lat',lat,'map',map);
end
%% list representation (lat, lon and t are vectors, map is a 2D matrix, with time changing along the rows)
function out=list_valid(list)
try
simplegrid.list_check(list);
out=true;
catch
out=false;
end
end
function [out,idx]=list_check(list)
%easier names
type='list';
%need structure
if ~isstruct( list); error(['invalid ',type,': not a structure.']); end
%need to check lon/lat fields existence now, before determining if they are uniform
if ~isfield( list,'lon'); error(['invalid ',type,': field ''lon'' is missing.']);end
if ~isfield( list,'lat'); error(['invalid ',type,': field ''lat'' is missing.']);end
if ~isempty(list.lon) && ~isempty(list.lat)
% Calculate the spacing and limits
GridLimits = simplegrid.getLimits( list.lon(:),list.lat(:));
GridSpacing = simplegrid.getSpacing(list.lon(:),list.lat(:));
% build equal-spaced lon and lat
out=struct(...
'lon', GridLimits(1):GridSpacing(1):GridLimits(2),...
'lat',(GridLimits(3):GridSpacing(2):GridLimits(4))'...
);
% get indexes
%NOTICE: this is slow
idx.lon=nan(1,numel(list.lon));
for i=1:numel(out.lon)
idx.lon( (out.lon(i)-list.lon).^2<simplegrid.parameters('sp_tol')^2 )=i;
end
idx.lat=nan(1,numel(list.lat));
for i=1:numel(out.lat)
idx.lat( (out.lat(i)-list.lat).^2<simplegrid.parameters('sp_tol')^2 )=i;
end
if any(isnan(idx.lat)); error(['invalid ',type,': field ''lat'' is not an uniform domain.']);end
if any(isnan(idx.lon)); error(['invalid ',type,': field ''lon'' is not an uniform domain.']);end
else
idx=struct('lon',[],'lat',[]);
out=struct('lon',[],'lat',[]);
end
%map
if ~isfield( list,'map'); error(['invalid ',type,': field ''map'' is missing.']);end
if ~isempty(list.map)
if ~isnumeric(list.map); error(['invalid ',type,': field ''map'' is not numeric.']);end
if ~ismatrix( list.map); error(['invalid ',type,': field ''map'' is not a matrix.']);end
end
%lon
if ~isempty( list.lon)
if ~isrow( list.lon); error(['invalid ',type,': field ''lon'' is not a row vector.']);end
if ~isnumeric(list.lon); error(['invalid ',type,': field ''lon'' is not numeric.']);end
if ~isempty( list.map) && ...
numel( list.lon) ~= ...
size( list.map,2); error(['invalid ',type,': field ''lon'' has different elements than columns of ''map''.']);end %#ok<ALIGN>
end
%lat
if ~isempty( list.lat)
if ~isrow( list.lat); error(['invalid ',type,': field ''lat'' is not a row vector.']);end
if ~isnumeric(list.lat); error(['invalid ',type,': field ''lat'' is not numeric.']);end
if ~isempty( list.map) && ...
numel( list.lat) ~= ...
size( list.map,2); error(['invalid ',type,': field ''lat'' has different sizes than columns of ''map''.']);end %#ok<ALIGN>
end
%t
if ~isfield( list,'t'); error(['invalid ',type,': field ''t'' is missing.']);end
if ~isvector( list.t); error(['invalid ',type,': field ''t'' is not a vector.']);end
if ~isdatetime(list.t ) && ...
~isnumeric( list.t ); error(['invalid ',type,': field ''t'' is not datetime or numeric.']);end
if ~isempty( list.map) && ...
numel( list.t) ~= ...
size( list.map,1); error(['invalid ',type,': field ''t'' has different nr of elements than rows of ''map''.']);end %#ok<ALIGN>
end
function out=list_size(list)
out = [ numel(unique(list.lon(:))) numel(unique(list.lat(:))) numel(list.t) ];
end
function list=list_init(t,map,lon,lat)
list=struct('t',t,'lon',simplegrid.setlon360(lon),'lat',lat,'map',map);
end
%% flatlist representation (lat, lon, t and map are vectors, all have the same length)
function out=flatlist_valid(flatlist)
try
simplegrid.flatlist_check(flatlist);
out=true;
catch
out=false;
end
end
function [out,idx]=flatlist_check(flatlist)
%easier names
type='flatlist';
%need structure
if ~isstruct( flatlist); error(['invalid ',type,': not a structure.']); end
%need to check lon/lat fields existence now, before determining if they are uniform
if ~isfield( flatlist,'lon'); error(['invalid ',type,': field ''lon'' is missing.']);end
if ~isfield( flatlist,'lat'); error(['invalid ',type,': field ''lat'' is missing.']);end
if ~isempty(flatlist.lon) && ~isempty(flatlist.lat)
% Calculate the spacing and limits
GridLimits = simplegrid.getLimits( flatlist.lon(:),flatlist.lat(:));
GridSpacing = simplegrid.getSpacing(flatlist.lon(:),flatlist.lat(:));
% build equal-spaced lon and lat
out=struct(...
'lon', GridLimits(1):GridSpacing(1):GridLimits(2),...
'lat',(GridLimits(3):GridSpacing(2):GridLimits(4))',...
't', unique(flatlist.t,'sorted')...
);
% get indexes
%NOTICE: this is slow
idx.lon=nan(1,numel(flatlist.lon));
for i=1:numel(out.lon)
idx.lon( (out.lon(i)-flatlist.lon).^2<simplegrid.parameters('sp_tol')^2 )=i;
end
if any(isnan(idx.lon)); error(['invalid ',type,': field ''lon'' is not an uniform domain.']);end
idx.lat=nan(1,numel(flatlist.lat));
for i=1:numel(out.lat)
idx.lat( (out.lat(i)-flatlist.lat).^2<simplegrid.parameters('sp_tol')^2 )=i;
end
if any(isnan(idx.lat)); error(['invalid ',type,': field ''lat'' is not an uniform domain.']);end
idx.t=nan(1,numel(flatlist.t));
fltdn=datenum(flatlist.t);
for i=1:numel(out.t)
idx.t( (datenum(out.t(i))-fltdn).^2<simplegrid.parameters('sp_tol')^2 )=i;
end
if any(isnan(idx.t)); error(['invalid ',type,': field ''t'' contains NaNs, debug needed.']);end
else
idx=struct('lon',[],'lat',[],'t',[]);
out=struct('lon',[],'lat',[],'t',[]);
end
%map
if ~isfield( flatlist,'map'); error(['invalid ',type,': field ''map'' is missing.']);end
if ~isempty(flatlist.map)
if ~isnumeric(flatlist.map); error(['invalid ',type,': field ''map'' is not numeric.']);end
if ~iscolumn( flatlist.map); error(['invalid ',type,': field ''map'' is not a column vector.']);end
end
%lon
if ~isempty( flatlist.lon)
if ~iscolumn( flatlist.lon); error(['invalid ',type,': field ''lon'' is not a column vector.']);end
if ~isnumeric(flatlist.lon); error(['invalid ',type,': field ''lon'' is not numeric.']);end
if ~isempty( flatlist.map) && ...
numel( flatlist.lon) ~= ...
numel( flatlist.map); error(['invalid ',type,': field ''lon'' has different length than ''map''.']);end %#ok<ALIGN>
end
%lat
if ~isempty( flatlist.lat)
if ~iscolumn( flatlist.lat); error(['invalid ',type,': field ''lat'' is not a iscolumn vector.']);end
if ~isnumeric(flatlist.lat); error(['invalid ',type,': field ''lat'' is not numeric.']);end
if ~isempty( flatlist.map) && ...
numel( flatlist.lat) ~= ...
numel( flatlist.map); error(['invalid ',type,': field ''lat'' has different length than ''map''.']);end %#ok<ALIGN>
end
%t
if ~isfield( flatlist,'t'); error(['invalid ',type,': field ''t'' is missing.']);end
if ~isvector( flatlist.t); error(['invalid ',type,': field ''t'' is not a vector.']);end
if ~isdatetime(flatlist.t ) && ...
~isnumeric( flatlist.t ); error(['invalid ',type,': field ''t'' is not datetime or numeric.']);end
if ~isempty( flatlist.map) && ...
numel( flatlist.t) ~= ...
numel( flatlist.map); error(['invalid ',type,': field ''t'' has different length than ''map''.']);end %#ok<ALIGN>
end
function out=flatlist_size(list)
out = [ numel(unique(list.lon(:))) numel(unique(list.lat(:))) numel(unique(list.t)) ];
end
function list=flatlist_init(t,map,lon,lat)
list=struct('t',t,'lon',simplegrid.setlon360(lon),'lat',lat,'map',map);
end
%% matrix representation (lat and lon are 2D matrices, map is a 3D matrix with time changing along the right-most dim)
function out=matrix_valid(matrix)
try
simplegrid.matrix_check(matrix);
out=true;
catch
out=false;
end
end
function out=matrix_check(matrix)
%easier names
type='matrix';
%need structure
if ~isstruct( matrix); error(['invalid ',type,': not a structure.']); end
%need to check lon/lat fields existence now, before determining if they are uniform
if ~isfield( matrix,'lon'); error(['invalid ',type,': field ''lon'' is missing.']);end
if ~isfield( matrix,'lat'); error(['invalid ',type,': field ''lat'' is missing.']);end
if ~isempty(matrix.lon) && ~isempty(matrix.lat)
% Calculate the spacing and limits
GridLimits = simplegrid.getLimits( matrix.lon(:),matrix.lat(:));
GridSpacing = simplegrid.getSpacing(matrix.lon(:),matrix.lat(:));
% build equal-spaced lon and lat
out=struct(...
'lon', GridLimits(1):GridSpacing(1):GridLimits(2),...
'lat',transpose(GridLimits(3):GridSpacing(2):GridLimits(4))...
);
%build meshed lon and lat
[lon_m,lat_m]=meshgrid(out.lon,out.lat);
% sanity
if numel(lon_m) ~= numel(matrix.lon) || any( (lon_m(:)-matrix.lon(:)).^2>simplegrid.parameters('sp_tol')^2 )
error(['invalid ',type,': field ''lon'' is not an uniform domain.'])
end
if numel(lat_m) ~= numel(matrix.lat) || any( (lat_m(:)-matrix.lat(:)).^2>simplegrid.parameters('sp_tol')^2 )
error(['invalid ',type,': field ''lat'' is not an uniform domain.'])
end
else
out=struct('lon',[],'lat',[]);
end
%map
if ~isfield( matrix,'map'); error(['invalid ',type,': field ''map'' is missing.']);end
if ~isempty( matrix.map) && ...
~isnumeric(matrix.map); error(['invalid ',type,': field ''map'' is not numeric.']);end
%lon
if ~isfield( matrix,'lon'); error(['invalid ',type,': field ''lon'' is missing.']);end
if ~isempty( matrix.lon)
if ~ismatrix( matrix.lon); error(['invalid ',type,': field ''lon'' is not a matrix.']);end
if ~isnumeric(matrix.lon); error(['invalid ',type,': field ''lon'' is not numeric.']);end
if ~isempty( matrix.map) && ...
any(size( matrix.lon) ~= ...
size( matrix.map(:,:,1))) %#ok<ALIGN>
error(['invalid ',type,': field ''lon'' has different sizes than rows and columns of ''map''.']);end
end
%lat
if ~isfield( matrix,'lat'); error(['invalid ',type,': field ''lat'' is missing.']);end
if ~isempty( matrix.lat)
if ~ismatrix( matrix.lat); error(['invalid ',type,': field ''lat'' is not a matrix.']);end
if ~isnumeric(matrix.lat); error(['invalid ',type,': field ''lat'' is not numeric.']);end
if ~isempty( matrix.map) && ...
any(size( matrix.lat) ~= ...
size( matrix.map(:,:,1))) %#ok<ALIGN>
error(['invalid ',type,': field ''lat'' has different sizes than rows and columns of ''map''.']);end
end
%t
if ~isfield( matrix,'t' ); error(['invalid ',type,': field ''t'' is missing.']);end
if ~isvector( matrix.t ); error(['invalid ',type,': field ''t'' is not a vector.']);end
if ~isdatetime(matrix.t ) && ...
~isnumeric( matrix.t ); error(['invalid ',type,': field ''t'' is not datetime or numeric.']);end
if ~isempty( matrix.map) && ...
numel( matrix.t ) ~= ...
size( matrix.map,3) %#ok<ALIGN>
error(['invalid ',type,': field ''t'' has different nr of elements than pages of ''map''.']);end
end
function out=matrix_size(matrix)
out=size(matrix.map);
end
function matrix=matrix_init(t,map,lon,lat)
matrix=struct('t',t,'lon',simplegrid.setlon360(lon),'lat',lat,'map',map);
end
%% vecmat and list convertions
function [vecmat,idx]=list2vecmat(list)
% inputs are lists of points in rows, changing with times along the columns
[vecmat,idx]=simplegrid.list_check(list);
% save indexes
idx.map = sub2ind([numel(vecmat.lat),numel(vecmat.lon)],idx.lat,idx.lon);
% save t
vecmat.t=list.t;
% assign map
vecmat.map = NaN(numel(vecmat.lat),numel(vecmat.lon),numel(list.t));
if ~isempty(list.map)
for i=1:numel(vecmat.t)
tmp=NaN(numel(vecmat.lat),numel(vecmat.lon));
tmp(idx.map)=list.map(i,:);
vecmat.map(:,:,i) = tmp;
end
end
end
function list=vecmat2list(vecmat)
%check input and get uniform domain
e=simplegrid.vecmat_check(vecmat);
% build meshed lon and lat
[lon_m,lat_m]=meshgrid(e.lon,e.lat);
% outputs
list=struct(...
'lon',transpose(lon_m(:)),...
'lat',transpose(lat_m(:)),...
't' ,vecmat.t,...
'map',NaN(numel(vecmat.t),numel(lon_m))...
);
%skip converting map if input is empty
if ~isempty(vecmat.map)
for i=1:numel(list.t)
list.map(i,:)=reshape(vecmat.map(:,:,i),numel(list.lon),1);
end
end
end
%% list and flatlist convertions
function flatlist=vecmat2flatlist(vecmat)
% need list (vecmat is checked inside vecmat2list)
list=simplegrid.vecmat2list(vecmat);
% build 3d meshgrids
[lat,t,lon]=meshgrid(vecmat.lat(:),datenum(list.t(:)),vecmat.lon(:));
%assign outputs: collapse everything into vectors
flatlist=struct(...
'lon',lon(:),...
'lat',lat(:),...
't',datetime(t(:),'ConvertFrom','datenum'),...
'map',list.map(:)...
);
end
function vecmat=flatlist2vecmat(flatlist)
% inputs are lists of points in rows, including lat, lon and time dependencies
[vecmat,idx]=simplegrid.flatlist_check(flatlist);
% save indexes
idx.map = sub2ind([numel(vecmat.lat),numel(flatlist.t),numel(vecmat.lon)],idx.lat,idx.t,idx.lon);
% assign map
vecmat.map = NaN(numel(vecmat.lat),numel(vecmat.lon),numel(vecmat.t));
if ~isempty(flatlist.map)
for i=1:numel(flatlist.map)
vecmat.map(idx.lat(i),idx.lon(i),idx.t(i))=flatlist.map(i);
end
end
end
%% vecmat and matrix convertions
function vecmat=matrix2vecmat(matrix)
% Check if grid is regular
if all(diff(matrix.lon(1,:),1,2) == 0)
% Transpose everything
matrix.lon = transpose(matrix.lon);
matrix.lat = transpose(matrix.lat);
matrix.map = permute( matrix.map,[2,1,3]);
end
% inputs are matrices of coordinates and values
vecmat=simplegrid.matrix_check(matrix);
% copy the rest
vecmat.map = matrix.map;
vecmat.t = matrix.t;
end
function matrix=vecmat2matrix(vecmat)
e=simplegrid.vecmat_check(vecmat);
% build meshed lon and lat
[lon_m,lat_m]=meshgrid(e.lon,e.lat);
% outputs
matrix=struct(...
'lon',lon_m,...
'lat',lat_m,...
't' ,vecmat.t,...
'map',vecmat.map...
);
end
%% agregator routines
%data type converter
function out=dtc(from,to,in)
%trivial call
if strcmpi(from,to)
out=in;
return
end
%convert to required types
switch lower(from)
case 'vecmat'
switch lower(to)
case 'list'; out=simplegrid.vecmat2list(in);
case 'flatlist'; out=simplegrid.vecmat2flatlist(in);
case 'matrix'; out=simplegrid.vecmat2matrix(in);
end
case 'list'
switch lower(to)
case 'vecmat'; out= simplegrid.list2vecmat(in);
case 'flatlist'; out=simplegrid.vecmat2flatlist(simplegrid.list2vecmat(in));
case 'matrix'; out=simplegrid.vecmat2matrix( simplegrid.list2vecmat(in));
end
case 'flatlist'
switch lower(to)
case 'vecmat'; out= simplegrid.flatlist2vecmat(in);
case 'list'; out=simplegrid.vecmat2list( simplegrid.flatlist2vecmat(in));
case 'matrix'; out=simplegrid.vecmat2matrix(simplegrid.flatlist2vecmat(in));
end
case 'matrix'
switch lower(to)
case 'vecmat'; out= simplegrid.matrix2vecmat(in);
case 'flatlist'; out=simplegrid.vecmat2flatlist(simplegrid.matrix2vecmat(in));
case 'list'; out=simplegrid.vecmat2list( simplegrid.matrix2vecmat(in));
end
end
end
%data type validity
function c=dtv(type,in)
switch lower(type)
case 'vecmat'; c=simplegrid.vecmat_valid(in);
case 'list'; c=simplegrid.list_valid(in);
case 'flatlist'; c=simplegrid.flatlist_valid(in);
case 'matrix'; c=simplegrid.matrix_valid(in);
otherwise
error(['unknown data type ''',type,'''.'])
end
end
%data type check
function dtcheck(type,in)
switch lower(type)
case 'vecmat'; simplegrid.vecmat_check(in);
case 'list'; simplegrid.list_check(in);
case 'flatlist'; simplegrid.flatlist_check(in);
case 'matrix'; simplegrid.matrix_check(in);
otherwise
error(['unknown data type ''',type,'''.'])
end
end
%data type length
function l=dtl(type,in)
switch lower(type)
case 'vecmat'; l=simplegrid.vecmat_size(in);
case 'list'; l=simplegrid.list_size(in);
case 'flatlist'; l=simplegrid.flatlist_size(in);
case 'matrix'; l=simplegrid.mat_size(in);
otherwise
error(['unknown data type ''',type,'''.'])
end
end
%data type init
function s=dti(t,map,lon,lat,type)
%default type is vecmat
if ~exist('type','var') || isempty(type)
type='vecmat';
end
%cell arrays of maps
if iscell(map) && numel(map) == numel(t)
%collapse all matrices in the cell array into a 3d matrix
map=reshape(cat(2,map{:}),[size(map{1}),numel(t)]);
%3d array with maps on each page
elseif isnumeric(map) && size(map,3) == numel(t)
%do nothing, already in expected format
%2d array with maps on each row
elseif isnumeric(map) && size(map,1) == numel(t)
%do nothing, this will be handled later
else
error('error in sizes of inputs ''t'' and ''map''.')
end
% build structure with inputs
si=struct(...
't',t,...
'lon',simplegrid.setlon360(lon),...
'lat',lat,...
'map',map...
);
% determine format of inputs
if simplegrid.list_valid(si)
fmt='list';
elseif simplegrid.vecmat_valid(si)
fmt='vecmat';
elseif simplegrid.flatlist_valid(si)
fmt='flatlist';
elseif simplegrid.matrix_valid(si)
fmt='matrix';
else
for i={'list','vecmat','flatlist','matrix'}
try
simplegrid.([i{1},'_check'])(si)
catch ME
disp(ME.message)
end
end
error('cannot handle the format of inputs')
end
% convert to requested type
s=simplegrid.dtc(fmt,type,si);
end
%% constructors
function obj=unit(n_lon,n_lat,varargin)
p=machinery.inputParser;
p.addRequired( 'n_lon', @isnumeric);
p.addRequired( 'n_lat', @isnumeric);
p.addParameter('scale',1,@num.isscalar);
p.addParameter('bias', 0,@num.isscalar);
p.addParameter('t',datetime('now'),@isdatetime);
p.parse(n_lon,n_lat,varargin{:});
%initialize with unitary grid
if isscalar(p.Results.n_lat) && isscalar(p.Results.n_lon)
obj=simplegrid(...
p.Results.t,...
ones(p.Results.n_lat,p.Results.n_lon,numel(p.Results.t))*p.Results.scale+p.Results.bias,...
varargin{:}...
);
else
obj=simplegrid(...
p.Results.t,...
ones(numel(p.Results.n_lat),numel(p.Results.n_lon),numel(p.Results.t))*p.Results.scale+p.Results.bias,...
'lat',p.Results.n_lat,'lon',p.Results.n_lon,...
varargin{:}...
);
end
end
% Creates a random model with mean 0 and std 1
function obj=randn(n_lon,n_lat,varargin)
p=machinery.inputParser;
p.addRequired( 'n_lon', @num.isscalar);
p.addRequired( 'n_lat', @num.isscalar);
p.addParameter('scale',1,@num.isscalar);
p.addParameter('bias', 0,@num.isscalar);
p.addParameter('t',datetime('now'),@isdatetime);
p.parse(n_lon,n_lat,varargin{:});
%initialize with random grid
obj=simplegrid(...
p.Results.t,...
randn(p.Results.n_lat,p.Results.n_lon,numel(p.Results.t))*p.Results.scale+p.Results.bias...
);
end
function obj=slanted(n_lon,n_lat,varargin)
p=machinery.inputParser;
p.addRequired( 'n_lon', @num.isscalar);
p.addRequired( 'n_lat', @num.isscalar);
p.addParameter('scale',1,@num.isscalar);
p.addParameter('bias', 0,@num.isscalar);
p.addParameter('t',datetime('now'),@isdatetime);
p.parse(n_lon,n_lat,varargin{:});
%get spatial domain
[lon_map,lat_map]=meshgrid(simplegrid.lon_default(p.Results.n_lon),simplegrid.lat_default(p.Results.n_lat));
%initialize grid with sum of lon and lat in degrees
map=repmat(lon_map+lat_map*p.Results.scale+p.Results.bias,1,1,numel(p.Results.t));
%ensure degree 360 has the same value as degree 0
map(:,end,:)=map(:,1,:);
%initialize with grid
obj=simplegrid(p.Results.t,map);
end
%NOTICE: inputs lon and lat can be scalar (domain size) or vectors (domain entries)
function obj=landmask(lon,lat,varargin)
p=machinery.inputParser('CaseSensitive',true);
p.addRequired( 'lon', @isnumeric);
p.addRequired( 'lat', @isnumeric);
p.addParameter('t', datetime('now'),@isdatetime);
%values higher than this cuttoff are land, lower are ocean; negative values leave the interpolation unchanged
p.addParameter('cutoff',-1, @num.isscalar);
p.parse(lon,lat,varargin{:});
%load the data
fmat=fullfile(file.orbdir('auxiliary'),'landmask.mat');
fdat=fullfile(file.orbdir('auxiliary'),'landmask.dat');
if exist(fmat,'file')
load(fmat,'landmask')
elseif exist(fdat,'file')
landmask=simplegrid.load_mask(fdat,datetime('now'));
save(fmat,'landmask')
else
error(['Cannot find landmask data file, expecting ',fmat,' or ',fdat,'.'])
end
%resample to requested resolution
if isscalar(lon) && isscalar(lat)
obj=landmask.spatial_resample(lon,lat);
elseif isvector(lon) && isvector(lat)
obj=landmask.spatial_interp(lon,lat);
else
error('Inputs ''lat'' and ''lon'' must both be scalar or vector')
end
%enforce cutoff
if p.Results.cutoff>0
land_idx=obj.y>=p.Results.cutoff;
y_now=obj.y;
y_now(~land_idx)=0;
y_now( land_idx)=1;
obj=obj.assign(y_now);
end
end
function obj=oceanmask(lon,lat,varargin)
p=machinery.inputParser;
p.addRequired( 'lon', @isnumeric);
p.addRequired( 'lat', @isnumeric);
p.addParameter('t', datetime('now'),@isdatetime);
p.addParameter('cutoff',1.4, @num.isscalar);
p.parse(lon,lat,varargin{:});
%load the data
fdat=fullfile(file.orbdir('auxiliary'),'wahr.global_ocn_kernel.txt');
oceanmask=gravity.load(fdat,'format','mod').grid;
%resample to requested resolution
if isscalar(lon) && isscalar(lat)
obj=oceanmask.spatial_resample(lon,lat);
elseif isvector(lon) && isvector(lat)
obj=oceanmask.spatial_interp(lon,lat);
else
error('Inputs ''lat'' and ''lon'' must both be scalar or vector')
end
%enforce cutoff
if p.Results.cutoff>0
ocean_idx=obj.y>=p.Results.cutoff;
y_now=obj.y;
y_now(~ocean_idx)=0;
y_now( ocean_idx)=1;
obj=obj.assign(y_now);
end
end
function out=load_mask(filename,t)
fid=file.open(filename);
d=textscan(fid,'%f %f %s');
fclose(fid);
if isscalar(t)
t_save=t;
t=NaT(size(d{3}));
t(:)=t_save;
end
out=simplegrid(t,... %time
double(str.logical(d{3})),... %map
'lon',d{1},... %lon
'lat',d{2}... %lat
);
end
%% map add-ons
function h=coast(varargin)
p=machinery.inputParser;
p.addParameter('datafile',fullfile(file.orbdir('auxiliary'),'coast.mat'));
p.addParameter('line_color','k',@ischar);
p.addParameter('line_width',1.5, @num.isscalar);
p.addParameter('lon',[-180,180], @(i) ~num.isscalar(i));
p.addParameter('lat',[ -90, 90], @(i) ~num.isscalar(i));
p.parse(varargin{:});
coast = load(p.Results.datafile);
keep_idx=find(...
( coast.long<=max(p.Results.lon) & coast.long>=min(p.Results.lon) & ...
coast.lat <=max(p.Results.lat) & coast.lat >=min(p.Results.lat) ) | ...
isnan(coast.lat) | isnan(coast.long) ...
);
h=plot(coast.long(keep_idx),coast.lat(keep_idx),'LineWidth',p.Results.line_width,'Color',p.Results.line_color);
end
%% catchment handling
function out=catchment_idx(name)
out=cells.strfind(lower(simplegrid.catchment_list(:,1)),lower(name));
assert(~isempty(out),['Cannot handle catchment ''',name,'''.'])
end
function out=catchment_details(name,field)
if iscellstr(name)
out=cellfun(@(i) simplegrid.catchment_details(i,field),name,'UniformOutput',false)';
%need to tweak this
switch field
case {'lonlat','latlon'}
tmp=out;
out=cell(numel(tmp),2);
for i=1:numel(tmp)
out{i,1}=tmp{i}{1};
out{i,2}=tmp{i}{2};
end
end
return
end
idx=simplegrid.catchment_idx(name);
switch field
case 'lat'; out=simplegrid.catchment_list{idx,2};
case 'lon'; out=simplegrid.catchment_list{idx,3};
case {'lonlat','latlon'}; out=simplegrid.catchment_list(idx,2:3);
otherwise; error(['Cannot handle field ''',field,'''.'])
end
end
function out=catchment_subset(names)
%trivial call
if iscell(names) && size(names,2)==3 && iscellstr(names(1,:))
out=names;
return
end
assert(iscellstr(names),['Input ''names'' must be a cell string, not a ',class(names),'.'])
out=cell(numel(names),3);
for i=1:numel(names)
out(i,:)=simplegrid.catchment_list(simplegrid.catchment_idx(names{i}),:);
end
end
%% smooting/conv aux functions
function map=map_mirroredges(map,n)
assert(isscalar(n),'Input ''n'' must be scalar')
%NOTICE: n is the size of the smoothing/conv kernel, so edges with width (n-1)/2 are appended
w=(num.odd(n)-1)/2;
%upper edge
map=[flipud(map(2:w+1,:));map];
%lower edge
map=[map;flipud(map(end-w:end-1,:))];
%left edge
map=[map(:,end-w+1:end),map];
%right edge
map=[map,map(:,w+1:2*w)];
end
%% catchment plotting
function catchment=catchment_plot(catchment,varargin)
v=varargs.wrap('sources',{....
{...
'plot_parametric_components',{}, @iscellstr;...
'parametric_components_line_fmt',{'--'},@ischar;...
'plot_lines_over_gaps_narrower_than', days(120), @isduration;...
'time',[],@isdatetime;...
'datafile','',@ischar;....
},...
},varargin{:});
%add gaps (trivial call handled inside)
if isempty(v.time)
ct=catchment.ws.addgaps(v.plot_lines_over_gaps_narrower_than);
else
%align with requested time domain
ct=catchment.ws.interp(v.time,'interp_over_gaps_narrower_than',v.plot_lines_over_gaps_narrower_than);
end
%plot it; NOTICE: for plots with more than 7 lines, matlab's default color scheme is
%too short, so you need to externally define a colormap and, for each line, pass the
%argument pair: 'color',[x,y,z] (which is handled in simpledata.plot)
catchment.plot=ct.plot(varargin{:});
%add parametric decompositions (if requested)
if isfield(catchment,'pws')
%accumulate components to plot
for i=1:numel(v.plot_parametric_components)
if isempty(v.time)
pwst_now=catchment.pws.(['ts_',v.plot_parametric_components{i}]);
else
pwst_now=pardecomp.join(catchment.pws,'time',v.time,'coeffnames',v.plot_parametric_components(i),'datafile',v.datafile);
end
if i==1
catchment.pwst=pwst_now;
else
catchment.pwst=catchment.pwst+pwst_now;
end
catchment.pwst_val.(v.plot_parametric_components{i})=catchment.pws.(v.plot_parametric_components{i}).y_masked;
end
%plot it
catchment.pwst.plot(varargin{:},'line',v.parametric_components_line_fmt)
%copy the color from the last line (and get its handle)
llh=plotting.line_color_set_last;
%don't show this line in the legend
set(get(get(llh,'Annotation'),'LegendInformation'),'IconDisplayStyle','off');
end
title(catchment.name)
end
%% general test for the current object
function out=test_parameters(field,l,w)
switch field
case 'something'
%To be implemented
otherwise
out=simpledata.test_parameters(field,l,w);
end
end
function a=test(method,l)
if ~exist('method','var') || isempty(method)
method='all';
end
if ~exist('l','var') || isempty(l)
%NOTICE: if these values are too small, there will be artifacts in the plots
l=[15,17,2];
end
switch lower(method)
case 'all'
for i={'reps','print','resample',...
'plus','minus','times','rdivide',...
'area','height','volume',...
'crop','interp2',...
'min','max','mean','std','rms','meanabs','stdabs','rmsabs','length','gaps',...
'coast','plot','conv'}
simplegrid.test(i{1},l);
end
case 'reps'
dt={'vecmat','matrix','list','flatlist'};
a=struct(...
'lon',simplegrid.lon_default(l(2)),...
'lat',simplegrid.lat_default(l(1)),...
'map',reshape(1:prod(l),l),...
't',datetime(sort(datenum(round(rand(l(3),6)*60))),'ConvertFrom','datenum')...
);
dd={...
a,...
simplegrid.vecmat2matrix(a),...
simplegrid.vecmat2list(a),...
simplegrid.vecmat2flatlist(a)...
};
for i=1:numel(dt)
for j=1:numel(dt)
out=simplegrid.dtc(dt{i},dt{j},dd{i});
if any(any(out.map~=dd{j}.map))
error(['failed data type conversion between ''',dt{i},''' and ''',dt{j},'''.'])
end
end
end
case 'print'
simplegrid.slanted(l(1),l(2)).print
case 'resample'
a=simplegrid.slanted(l(1),l(2));
a.prettymap
figure
subplot(1,2,1)
a.imagesc('t',a.t);
title('original')