octave-netcdf 1.0.11-3 / usr / share / octave / packages / netcdf-1.0.11 / ncwriteschema.m

## Copyright (C) 2013 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 2 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{shema})
##
## 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:
##
## @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);

end

function write_group(ncid,s)
% normalize schema

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

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

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

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

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

% 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);
end

% 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);
  end

  
  % 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);
  end
  
  % define chunk size
  if isfield(v,'ChunkSize')
    if ~isempty(v.ChunkSize)
      netcdf_defVarChunking(ncid,varid,'chunked',v.ChunkSize);
    end
  end

  % define compression
  shuffle = false;
  deflatelevel = 0;

  if isfield(v,'Shuffle') 
    if ~isempty(v.Shuffle)    
      shuffle = v.Shuffle;
    end
  end
  
  if isfield(v,'DeflateLevel')
    if ~isempty(v.DeflateLevel)
      deflatelevel = v.DeflateLevel;
    end
  end
  
  if shuffle && defaltelevel != 0
    deflate = defaltelevel != 0;
    netcdf_defVarDeflate(ncid,varid,shuffle,deflate,deflatelevel);
  end
    
  % 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);
    end
  end

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

% 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);
    end
  end
end   
end