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
|
## Copyright (C) 2013-2022 Alexander Barth
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; If not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} {} nccreate(@var{filename},@var{varname})
## @deftypefnx {Function File} {} nccreate(@var{filename},@var{varname},"property",@var{value},...)
##
## Create the variable @var{varname} in the file @var{filename}.
##
## @subsubheading Properties
## The following properties can be used:
## @itemize
## @item "Dimensions": a cell array with the dimension names followed by their
## length or Inf if the dimension is unlimited. If the property is omitted, a
## scalar variable is created.
## @item "Datatype": a string with the Octave data type name
## (see @code{ncinfo} for the correspondence between Octave and NetCDF data
## types). The default data type is a "double".
## @item "Format": This can be "netcdf4_classic" (default), "classic", "64bit"
## or "netcdf4".
## @item "FillValue": the value used for undefined elements of the NetCDF
## variable.
## @item "ChunkSize": the size of the data chunks. If omitted, the variable is
## not chunked.
## @item "DeflateLevel": The deflate level for compression. It can be the string
## "disable" (default) for no compression or an integer between 0 (no
## compression) and 9 (maximum compression).
## @item "Shuffle": true for enabling the shuffle filter or false (default) for
## disabling it.
## @end itemize
##
## @subsubheading Example
## @example
## nccreate("test.nc","temp","Dimensions",@{"lon",10,"lat",20@},"Format","classic");
## ncdisp("test.nc");
## @end example
## @seealso{ncwrite}
## @end deftypefn
function nccreate (filename, varname, varargin)
dimensions = {};
datatype = 'double';
ncformat = 'netcdf4_classic';
FillValue = [];
ChunkSize = [];
DeflateLevel = 'disable';
Shuffle = false;
for i = 1:2:length(varargin)
if strcmp(varargin{i},'Dimensions')
dimensions = varargin{i+1};
elseif strcmp(varargin{i},'Datatype')
datatype = varargin{i+1};
elseif strcmp(varargin{i},'Format')
ncformat = varargin{i+1};
elseif strcmp(varargin{i},'FillValue')
FillValue = varargin{i+1};
elseif strcmp(varargin{i},'ChunkSize')
ChunkSize = varargin{i+1};
elseif strcmp(varargin{i},'DeflateLevel')
DeflateLevel = varargin{i+1};
elseif strcmp(varargin{i},'Shuffle')
Shuffle = varargin{i+1};
else
error(['unknown keyword ' varargin{i} '.']);
endif
endfor
if ~isempty(stat(filename))
ncid = netcdf_open(filename,'NC_WRITE');
netcdf_reDef(ncid);
else
mode = format2mode(ncformat);
ncid = netcdf_create(filename,mode);
endif
% create dimensions
dimids = [];
i = 1;
while i <= length(dimensions)
if i == length(dimensions)
dimids(end+1) = netcdf_inqDimID(ncid,dimensions{i});
i = i+1;
elseif ischar(dimensions{i+1})
dimids(end+1) = netcdf_inqDimID(ncid,dimensions{i});
i = i+1;
else
try
if isinf(dimensions{i+1})
dimensions{i+1} = netcdf_getConstant('NC_UNLIMITED');
endif
dimids(end+1) = netcdf_defDim(ncid,dimensions{i},dimensions{i+1});
catch
dimids(end+1) = netcdf_inqDimID(ncid,dimensions{i});
end_try_catch
i = i+2;
endif
endwhile
varid = netcdf_defVar(ncid,varname,oct2nctype(datatype),dimids);
if ~isempty(ChunkSize)
netcdf_defVarChunking(ncid,varid,'chunked',ChunkSize);
endif
if ~isempty(FillValue)
% value of nofill?
netcdf_defVarFill(ncid,varid,false,FillValue);
endif
if isnumeric(DeflateLevel)
netcdf_defVarDeflate(ncid,varid,Shuffle,true,DeflateLevel);
endif
netcdf_close(ncid);
endfunction
|
