-
Notifications
You must be signed in to change notification settings - Fork 266
/
Copy pathdvarget.c
1509 lines (1284 loc) · 41.6 KB
/
dvarget.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
/*! \file
Functions for getting data from variables.
Copyright 2018 University Corporation for Atmospheric
Research/Unidata. See \ref copyright file for more info.
*/
#include "ncdispatch.h"
/*!
\internal
*/
struct GETodometer {
int rank;
size_t index[NC_MAX_VAR_DIMS];
size_t start[NC_MAX_VAR_DIMS];
size_t edges[NC_MAX_VAR_DIMS];
ptrdiff_t stride[NC_MAX_VAR_DIMS];
size_t stop[NC_MAX_VAR_DIMS];
};
/**
* @internal Initialize odometer.
*
* @param odom Pointer to odometer.
* @param rank
* @param start Start indices.
* @param edges Counts.
* @param stride Strides.
*
*/
static void
odom_init(struct GETodometer* odom, int rank, const size_t* start,
const size_t* edges, const ptrdiff_t* stride)
{
int i;
memset(odom,0,sizeof(struct GETodometer));
odom->rank = rank;
assert(odom->rank <= NC_MAX_VAR_DIMS);
for(i=0;i<odom->rank;i++) {
odom->start[i] = (start != NULL ? start[i] : 0);
odom->edges[i] = (edges != NULL ? edges[i] : 1);
odom->stride[i] = (stride != NULL ? stride[i] : 1);
odom->stop[i] = odom->start[i] + (odom->edges[i]*((size_t)odom->stride[i]));
odom->index[i] = odom->start[i];
}
}
/**
* @internal Return true if there is more.
*
* @param odom Pointer to odometer.
*
* @return True if there is more, 0 otherwise.
*/
static int
odom_more(struct GETodometer* odom)
{
return (odom->index[0] < odom->stop[0]);
}
/**
* @internal Move odometer.
*
* @param odom Pointer to odometer.
*
* @return 0 or 1
*/
static int
odom_next(struct GETodometer* odom)
{
int i;
if(odom->rank == 0) return 0;
for(i=odom->rank-1;i>=0;i--) {
odom->index[i] += (size_t)odom->stride[i];
if(odom->index[i] < odom->stop[i]) break;
if(i == 0) return 0; /* leave the 0th entry if it overflows*/
odom->index[i] = odom->start[i]; /* reset this position*/
}
return 1;
}
/** \internal
\ingroup variables
*/
int
NC_get_vara(int ncid, int varid,
const size_t *start, const size_t *edges,
void *value, nc_type memtype)
{
NC* ncp;
size_t *my_count = (size_t *)edges;
int stat = NC_check_id(ncid, &ncp);
if(stat != NC_NOERR) return stat;
if(start == NULL || edges == NULL) {
stat = NC_check_nulls(ncid, varid, start, &my_count, NULL);
if(stat != NC_NOERR) return stat;
}
stat = ncp->dispatch->get_vara(ncid,varid,start,my_count,value,memtype);
if(edges == NULL) free(my_count);
return stat;
}
/**
\internal
Get data for a variable.
\param ncid NetCDF or group ID.
\param varid Variable ID
\param value Pointer where the data will be copied. Memory must be
allocated by the user before this function is called.
\param memtype the NC type of the data after it is read into
memory. Data are converted from the variable's type to the memtype as
they are read.
\returns ::NC_NOERR No error.
\returns ::NC_ENOTVAR Variable not found.
\returns ::NC_EINVALCOORDS Index exceeds dimension bound.
\returns ::NC_EEDGE Start+count exceeds dimension bound.
\returns ::NC_ERANGE One or more of the values are out of range.
\returns ::NC_EINDEFINE Operation not allowed in define mode.
\returns ::NC_EBADID Bad ncid.
\ingroup variables
\author Dennis Heimbigner
*/
static int
NC_get_var(int ncid, int varid, void *value, nc_type memtype)
{
return NC_get_vara(ncid, varid, NC_coord_zero, NULL, value, memtype);
}
/** \internal
\ingroup variables
Most dispatch tables will use the default procedures
*/
int
NCDEFAULT_get_vars(int ncid, int varid, const size_t * start,
const size_t * edges, const ptrdiff_t * stride,
void *value0, nc_type memtype)
{
/* Rebuilt get_vars code to simplify and avoid use of get_varm */
int status = NC_NOERR;
int i,simplestride,isrecvar;
int rank;
struct GETodometer odom;
nc_type vartype = NC_NAT;
NC* ncp;
int memtypelen;
size_t vartypelen;
size_t nels;
char* value = (char*)value0;
size_t numrecs;
size_t varshape[NC_MAX_VAR_DIMS];
size_t mystart[NC_MAX_VAR_DIMS];
size_t myedges[NC_MAX_VAR_DIMS];
ptrdiff_t mystride[NC_MAX_VAR_DIMS];
char *memptr = NULL;
status = NC_check_id (ncid, &ncp);
if(status != NC_NOERR) return status;
status = nc_inq_vartype(ncid, varid, &vartype);
if(status != NC_NOERR) return status;
if(memtype == NC_NAT) memtype = vartype;
/* compute the variable type size */
status = nc_inq_type(ncid,vartype,NULL,&vartypelen);
if(status != NC_NOERR) return status;
if(memtype > NC_MAX_ATOMIC_TYPE)
memtypelen = (int)vartypelen;
else
memtypelen = nctypelen(memtype);
/* Check gross internal/external type compatibility */
if(vartype != memtype) {
/* If !atomic, the two types must be the same */
if(vartype > NC_MAX_ATOMIC_TYPE
|| memtype > NC_MAX_ATOMIC_TYPE)
return NC_EBADTYPE;
/* ok, the types differ but both are atomic */
if(memtype == NC_CHAR || vartype == NC_CHAR)
return NC_ECHAR;
}
/* Get the variable rank */
status = nc_inq_varndims(ncid, varid, &rank);
if(status != NC_NOERR) return status;
/* Start array is always required for non-scalar vars. */
if(rank > 0 && start == NULL)
return NC_EINVALCOORDS;
/* Get variable dimension sizes */
isrecvar = NC_is_recvar(ncid,varid,&numrecs);
NC_getshape(ncid,varid,rank,varshape);
/* Optimize out using various checks */
if (rank == 0) {
/*
* The variable is a scalar; consequently,
* there s only one thing to get and only one place to put it.
* (Why was I called?)
*/
size_t edge1[1] = {1};
return NC_get_vara(ncid, varid, start, edge1, value, memtype);
}
/* Do various checks and fixups on start/edges/stride */
simplestride = 1; /* assume so */
nels = 1;
for(i=0;i<rank;i++) {
size_t dimlen;
mystart[i] = (start == NULL ? 0 : start[i]);
/* illegal value checks */
dimlen = (i == 0 && isrecvar ? numrecs : varshape[i]);
/* mystart is unsigned, never < 0 */
if (mystart[i] > dimlen) return NC_EINVALCOORDS;
if(edges == NULL) {
if(i == 0 && isrecvar)
myedges[i] = numrecs - start[i];
else
myedges[i] = varshape[i] - mystart[i];
} else
myedges[i] = edges[i];
if (mystart[i] == dimlen && myedges[i] > 0) return NC_EINVALCOORDS;
/* myedges is unsigned, never < 0 */
if(mystart[i] + myedges[i] > dimlen)
return NC_EEDGE;
mystride[i] = (stride == NULL ? 1 : stride[i]);
if(mystride[i] <= 0
/* cast needed for braindead systems with signed size_t */
|| ((unsigned long) mystride[i] >= X_INT_MAX))
return NC_ESTRIDE;
if(mystride[i] != 1) simplestride = 0;
if(myedges[i] == 0)
nels = 0;
}
if(nels == 0)
return NC_NOERR; /* cannot read anything */
if(simplestride) {
return NC_get_vara(ncid, varid, mystart, myedges, value, memtype);
}
/* memptr indicates where to store the next value */
memptr = value;
odom_init(&odom,rank,mystart,myedges,mystride);
/* walk the odometer to extract values */
while(odom_more(&odom)) {
int localstatus = NC_NOERR;
/* Read a single value */
localstatus = NC_get_vara(ncid,varid,odom.index,NC_coord_one,memptr,memtype);
/* So it turns out that when get_varm is used, all errors are
delayed and ERANGE will be overwritten by more serious errors.
*/
if(localstatus != NC_NOERR) {
if(status == NC_NOERR || localstatus != NC_ERANGE)
status = localstatus;
}
memptr += memtypelen;
odom_next(&odom);
}
return status;
}
/** \internal
\ingroup variables
*/
static int
NC_get_var1(int ncid, int varid, const size_t *coord, void* value,
nc_type memtype)
{
return NC_get_vara(ncid, varid, coord, NC_coord_one, value, memtype);
}
/** \internal
\ingroup variables
*/
int
NCDEFAULT_get_varm(int ncid, int varid, const size_t *start,
const size_t *edges, const ptrdiff_t *stride,
const ptrdiff_t *imapp, void *value0, nc_type memtype)
{
int status = NC_NOERR;
nc_type vartype = NC_NAT;
int varndims,maxidim;
NC* ncp;
int memtypelen;
char* value = (char*)value0;
status = NC_check_id (ncid, &ncp);
if(status != NC_NOERR) return status;
/*
if(NC_indef(ncp)) return NC_EINDEFINE;
*/
status = nc_inq_vartype(ncid, varid, &vartype);
if(status != NC_NOERR) return status;
/* Check that this is an atomic type */
if(vartype > NC_MAX_ATOMIC_TYPE)
return NC_EMAPTYPE;
status = nc_inq_varndims(ncid, varid, &varndims);
if(status != NC_NOERR) return status;
if(memtype == NC_NAT) {
memtype = vartype;
}
if(memtype == NC_CHAR && vartype != NC_CHAR)
return NC_ECHAR;
else if(memtype != NC_CHAR && vartype == NC_CHAR)
return NC_ECHAR;
memtypelen = nctypelen(memtype);
maxidim = (int) varndims - 1;
if (maxidim < 0)
{
/*
* The variable is a scalar; consequently,
* there s only one thing to get and only one place to put it.
* (Why was I called?)
*/
size_t edge1[1] = {1};
return NC_get_vara(ncid, varid, start, edge1, value, memtype);
}
/*
* else
* The variable is an array.
*/
{
int idim;
size_t *mystart = NULL;
size_t *myedges;
size_t *iocount; /* count vector */
size_t *stop; /* stop indexes */
size_t *length; /* edge lengths in bytes */
ptrdiff_t *mystride;
ptrdiff_t *mymap;
size_t varshape[NC_MAX_VAR_DIMS];
int isrecvar;
size_t numrecs;
/* Compute some dimension related values */
isrecvar = NC_is_recvar(ncid,varid,&numrecs);
NC_getshape(ncid,varid,varndims,varshape);
/*
* Verify stride argument; also see if stride is all ones
*/
if(stride != NULL) {
int stride1 = 1;
for (idim = 0; idim <= maxidim; ++idim)
{
if (stride[idim] == 0
/* cast needed for braindead systems with signed size_t */
|| ((unsigned long) stride[idim] >= X_INT_MAX))
{
return NC_ESTRIDE;
}
if(stride[idim] != 1) stride1 = 0;
}
/* If stride1 is true, and there is no imap
then call get_vara directly.
*/
if(stride1 && imapp == NULL) {
return NC_get_vara(ncid, varid, start, edges, value, memtype);
}
}
/* assert(sizeof(ptrdiff_t) >= sizeof(size_t)); */
/* Allocate space for mystart,mystride,mymap etc.all at once */
mystart = (size_t *)calloc((size_t)(varndims * 7), sizeof(ptrdiff_t));
if(mystart == NULL) return NC_ENOMEM;
myedges = mystart + varndims;
iocount = myedges + varndims;
stop = iocount + varndims;
length = stop + varndims;
mystride = (ptrdiff_t *)(length + varndims);
mymap = mystride + varndims;
/*
* Check start, edges
*/
for (idim = maxidim; idim >= 0; --idim)
{
size_t dimlen =
idim == 0 && isrecvar
? numrecs
: varshape[idim];
mystart[idim] = start != NULL
? start[idim]
: 0;
if (mystart[idim] > dimlen)
{
status = NC_EINVALCOORDS;
goto done;
}
#ifdef COMPLEX
myedges[idim] = edges != NULL
? edges[idim]
: idim == 0 && isrecvar
? numrecs - mystart[idim]
: varshape[idim] - mystart[idim];
#else
if(edges != NULL)
myedges[idim] = edges[idim];
else if (idim == 0 && isrecvar)
myedges[idim] = numrecs - mystart[idim];
else
myedges[idim] = varshape[idim] - mystart[idim];
#endif
if (mystart[idim] == dimlen && myedges[idim] > 0)
{
status = NC_EINVALCOORDS;
goto done;
}
if (mystart[idim] + myedges[idim] > dimlen)
{
status = NC_EEDGE;
goto done;
}
}
/*
* Initialize I/O parameters.
*/
for (idim = maxidim; idim >= 0; --idim)
{
if (edges != NULL && edges[idim] == 0)
{
status = NC_NOERR; /* read/write no data */
goto done;
}
mystride[idim] = stride != NULL
? stride[idim]
: 1;
/* Remember: in netCDF-2 imapp is byte oriented, not index oriented
* Starting from netCDF-3, imapp is index oriented */
#ifdef COMPLEX
mymap[idim] = (imapp != NULL
? imapp[idim]
: (idim == maxidim ? 1
: mymap[idim + 1] * (ptrdiff_t) myedges[idim + 1]));
#else
if(imapp != NULL)
mymap[idim] = imapp[idim];
else if (idim == maxidim)
mymap[idim] = 1;
else
mymap[idim] =
mymap[idim + 1] * (ptrdiff_t) myedges[idim + 1];
#endif
iocount[idim] = 1;
length[idim] = ((size_t)mymap[idim]) * myedges[idim];
stop[idim] = (mystart[idim] + myedges[idim] * (size_t)mystride[idim]);
}
/* Lower body */
/*
* As an optimization, adjust I/O parameters when the fastest
* dimension has unity stride both externally and internally.
* In this case, the user could have called a simpler routine
* (i.e. ncvar$1()
*/
if (mystride[maxidim] == 1
&& mymap[maxidim] == 1)
{
iocount[maxidim] = myedges[maxidim];
mystride[maxidim] = (ptrdiff_t) myedges[maxidim];
mymap[maxidim] = (ptrdiff_t) length[maxidim];
}
/*
* Perform I/O. Exit when done.
*/
for (;;)
{
/* TODO: */
int lstatus = NC_get_vara(ncid, varid, mystart, iocount,
value, memtype);
if (lstatus != NC_NOERR) {
if(status == NC_NOERR || lstatus != NC_ERANGE)
status = lstatus;
}
/*
* The following code permutes through the variable s
* external start-index space and it s internal address
* space. At the UPC, this algorithm is commonly
* called "odometer code".
*/
idim = maxidim;
carry:
value += (((int)mymap[idim]) * memtypelen);
mystart[idim] += (size_t)mystride[idim];
if (mystart[idim] == stop[idim])
{
size_t l = (length[idim] * (size_t)memtypelen);
value -= l;
mystart[idim] = start[idim];
if (--idim < 0)
break; /* normal return */
goto carry;
}
} /* I/O loop */
done:
free(mystart);
} /* variable is array */
return status;
}
/**
\internal
Called by externally visible nc_get_vars_xxx routines.
\param ncid NetCDF or group ID.
\param varid Variable ID
\param start start indices. Required for non-scalar vars. This array
must be same size as variable's number of dimensions.
\param edges count indices. This array must be same size as variable's
number of dimensions.
\param stride data strides. This array must be same size as variable's
number of dimensions.
\param value Pointer where the data will be copied. Memory must be
allocated by the user before this function is called.
\param memtype the NC type of the data after it is read into
memory. Data are converted from the variable's type to the memtype as
they are read.
\returns ::NC_NOERR No error.
\returns ::NC_ENOTVAR Variable not found.
\returns ::NC_EINVALCOORDS Index exceeds dimension bound.
\returns ::NC_EEDGE Start+count exceeds dimension bound.
\returns ::NC_ERANGE One or more of the values are out of range.
\returns ::NC_EINDEFINE Operation not allowed in define mode.
\returns ::NC_EBADID Bad ncid.
\ingroup variables
\author Dennis Heimbigner, Ed Hartnett
*/
static int
NC_get_vars(int ncid, int varid, const size_t *start,
const size_t *edges, const ptrdiff_t *stride, void *value,
nc_type memtype)
{
NC* ncp;
size_t *my_count = (size_t *)edges;
ptrdiff_t *my_stride = (ptrdiff_t *)stride;
int stat;
stat = NC_check_id(ncid, &ncp);
if(stat != NC_NOERR) return stat;
/* Handle any NULL parameters. */
if(start == NULL || edges == NULL || stride == NULL) {
stat = NC_check_nulls(ncid, varid, start, &my_count, &my_stride);
if(stat != NC_NOERR) return stat;
}
stat = ncp->dispatch->get_vars(ncid,varid,start,my_count,my_stride,
value,memtype);
if(edges == NULL) free(my_count);
if(stride == NULL) free(my_stride);
return stat;
}
/**
\internal
Called by externally visible nc_get_varm_xxx routines. Note that the
varm routines are deprecated. Use the vars routines instead for new
code.
\param ncid NetCDF or group ID.
\param varid Variable ID
\param start start indices.
\param edges count indices.
\param stride data strides.
\param map mapping of dimensions.
\param value Pointer where the data will be copied. Memory must be
allocated by the user before this function is called.
\param memtype the NC type of the data after it is read into
memory. Data are converted from the variable's type to the memtype as
they are read.
\returns ::NC_NOERR No error.
\returns ::NC_ENOTVAR Variable not found.
\returns ::NC_EINVALCOORDS Index exceeds dimension bound.
\returns ::NC_EEDGE Start+count exceeds dimension bound.
\returns ::NC_ERANGE One or more of the values are out of range.
\returns ::NC_EINDEFINE Operation not allowed in define mode.
\returns ::NC_EBADID Bad ncid.
\ingroup variables
\author Dennis Heimbigner, Ed Hartnett
*/
static int
NC_get_varm(int ncid, int varid, const size_t *start,
const size_t *edges, const ptrdiff_t *stride, const ptrdiff_t* map,
void *value, nc_type memtype)
{
NC* ncp;
size_t *my_count = (size_t *)edges;
ptrdiff_t *my_stride = (ptrdiff_t *)stride;
int stat;
stat = NC_check_id(ncid, &ncp);
if(stat != NC_NOERR) return stat;
/* Handle any NULL parameters. */
if(start == NULL || edges == NULL || stride == NULL) {
stat = NC_check_nulls(ncid, varid, start, &my_count, &my_stride);
if(stat != NC_NOERR) return stat;
}
stat = ncp->dispatch->get_varm(ncid, varid, start, my_count, my_stride,
map, value, memtype);
if(edges == NULL) free(my_count);
if(stride == NULL) free(my_stride);
return stat;
}
/** \name Reading Data from Variables
Functions to read data from variables. */
/*! \{ */ /* All these functions are part of this named group... */
/** \ingroup variables
Read an array of values from a variable.
The array to be read is specified by giving a corner and a vector of
edge lengths to \ref specify_hyperslab.
The data values are read into consecutive locations with the last
dimension varying fastest. The netCDF dataset must be in data mode
(for netCDF-4/HDF5 files, the switch to data mode will happen
automatically, unless the classic model is used).
The nc_get_vara() function will read a variable of any type,
including user defined type. For this function, the type of the data
in memory must match the type of the variable - no data conversion is
done.
Other nc_get_vara_ functions will convert data to the desired output
type as needed.
\param ncid NetCDF or group ID, from a previous call to nc_open(),
nc_create(), nc_def_grp(), or associated inquiry functions such as
nc_inq_ncid().
\param varid Variable ID
\param startp Start vector with one element for each dimension to \ref
specify_hyperslab. This array must be same size as variable's number
of dimensions.
\param countp Count vector with one element for each dimension to \ref
specify_hyperslab. This array must be same size as variable's number
of dimensions.
\param ip Pointer where the data will be copied. Memory must be
allocated by the user before this function is called.
\returns ::NC_NOERR No error.
\returns ::NC_ENOTVAR Variable not found.
\returns ::NC_EINVALCOORDS Index exceeds dimension bound.
\returns ::NC_EEDGE Start+count exceeds dimension bound.
\returns ::NC_ERANGE One or more of the values are out of range.
\returns ::NC_EINDEFINE Operation not allowed in define mode.
\returns ::NC_EBADID Bad ncid.
\section nc_get_vara_double_example Example
Here is an example using nc_get_vara_double() to read all the values of
the variable named rh from an existing netCDF dataset named
foo.nc. For simplicity in this example, we assume that we know that rh
is dimensioned with time, lat, and lon, and that there are three time
values, five lat values, and ten lon values.
\code
#include <netcdf.h>
...
#define TIMES 3
#define LATS 5
#define LONS 10
int status;
int ncid;
int rh_id;
static size_t start[] = {0, 0, 0};
static size_t count[] = {TIMES, LATS, LONS};
double rh_vals[TIMES*LATS*LONS];
...
status = nc_open("foo.nc", NC_NOWRITE, &ncid);
if (status != NC_NOERR) handle_error(status);
...
status = nc_inq_varid (ncid, "rh", &rh_id);
if (status != NC_NOERR) handle_error(status);
...
status = nc_get_vara_double(ncid, rh_id, start, count, rh_vals);
if (status != NC_NOERR) handle_error(status);
\endcode
\author Glenn Davis, Russ Rew, Ed Hartnett, Dennis Heimbigner, Ward Fisher
*/
/**@{*/
int
nc_get_vara(int ncid, int varid, const size_t *startp,
const size_t *countp, void *ip)
{
NC* ncp;
nc_type xtype = NC_NAT;
int stat = NC_check_id(ncid, &ncp);
if(stat != NC_NOERR) return stat;
stat = nc_inq_vartype(ncid, varid, &xtype);
if(stat != NC_NOERR) return stat;
return NC_get_vara(ncid, varid, startp, countp, ip, xtype);
}
int
nc_get_vara_text(int ncid, int varid, const size_t *startp,
const size_t *countp, char *ip)
{
return NC_get_vara(ncid, varid, startp, countp, (void *)ip, NC_CHAR);
}
int
nc_get_vara_schar(int ncid, int varid, const size_t *startp,
const size_t *countp, signed char *ip)
{
return NC_get_vara(ncid, varid, startp, countp, (void *)ip, NC_BYTE);
}
int
nc_get_vara_uchar(int ncid, int varid, const size_t *startp,
const size_t *countp, unsigned char *ip)
{
return NC_get_vara(ncid, varid, startp, countp, (void *)ip, T_uchar);
}
int
nc_get_vara_short(int ncid, int varid, const size_t *startp,
const size_t *countp, short *ip)
{
return NC_get_vara(ncid, varid, startp, countp, (void *)ip, NC_SHORT);
}
int
nc_get_vara_int(int ncid, int varid,
const size_t *startp, const size_t *countp, int *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,NC_INT);
}
int
nc_get_vara_long(int ncid, int varid,
const size_t *startp, const size_t *countp, long *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,T_long);
}
int
nc_get_vara_float(int ncid, int varid,
const size_t *startp, const size_t *countp, float *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,T_float);
}
int
nc_get_vara_double(int ncid, int varid, const size_t *startp,
const size_t *countp, double *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,T_double);
}
int
nc_get_vara_ubyte(int ncid, int varid,
const size_t *startp, const size_t *countp, unsigned char *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,T_ubyte);
}
int
nc_get_vara_ushort(int ncid, int varid,
const size_t *startp, const size_t *countp, unsigned short *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,T_ushort);
}
int
nc_get_vara_uint(int ncid, int varid,
const size_t *startp, const size_t *countp, unsigned int *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,T_uint);
}
int
nc_get_vara_longlong(int ncid, int varid,
const size_t *startp, const size_t *countp, long long *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,T_longlong);
}
int
nc_get_vara_ulonglong(int ncid, int varid, const size_t *startp,
const size_t *countp, unsigned long long *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,NC_UINT64);
}
int
nc_get_vara_string(int ncid, int varid, const size_t *startp,
const size_t *countp, char* *ip)
{
return NC_get_vara(ncid,varid,startp,countp, (void *)ip,NC_STRING);
}
/**@}*/
/** \ingroup variables
Read a single datum from a variable.
Inputs are the netCDF ID, the variable ID, a multidimensional index
that specifies which value to get, and the address of a location into
which the data value will be read. The value is converted from the
external data type of the variable, if necessary.
The nc_get_var1() function will read a variable of any type, including
user defined type. For this function, the type of the data in memory
must match the type of the variable - no data conversion is done.
Other nc_get_var1_ functions will convert data to the desired output
type as needed.
\param ncid NetCDF or group ID, from a previous call to nc_open(),
nc_create(), nc_def_grp(), or associated inquiry functions such as
nc_inq_ncid().
\param varid Variable ID
\param indexp Index vector with one element for each dimension.
\param ip Pointer where the data will be copied. Memory must be
allocated by the user before this function is called.
\returns ::NC_NOERR No error.
\returns ::NC_ENOTVAR Variable not found.
\returns ::NC_EINVALCOORDS Index exceeds dimension bound.
\returns ::NC_ERANGE One or more of the values are out of range.
\returns ::NC_EINDEFINE Operation not allowed in define mode.
\returns ::NC_EBADID Bad ncid.
\author Glenn Davis, Russ Rew, Ed Hartnett, Dennis Heimbigner, Ward Fisher
*/
/** \{ */
int
nc_get_var1(int ncid, int varid, const size_t *indexp, void *ip)
{
return NC_get_var1(ncid, varid, indexp, ip, NC_NAT);
}
int
nc_get_var1_text(int ncid, int varid, const size_t *indexp, char *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_CHAR);
}
int
nc_get_var1_schar(int ncid, int varid, const size_t *indexp, signed char *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_BYTE);
}
int
nc_get_var1_uchar(int ncid, int varid, const size_t *indexp, unsigned char *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_UBYTE);
}
int
nc_get_var1_short(int ncid, int varid, const size_t *indexp, short *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_SHORT);
}
int
nc_get_var1_int(int ncid, int varid, const size_t *indexp, int *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_INT);
}
int
nc_get_var1_long(int ncid, int varid, const size_t *indexp,
long *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, longtype);
}
int
nc_get_var1_float(int ncid, int varid, const size_t *indexp,
float *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_FLOAT);
}
int
nc_get_var1_double(int ncid, int varid, const size_t *indexp,
double *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_DOUBLE);
}
int
nc_get_var1_ubyte(int ncid, int varid, const size_t *indexp,
unsigned char *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_UBYTE);
}
int
nc_get_var1_ushort(int ncid, int varid, const size_t *indexp,
unsigned short *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_USHORT);
}
int
nc_get_var1_uint(int ncid, int varid, const size_t *indexp,
unsigned int *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_UINT);
}
int
nc_get_var1_longlong(int ncid, int varid, const size_t *indexp,
long long *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_INT64);
}
int
nc_get_var1_ulonglong(int ncid, int varid, const size_t *indexp,
unsigned long long *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_UINT64);
}
int
nc_get_var1_string(int ncid, int varid, const size_t *indexp, char* *ip)
{
return NC_get_var1(ncid, varid, indexp, (void *)ip, NC_STRING);
}
/** \} */
/** \ingroup variables
Read an entire variable in one call.
This function will read all the values from a netCDF variable of an
open netCDF dataset.
This is the simplest interface to use for reading the value of a
scalar variable or when all the values of a multidimensional variable