-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
/
Copy pathnetcdfdataset.cpp
11690 lines (10498 loc) · 412 KB
/
netcdfdataset.cpp
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
/******************************************************************************
*
* Project: netCDF read/write Driver
* Purpose: GDAL bindings over netCDF library.
* Author: Frank Warmerdam, warmerdam@pobox.com
* Even Rouault <even.rouault at spatialys.com>
*
******************************************************************************
* Copyright (c) 2004, Frank Warmerdam
* Copyright (c) 2007-2016, Even Rouault <even.rouault at spatialys.com>
* Copyright (c) 2010, Kyle Shannon <kyle at pobox dot com>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
****************************************************************************/
#include "cpl_port.h"
#include <cctype>
#include <cerrno>
#include <climits>
#include <cmath>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <ctime>
#include <algorithm>
#include <limits>
#include <map>
#include <set>
#include <queue>
#include <string>
#include <utility>
#include <vector>
// Must be included after standard includes, otherwise VS2015 fails when
// including <ctime>
#include "netcdfdataset.h"
#include "netcdfsg.h"
#include "netcdfuffd.h"
#include "cpl_conv.h"
#include "cpl_error.h"
#include "cpl_minixml.h"
#include "cpl_multiproc.h"
#include "cpl_progress.h"
#include "cpl_time.h"
#include "gdal.h"
#include "gdal_frmts.h"
#include "ogr_core.h"
#include "ogr_srs_api.h"
CPL_CVSID("$Id$")
// Internal function declarations.
static bool NCDFIsGDALVersionGTE(const char *pszVersion, int nTarget);
static void NCDFAddGDALHistory(
int fpImage,
const char *pszFilename, const char *pszOldHist,
const char *pszFunctionName,
const char *pszCFVersion = NCDF_CONVENTIONS_CF_V1_5 );
static void NCDFAddHistory( int fpImage, const char *pszAddHist,
const char *pszOldHist );
static bool NCDFIsCfProjection( const char *pszProjection );
static std::vector<std::pair<std::string, double> > NCDFGetProjAttribs(
const OGR_SRSNode *poPROJCS,
const char *pszProjection);
static CPLErr NCDFSafeStrcat( char **ppszDest, const char *pszSrc,
size_t *nDestSize );
// Var / attribute helper functions.
static CPLErr NCDFPutAttr( int nCdfId, int nVarId,
const char *pszAttrName, const char *pszValue );
// Replace this where used.
static CPLErr NCDFGet1DVar( int nCdfId, int nVarId, char **pszValue );
static CPLErr NCDFPut1DVar( int nCdfId, int nVarId, const char *pszValue );
static double NCDFGetDefaultNoDataValue( int nCdfId, int nVarId, int nVarType, bool& bGotNoData );
// Replace this where used.
static char **NCDFTokenizeArray( const char *pszValue );
static void CopyMetadata( void *poDS, int fpImage, int CDFVarID,
const char *pszMatchPrefix=nullptr, bool bIsBand=true );
// NetCDF-4 groups helper functions.
// They all work also for NetCDF-3 files which are considered as
// NetCDF-4 file with only one group.
static CPLErr NCDFOpenSubDataset( int nCdfId, const char *pszSubdatasetName,
int *pnGroupId, int *pnVarId );
static CPLErr NCDFGetVisibleDims( int nGroupId, int *pnDims,
int **ppanDimIds );
static CPLErr NCDFGetSubGroups( int nGroupId, int *pnSubGroups,
int **ppanSubGroupIds );
static CPLErr NCDFGetGroupFullName( int nGroupId, char **ppszFullName,
bool bNC3Compat=true );
static CPLErr NCDFGetVarFullName( int nGroupId, int nVarId,
char **ppszFullName, bool bNC3Compat=true );
static CPLErr NCDFGetRootGroup( int nStartGroupId, int *pnRootGroupId );
static CPLErr NCDFResolveVar( int nStartGroupId, const char *pszVar,
int *pnGroupId, int *pnVarId,
bool bMandatory=false );
static CPLErr NCDFResolveVarFullName( int nStartGroupId, const char *pszVar,
char **ppszFullName,
bool bMandatory=false );
static CPLErr NCDFResolveAttInt( int nStartGroupId, int nStartVarId,
const char *pszAtt, int *pnAtt,
bool bMandatory=false );
static CPLErr NCDFGetCoordAndBoundVarFullNames( int nCdfId,
char ***ppapszVars );
// Uncomment this for more debug output.
// #define NCDF_DEBUG 1
CPLMutex *hNCMutex = nullptr;
/************************************************************************/
/* ==================================================================== */
/* netCDFRasterBand */
/* ==================================================================== */
/************************************************************************/
class netCDFRasterBand final: public GDALPamRasterBand
{
friend class netCDFDataset;
nc_type nc_datatype;
int cdfid;
int nZId;
int nZDim;
int nLevel;
int nBandXPos;
int nBandYPos;
int *panBandZPos;
int *panBandZLev;
bool bNoDataSet;
double dfNoDataValue;
bool bValidRangeValid = false;
double adfValidRange[2]{0,0};
bool bHaveScale;
bool bHaveOffset;
double dfScale;
double dfOffset;
CPLString osUnitType;
bool bSignedData;
bool bCheckLongitude;
CPLErr CreateBandMetadata( const int *paDimIds,
const int* panExtraDimGroupIds,
const int* panExtraDimVarIds );
template <class T> void CheckData ( void *pImage, void *pImageNC,
size_t nTmpBlockXSize,
size_t nTmpBlockYSize,
bool bCheckIsNan=false ) ;
template <class T> void CheckDataCpx ( void *pImage, void *pImageNC,
size_t nTmpBlockXSize,
size_t nTmpBlockYSize,
bool bCheckIsNan=false );
void SetBlockSize();
protected:
CPLXMLNode *SerializeToXML( const char *pszVRTPath ) override;
public:
netCDFRasterBand( netCDFDataset *poDS,
int nGroupId,
int nZId,
int nZDim,
int nLevel,
const int *panBandZLen,
const int *panBandPos,
const int *paDimIds,
int nBand,
const int *panExtraDimGroupIds,
const int *panExtraDimVarIds );
netCDFRasterBand( netCDFDataset *poDS,
GDALDataType eType,
int nBand,
bool bSigned=true,
const char *pszBandName=nullptr,
const char *pszLongName=nullptr,
int nZId=-1,
int nZDim=2,
int nLevel=0,
const int *panBandZLev=nullptr,
const int *panBandZPos=nullptr,
const int *paDimIds=nullptr );
virtual ~netCDFRasterBand();
virtual double GetNoDataValue( int * ) override;
virtual CPLErr SetNoDataValue( double ) override;
// virtual CPLErr DeleteNoDataValue();
virtual double GetOffset( int * ) override;
virtual CPLErr SetOffset( double ) override;
virtual double GetScale( int * ) override;
virtual CPLErr SetScale( double ) override;
virtual const char *GetUnitType() override;
virtual CPLErr SetUnitType( const char * ) override;
virtual CPLErr IReadBlock( int, int, void * ) override;
virtual CPLErr IWriteBlock( int, int, void * ) override;
};
/************************************************************************/
/* netCDFRasterBand() */
/************************************************************************/
netCDFRasterBand::netCDFRasterBand( netCDFDataset *poNCDFDS,
int nGroupId,
int nZIdIn,
int nZDimIn,
int nLevelIn,
const int *panBandZLevIn,
const int *panBandZPosIn,
const int *paDimIds,
int nBandIn,
const int *panExtraDimGroupIds,
const int *panExtraDimVarIds ) :
nc_datatype(NC_NAT),
cdfid(nGroupId),
nZId(nZIdIn),
nZDim(nZDimIn),
nLevel(nLevelIn),
nBandXPos(panBandZPosIn[0]),
nBandYPos(nZDim == 1 ? -1 : panBandZPosIn[1]),
panBandZPos(nullptr),
panBandZLev(nullptr),
bNoDataSet(false),
dfNoDataValue(0.0),
bHaveScale(false),
bHaveOffset(false),
dfScale(1.0),
dfOffset(0.0),
bSignedData(true), // Default signed, except for Byte.
bCheckLongitude(false)
{
poDS = poNCDFDS;
nBand = nBandIn;
// Take care of all other dimensions.
if( nZDim > 2 )
{
panBandZPos = static_cast<int *>(CPLCalloc(nZDim - 1, sizeof(int)));
panBandZLev = static_cast<int *>(CPLCalloc(nZDim - 1, sizeof(int)));
for( int i = 0; i < nZDim - 2; i++ )
{
panBandZPos[i] = panBandZPosIn[i + 2];
panBandZLev[i] = panBandZLevIn[i];
}
}
nRasterXSize = poDS->GetRasterXSize();
nRasterYSize = poDS->GetRasterYSize();
nBlockXSize = poDS->GetRasterXSize();
nBlockYSize = 1;
// Get the type of the "z" variable, our target raster array.
if( nc_inq_var(cdfid, nZId, nullptr, &nc_datatype, nullptr, nullptr,
nullptr) != NC_NOERR )
{
CPLError(CE_Failure, CPLE_AppDefined, "Error in nc_var_inq() on 'z'.");
return;
}
#ifdef NETCDF_HAS_NC4
if (NCDFIsUserDefinedType(cdfid, nc_datatype))
{
//First enquire and check that the number of fields is 2
size_t nfields, compoundsize;
if( nc_inq_compound(cdfid, nc_datatype, nullptr, &compoundsize, &nfields) != NC_NOERR)
{
CPLError(CE_Failure, CPLE_AppDefined, "Error in nc_inq_compound() on 'z'.");
return;
}
if (nfields != 2)
{
CPLError(CE_Failure, CPLE_AppDefined, "Unsupported data type encountered in nc_inq_compound() on 'z'.");
return;
}
//Now check that that two types are the same in the struct.
nc_type field_type1, field_type2;
int field_dims1, field_dims2;
if ( nc_inq_compound_field(cdfid, nc_datatype, 0, nullptr, nullptr, &field_type1, &field_dims1, nullptr) != NC_NOERR)
{
CPLError(CE_Failure, CPLE_AppDefined, "Error in querying Field 1 in nc_inq_compound_field() on 'z'.");
return;
}
if ( nc_inq_compound_field(cdfid, nc_datatype, 0, nullptr, nullptr, &field_type2, &field_dims2, nullptr) != NC_NOERR)
{
CPLError(CE_Failure, CPLE_AppDefined, "Error in querying Field 2 in nc_inq_compound_field() on 'z'.");
return;
}
if ((field_type1 != field_type2) || (field_dims1 != field_dims2) || (field_dims1 != 0))
{
CPLError(CE_Failure, CPLE_AppDefined, "Error in interpreting compound data type on 'z'.");
return;
}
if (field_type1 == NC_SHORT)
eDataType = GDT_CInt16;
else if (field_type1 == NC_INT)
eDataType = GDT_CInt32;
else if (field_type1 == NC_FLOAT)
eDataType = GDT_CFloat32;
else if (field_type1 == NC_DOUBLE)
eDataType = GDT_CFloat64;
else
{
CPLError(CE_Failure, CPLE_AppDefined,
"Unsupported netCDF compound data type encountered.");
return;
}
}
else
#endif
{
if( nc_datatype == NC_BYTE )
eDataType = GDT_Byte;
else if( nc_datatype == NC_CHAR )
eDataType = GDT_Byte;
else if( nc_datatype == NC_SHORT )
eDataType = GDT_Int16;
else if( nc_datatype == NC_INT )
eDataType = GDT_Int32;
else if( nc_datatype == NC_FLOAT )
eDataType = GDT_Float32;
else if( nc_datatype == NC_DOUBLE )
eDataType = GDT_Float64;
#ifdef NETCDF_HAS_NC4
// NC_UBYTE (unsigned byte) is only available for NC4.
else if( nc_datatype == NC_UBYTE )
eDataType = GDT_Byte;
else if( nc_datatype == NC_USHORT )
eDataType = GDT_UInt16;
else if( nc_datatype == NC_UINT )
eDataType = GDT_UInt32;
#endif
else
{
if( nBand == 1 )
CPLError(CE_Warning, CPLE_AppDefined,
"Unsupported netCDF datatype (%d), treat as Float32.",
static_cast<int>(nc_datatype));
eDataType = GDT_Float32;
nc_datatype = NC_FLOAT;
}
}
// Find and set No Data for this variable.
nc_type atttype = NC_NAT;
size_t attlen = 0;
const char *pszNoValueName = nullptr;
// Find attribute name, either _FillValue or missing_value.
int status = nc_inq_att(cdfid, nZId, _FillValue, &atttype, &attlen);
if( status == NC_NOERR )
{
pszNoValueName = _FillValue;
}
else
{
status = nc_inq_att(cdfid, nZId, "missing_value", &atttype, &attlen);
if( status == NC_NOERR )
{
pszNoValueName = "missing_value";
}
}
// Fetch missing value.
double dfNoData = 0.0;
bool bGotNoData = false;
if( status == NC_NOERR )
{
if( NCDFGetAttr(cdfid, nZId, pszNoValueName, &dfNoData) == CE_None )
{
bGotNoData = true;
}
}
// If NoData was not found, use the default value, but for non-Byte types
// as it is not recommended:
// https://www.unidata.ucar.edu/software/netcdf/docs/attribute_conventions.html
nc_type vartype = NC_NAT;
if( !bGotNoData )
{
nc_inq_vartype(cdfid, nZId, &vartype);
if( vartype != NC_CHAR &&
vartype != NC_BYTE
#ifdef NETCDF_HAS_NC4
&& vartype != NC_UBYTE
#endif
)
{
dfNoData = NCDFGetDefaultNoDataValue(cdfid, nZId, vartype, bGotNoData);
if( bGotNoData )
{
CPLDebug("GDAL_netCDF",
"did not get nodata value for variable #%d, using default %f",
nZId, dfNoData);
}
}
}
// Look for valid_range or valid_min/valid_max.
// First look for valid_range.
status = nc_inq_att(cdfid, nZId, "valid_range", &atttype, &attlen);
if( (status == NC_NOERR) && (attlen == 2) &&
CPLFetchBool(poNCDFDS->GetOpenOptions(), "HONOUR_VALID_RANGE", true) )
{
int vrange[2] = { 0, 0 };
status = nc_get_att_int(cdfid, nZId, "valid_range", vrange);
if( status == NC_NOERR )
{
bValidRangeValid = true;
adfValidRange[0] = vrange[0];
adfValidRange[1] = vrange[1];
}
// If not found look for valid_min and valid_max.
else
{
int vmin = 0;
status = nc_get_att_int(cdfid, nZId, "valid_min", &vmin);
if( status == NC_NOERR )
{
adfValidRange[0] = vmin;
int vmax = 0;
status = nc_get_att_int(cdfid, nZId, "valid_max", &vmax);
if( status == NC_NOERR )
{
adfValidRange[1] = vmax;
bValidRangeValid = true;
}
}
}
if (bValidRangeValid && adfValidRange[0] > adfValidRange[1])
{
CPLError(
CE_Warning, CPLE_AppDefined,
"netCDFDataset::valid_range: min > max:\n"
" min: %lf\n max: %lf\n", adfValidRange[0], adfValidRange[1]);
bValidRangeValid = false;
adfValidRange[0] = 0.0;
adfValidRange[1] = 0.0;
}
}
// Special For Byte Bands: check for signed/unsigned byte.
if( nc_datatype == NC_BYTE )
{
// netcdf uses signed byte by default, but GDAL uses unsigned by default
// This may cause unexpected results, but is needed for back-compat.
if( poNCDFDS->bIsGdalFile )
bSignedData = false;
else
bSignedData = true;
// For NC4 format NC_BYTE is (normally) signed, NC_UBYTE is unsigned.
// But in case a NC3 file was converted automatically and has hints
// that it is unsigned, take them into account
if( poNCDFDS->eFormat == NCDF_FORMAT_NC4 )
{
bSignedData = true;
}
// Fix nodata value as it was stored signed.
if( !bSignedData && dfNoData < 0 )
{
dfNoData += 256;
}
// If we got valid_range, test for signed/unsigned range.
// http://www.unidata.ucar.edu/software/netcdf/docs/netcdf/Attribute-Conventions.html
if( bValidRangeValid )
{
// If we got valid_range={0,255}, treat as unsigned.
if( adfValidRange[0] == 0 && adfValidRange[1] == 255 )
{
bSignedData = false;
// Fix nodata value as it was stored signed.
if( !bSignedData && dfNoData < 0 )
{
dfNoData += 256;
}
// Reset valid_range.
bValidRangeValid = false;
}
// If we got valid_range={-128,127}, treat as signed.
else if( adfValidRange[0] == -128 && adfValidRange[1] == 127 )
{
bSignedData = true;
// Reset valid_range.
bValidRangeValid = false;
}
}
// Else test for _Unsigned.
// http://www.unidata.ucar.edu/software/netcdf/docs/BestPractices.html
else
{
char *pszTemp = nullptr;
if( NCDFGetAttr(cdfid, nZId, "_Unsigned", &pszTemp) == CE_None )
{
if( EQUAL(pszTemp, "true") )
bSignedData = false;
else if( EQUAL(pszTemp, "false") )
bSignedData = true;
CPLFree(pszTemp);
}
// Fix nodata value as it was stored signed.
if( !bSignedData && dfNoData < 0 )
{
dfNoData += 256;
}
}
if( bSignedData )
{
// set PIXELTYPE=SIGNEDBYTE
// See http://trac.osgeo.org/gdal/wiki/rfc14_imagestructure
SetMetadataItem("PIXELTYPE", "SIGNEDBYTE", "IMAGE_STRUCTURE");
}
}
#ifdef NETCDF_HAS_NC4
if( nc_datatype == NC_UBYTE ||
nc_datatype == NC_USHORT ||
nc_datatype == NC_UINT )
bSignedData = false;
#endif
CPLDebug("GDAL_netCDF", "netcdf type=%d gdal type=%d signedByte=%d",
nc_datatype, eDataType, static_cast<int>(bSignedData));
if( bGotNoData )
{
// Set nodata value.
#ifdef NCDF_DEBUG
CPLDebug("GDAL_netCDF", "SetNoDataValue(%f) read", dfNoData);
#endif
netCDFRasterBand::SetNoDataValue(dfNoData);
}
// Create Band Metadata.
CreateBandMetadata(paDimIds, panExtraDimGroupIds, panExtraDimVarIds);
// Attempt to fetch the scale_factor and add_offset attributes for the
// variable and set them. If these values are not available, set
// offset to 0 and scale to 1.
if( nc_inq_attid (cdfid, nZId, CF_ADD_OFFSET, nullptr) == NC_NOERR )
{
status = nc_get_att_double(cdfid, nZId, CF_ADD_OFFSET, &dfOffset);
CPLDebug("GDAL_netCDF", "got add_offset=%.16g, status=%d",
dfOffset, status);
netCDFRasterBand::SetOffset(dfOffset);
}
if( nc_inq_attid(cdfid, nZId, CF_SCALE_FACTOR, nullptr) == NC_NOERR )
{
status = nc_get_att_double(cdfid, nZId, CF_SCALE_FACTOR, &dfScale);
CPLDebug("GDAL_netCDF", "got scale_factor=%.16g, status=%d",
dfScale, status);
netCDFRasterBand::SetScale(dfScale);
}
// Should we check for longitude values > 360?
bCheckLongitude =
CPLTestBool(CPLGetConfigOption("GDAL_NETCDF_CENTERLONG_180", "YES")) &&
NCDFIsVarLongitude(cdfid, nZId, nullptr);
// Attempt to fetch the units attribute for the variable and set it.
netCDFRasterBand::SetUnitType(GetMetadataItem(CF_UNITS));
SetBlockSize();
}
void netCDFRasterBand::SetBlockSize()
{
// Check for variable chunking (netcdf-4 only).
// GDAL block size should be set to hdf5 chunk size.
#ifdef NETCDF_HAS_NC4
int nTmpFormat = 0;
int status = nc_inq_format(cdfid, &nTmpFormat);
NetCDFFormatEnum eTmpFormat = static_cast<NetCDFFormatEnum>(nTmpFormat);
if( (status == NC_NOERR) &&
(eTmpFormat == NCDF_FORMAT_NC4 || eTmpFormat == NCDF_FORMAT_NC4C) )
{
size_t chunksize[MAX_NC_DIMS] = {};
// Check for chunksize and set it as the blocksize (optimizes read).
status = nc_inq_var_chunking(cdfid, nZId, &nTmpFormat, chunksize);
if( (status == NC_NOERR) && (nTmpFormat == NC_CHUNKED) )
{
nBlockXSize = (int)chunksize[nZDim - 1];
if( nZDim >= 2 )
nBlockYSize = (int)chunksize[nZDim - 2];
else
nBlockYSize = 1;
}
}
#endif
// Force block size to 1 scanline for bottom-up datasets if
// nBlockYSize != 1.
if( static_cast<netCDFDataset*>(poDS)->bBottomUp && nBlockYSize != 1 )
{
nBlockXSize = nRasterXSize;
nBlockYSize = 1;
}
}
// Constructor in create mode.
// If nZId and following variables are not passed, the band will have 2
// dimensions.
// TODO: Get metadata, missing val from band #1 if nZDim > 2.
netCDFRasterBand::netCDFRasterBand( netCDFDataset *poNCDFDS,
const GDALDataType eTypeIn,
int nBandIn,
bool bSigned,
const char *pszBandName,
const char *pszLongName,
int nZIdIn,
int nZDimIn,
int nLevelIn,
const int *panBandZLevIn,
const int *panBandZPosIn,
const int *paDimIds ) :
nc_datatype(NC_NAT),
cdfid(poNCDFDS->GetCDFID()),
nZId(nZIdIn),
nZDim(nZDimIn),
nLevel(nLevelIn),
nBandXPos(1),
nBandYPos(0),
panBandZPos(nullptr),
panBandZLev(nullptr),
bNoDataSet(false),
dfNoDataValue(0.0),
bHaveScale(false),
bHaveOffset(false),
dfScale(0.0),
dfOffset(0.0),
bSignedData(bSigned),
bCheckLongitude(false)
{
poDS = poNCDFDS;
nBand = nBandIn;
nRasterXSize = poDS->GetRasterXSize();
nRasterYSize = poDS->GetRasterYSize();
nBlockXSize = poDS->GetRasterXSize();
nBlockYSize = 1;
if( poDS->GetAccess() != GA_Update )
{
CPLError(CE_Failure, CPLE_NotSupported,
"Dataset is not in update mode, "
"wrong netCDFRasterBand constructor");
return;
}
// Take care of all other dimensions.
if( nZDim > 2 && paDimIds != nullptr )
{
nBandXPos = panBandZPosIn[0];
nBandYPos = panBandZPosIn[1];
panBandZPos = static_cast<int *>(CPLCalloc(nZDim - 1, sizeof(int)));
panBandZLev = static_cast<int *>(CPLCalloc(nZDim - 1, sizeof(int)));
for( int i = 0; i < nZDim - 2; i++ )
{
panBandZPos[i] = panBandZPosIn[i + 2];
panBandZLev[i] = panBandZLevIn[i];
}
}
// Get the type of the "z" variable, our target raster array.
eDataType = eTypeIn;
switch( eDataType )
{
case GDT_Byte:
nc_datatype = NC_BYTE;
#ifdef NETCDF_HAS_NC4
// NC_UBYTE (unsigned byte) is only available for NC4.
if( !bSignedData && (poNCDFDS->eFormat == NCDF_FORMAT_NC4) )
nc_datatype = NC_UBYTE;
#endif
break;
case GDT_Int16:
nc_datatype = NC_SHORT;
break;
case GDT_Int32:
nc_datatype = NC_INT;
break;
case GDT_Float32:
nc_datatype = NC_FLOAT;
break;
case GDT_Float64:
nc_datatype = NC_DOUBLE;
break;
#ifdef NETCDF_HAS_NC4
case GDT_UInt16:
if( poNCDFDS->eFormat == NCDF_FORMAT_NC4 )
{
nc_datatype = NC_USHORT;
break;
}
CPL_FALLTHROUGH
case GDT_UInt32:
if( poNCDFDS->eFormat == NCDF_FORMAT_NC4 )
{
nc_datatype = NC_UINT;
break;
}
CPL_FALLTHROUGH
#endif
default:
if( nBand == 1 )
CPLError(CE_Warning, CPLE_AppDefined,
"Unsupported GDAL datatype (%d), treat as NC_FLOAT.",
static_cast<int>(eDataType));
nc_datatype = NC_FLOAT;
eDataType = GDT_Float32;
break;
}
// Define the variable if necessary (if nZId == -1).
bool bDefineVar = false;
if( nZId == -1 )
{
bDefineVar = true;
// Make sure we are in define mode.
static_cast<netCDFDataset *>(poDS)->SetDefineMode(true);
char szTempPrivate[256 + 1];
const char *pszTemp = nullptr;
if( !pszBandName || EQUAL(pszBandName, "") )
{
snprintf(szTempPrivate, sizeof(szTempPrivate), "Band%d", nBand);
pszTemp = szTempPrivate;
}
else
{
pszTemp = pszBandName;
}
int status;
if( nZDim > 2 && paDimIds != nullptr )
{
status = nc_def_var(cdfid, pszTemp, nc_datatype,
nZDim, paDimIds, &nZId);
}
else
{
int anBandDims[2] = { poNCDFDS->nYDimID, poNCDFDS->nXDimID };
status =
nc_def_var(cdfid, pszTemp, nc_datatype, 2, anBandDims, &nZId);
}
NCDF_ERR(status);
CPLDebug("GDAL_netCDF", "nc_def_var(%d,%s,%d) id=%d",
cdfid, pszTemp, nc_datatype, nZId);
if( !pszLongName || EQUAL(pszLongName, "") )
{
snprintf(szTempPrivate, sizeof(szTempPrivate),
"GDAL Band Number %d", nBand);
pszTemp = szTempPrivate;
}
else
{
pszTemp = pszLongName;
}
status =
nc_put_att_text(cdfid, nZId, CF_LNG_NAME, strlen(pszTemp), pszTemp);
NCDF_ERR(status);
poNCDFDS->DefVarDeflate(nZId, true);
}
// For Byte data add signed/unsigned info.
if( eDataType == GDT_Byte )
{
if( bDefineVar )
{
// Only add attributes if creating variable.
// For unsigned NC_BYTE (except NC4 format),
// add valid_range and _Unsigned ( defined in CF-1 and NUG ).
int status = NC_NOERR;
if( nc_datatype == NC_BYTE &&
poNCDFDS->eFormat != NCDF_FORMAT_NC4 )
{
CPLDebug("GDAL_netCDF",
"adding valid_range attributes for Byte Band");
short l_adfValidRange[2] = { 0, 0 };
if( bSignedData )
{
l_adfValidRange[0] = -128;
l_adfValidRange[1] = 127;
status =
nc_put_att_text(cdfid, nZId, "_Unsigned", 5, "false");
}
else
{
l_adfValidRange[0] = 0;
l_adfValidRange[1] = 255;
status =
nc_put_att_text(cdfid, nZId, "_Unsigned", 4, "true");
}
NCDF_ERR(status);
status = nc_put_att_short(cdfid, nZId, "valid_range",
NC_SHORT, 2, l_adfValidRange);
NCDF_ERR(status);
}
}
// For unsigned byte set PIXELTYPE=SIGNEDBYTE.
// See http://trac.osgeo.org/gdal/wiki/rfc14_imagestructure
if( bSignedData )
SetMetadataItem("PIXELTYPE", "SIGNEDBYTE", "IMAGE_STRUCTURE");
}
if( nc_datatype != NC_BYTE &&
nc_datatype != NC_CHAR
#ifdef NETCDF_HAS_NC4
&& nc_datatype != NC_UBYTE
#endif
)
{
// Set default nodata.
bool bIgnored = false;
double dfNoData = NCDFGetDefaultNoDataValue(cdfid, nZId, nc_datatype, bIgnored);
#ifdef NCDF_DEBUG
CPLDebug("GDAL_netCDF", "SetNoDataValue(%f) default", dfNoData);
#endif
netCDFRasterBand::SetNoDataValue(dfNoData);
}
SetBlockSize();
}
/************************************************************************/
/* ~netCDFRasterBand() */
/************************************************************************/
netCDFRasterBand::~netCDFRasterBand()
{
netCDFRasterBand::FlushCache();
CPLFree(panBandZPos);
CPLFree(panBandZLev);
}
/************************************************************************/
/* GetOffset() */
/************************************************************************/
double netCDFRasterBand::GetOffset( int *pbSuccess )
{
if( pbSuccess != nullptr )
*pbSuccess = static_cast<int>(bHaveOffset);
return dfOffset;
}
/************************************************************************/
/* SetOffset() */
/************************************************************************/
CPLErr netCDFRasterBand::SetOffset( double dfNewOffset )
{
CPLMutexHolderD(&hNCMutex);
dfOffset = dfNewOffset;
bHaveOffset = true;
// Write value if in update mode.
if( poDS->GetAccess() == GA_Update )
{
// Make sure we are in define mode.
static_cast<netCDFDataset *>(poDS)->SetDefineMode(true);
const int status = nc_put_att_double(cdfid, nZId, CF_ADD_OFFSET,
NC_DOUBLE, 1, &dfOffset);
NCDF_ERR(status);
if( status == NC_NOERR )
return CE_None;
return CE_Failure;
}
return CE_None;
}
/************************************************************************/
/* GetScale() */
/************************************************************************/
double netCDFRasterBand::GetScale( int *pbSuccess )
{
if( pbSuccess != nullptr )
*pbSuccess = static_cast<int>(bHaveScale);
return dfScale;
}
/************************************************************************/
/* SetScale() */
/************************************************************************/
CPLErr netCDFRasterBand::SetScale( double dfNewScale )
{
CPLMutexHolderD(&hNCMutex);
dfScale = dfNewScale;
bHaveScale = true;
// Write value if in update mode.
if( poDS->GetAccess() == GA_Update )
{
// Make sure we are in define mode.
static_cast<netCDFDataset *>(poDS)->SetDefineMode(true);
const int status = nc_put_att_double(cdfid, nZId, CF_SCALE_FACTOR,
NC_DOUBLE, 1, &dfScale);
NCDF_ERR(status);
if( status == NC_NOERR )
return CE_None;
return CE_Failure;
}
return CE_None;
}
/************************************************************************/
/* GetUnitType() */
/************************************************************************/
const char *netCDFRasterBand::GetUnitType()
{
if( !osUnitType.empty() )
return osUnitType;
return GDALRasterBand::GetUnitType();
}
/************************************************************************/
/* SetUnitType() */
/************************************************************************/
CPLErr netCDFRasterBand::SetUnitType( const char *pszNewValue )
{
CPLMutexHolderD(&hNCMutex);
osUnitType = (pszNewValue != nullptr ? pszNewValue : "");
if( !osUnitType.empty() )
{
// Write value if in update mode.
if( poDS->GetAccess() == GA_Update )
{
// Make sure we are in define mode.
static_cast<netCDFDataset *>(poDS)->SetDefineMode(TRUE);
const int status = nc_put_att_text(
cdfid, nZId, CF_UNITS, osUnitType.size(), osUnitType.c_str());
NCDF_ERR(status);
if( status == NC_NOERR )
return CE_None;