File: ncwriteschema.m

package info (click to toggle)
octave-netcdf 1.0.18-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 1,756 kB
  • sloc: sh: 2,943; cpp: 1,812; python: 438; makefile: 223; awk: 51; xml: 20
file content (171 lines) | stat: -rw-r--r-- 4,613 bytes parent folder | download | duplicates (2)
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
## 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} {} ncwriteschema (@var{filename}, @var{schema})
##
## Create a NetCDF called @var{filename} with the dimensions, attributes, 
## variables and groups given by the structure @var{schema}.
##
## The variable @var{schema} has the same structure as the results of 
## @code{ncinfo}. @code{ncinfo} and @code{ncwriteschema} can be used together to
## create a NetCDF using another file as a template:
##
## @subsubheading Example
## @example
## schema = ncinfo("template.nc");
## # the new file should be named "new_file.nc"
## ncwriteschema("new_file.nc",schema);
## @end example
##
## Unused field in @var{schema} such as @var{ChunkSize}, @var{Shuffle}, 
## @var{DeflateLevel}, @var{FillValue}, @var{Checksum} can be left-out if the 
## corresponding feature is not used.
##
## Dimensions are considered as limited if the field @var{Unlimited} is missing,
## unless the dimension length is Inf.
##
## @seealso{ncinfo}
##
## @end deftypefn


function ncwriteschema (filename, s)

  mode = format2mode(s.Format);
  ncid = netcdf_create(filename,mode);
  write_group(ncid,s)

  netcdf_close(ncid);

endfunction

function write_group(ncid,s)
  % normalize schema

  if ~isfield(s,'Dimensions')
    s.Dimensions = [];
  endif
  if isempty(s.Dimensions)
    s.Dimensions = struct('Name',{},'Length',{},'Unlimited',{});
  endif

  if ~isfield(s,'Attributes')
    s.Attributes = struct('Name',{},'Value',{});
  endif

  if ~isfield(s,'Variables')
    s.Variables = struct('Name',{},'Dimensions',{},'Datatype',{});;
  endif

  % dimension
  for i = 1:length(s.Dimensions)
    dim = s.Dimensions(i);

    if ~isfield(dim,'Unlimited')
      dim.Unlimited = false;
    endif
  
    len = dim.Length;  
    if dim.Unlimited || isinf(len)
      len = netcdf_getConstant('NC_UNLIMITED');
    endif
  
    s.Dimensions(i).id = netcdf_defDim(ncid,dim.Name,len);
  endfor

  % global attributes
  gid = netcdf_getConstant('NC_GLOBAL');
  for j = 1:length(s.Attributes)
    netcdf_putAtt(ncid,gid,s.Attributes(j).Name,s.Attributes(j).Value);
  endfor

  % variables
  for i = 1:length(s.Variables)  
    v = s.Variables(i);
    %v.Name
    % get dimension id
    dimids = zeros(length(v.Dimensions),1);
    for j = 1:length(v.Dimensions)
      dimids(j) = netcdf_inqDimID(ncid,v.Dimensions(j).Name);
    endfor
  
    % define variable
    dtype = oct2nctype(v.Datatype);
    varid = netcdf_defVar(ncid,v.Name,dtype,dimids);
  
    % define attributes
    for j = 1:length(v.Attributes)
      netcdf_putAtt(ncid,varid,v.Attributes(j).Name,v.Attributes(j).Value);
    endfor
  
    % define chunk size
    if isfield(v,'ChunkSize')
      if ~isempty(v.ChunkSize)
        netcdf_defVarChunking(ncid,varid,'chunked',v.ChunkSize);
      endif
    endif

    % define compression
    shuffle = false;
    deflatelevel = 0;

    if isfield(v,'Shuffle') 
      if ~isempty(v.Shuffle)    
        shuffle = v.Shuffle;
      endif
    endif
  
    if isfield(v,'DeflateLevel')
      if ~isempty(v.DeflateLevel)
        deflatelevel = v.DeflateLevel;
      endif
    endif
  
    if shuffle && defaltelevel != 0
      deflate = defaltelevel != 0;
      netcdf_defVarDeflate(ncid,varid,shuffle,deflate,deflatelevel);
    endif
    
    % define fill value
    if isfield(v,'FillValue')
      if ~isempty(v.FillValue)
        % leave nofill setting unchanged
        [nofill,fillval] = netcdf_inqVarFill(ncid,varid);      
        netcdf_defVarFill(ncid,varid,nofill,v.FillValue);
      endif
    endif

    % define checksum
    if isfield(v,'Checksum')
      if ~isempty(v.Checksum)
        netcdf_defVarFletcher32(ncid,varid,v.Checksum);
      endif
    endif

  endfor

  % groups
  if isfield(s,'Groups')
    if ~isempty(s.Groups)
      for i=1:length(s.Groups)
        g = s.Groups(i);
        gid = netcdf_defGrp(ncid,g.Name);
        write_group(gid,g);
      endfor
    endif
  endif

endfunction