[8] | 1 | %'nc2struct': transform a netcdf file in a corresponding matlab structure
|
---|
| 2 | % it reads all the global attributes and all variables, or a selected list.
|
---|
| 3 | % The corresponding dimensions and variable attributes are then extracted
|
---|
| 4 | %----------------------------------------------------------------------
|
---|
[755] | 5 | % function [Data,var_detect,ichoice,errormsg]=nc2struct(nc,varargin)
|
---|
[8] | 6 | %
|
---|
| 7 | % OUTPUT:
|
---|
| 8 | % Data: structure containing all the information of the netcdf file (or netcdf object)
|
---|
[140] | 9 | % with (optional)fields:
|
---|
| 10 | % .ListGlobalAttribute: cell listing the names of the global attributes
|
---|
[55] | 11 | % .Att_1,Att_2... : values of the global attributes
|
---|
| 12 | % .ListVarName: list of variable names to select (cell array of char strings {'VarName1', 'VarName2',...} )
|
---|
| 13 | % .VarDimName: list of dimension names for each element of .ListVarName (cell array of string cells)
|
---|
| 14 | % .Var1, .Var2....: variables (Matlab arrays) with names listed in .ListVarName
|
---|
[693] | 15 | % .ListDimName=list of dimension (added information, not requested for field description)
|
---|
| 16 | % .DimValue= vlalues of dimensions (added information, not requested for field description)
|
---|
| 17 | % .VarType= integers giving the type of variable as coded by netcdf= 2 for char, =4 for single,=( for double
|
---|
[140] | 18 | % var_detect: vector with same length as the cell array ListVarName, = 1 for each detected variable and 0 else.
|
---|
| 19 | % var_detect=[] in the absence of input cell array
|
---|
| 20 | % ichoice: index of the selected line in the case of multiple choice
|
---|
| 21 | % (cell array of varible names with multiple lines) , =[] by default
|
---|
[8] | 22 | %INPUT:
|
---|
[140] | 23 | % nc: name of a netcdf file (char string) or netcdf object
|
---|
| 24 | % additional arguments:
|
---|
[648] | 25 | % -no additional arguments: all the variables of the netcdf file are read.
|
---|
[140] | 26 | % -a cell array, ListVarName, made of char strings {'VarName1', 'VarName2',...} )
|
---|
[648] | 27 | % if ListVarName=[] or {}, no variable value is read (only global attributes and list of variables and dimensions)
|
---|
[140] | 28 | % if ListVarName is absent, or = '*', ALL the variables of the netcdf file are read.
|
---|
[747] | 29 | % if ListVarName is a cell array with n lines, the set of variables will be sought by order of priority in the list,
|
---|
| 30 | % while output names will be set by the first line
|
---|
| 31 | % - the string 'ListGlobalAttribute' followed by a list of attribute names: reads only these attributes (fast reading)
|
---|
[771] | 32 | % - the string 'TimeVarName', a string (the name of the variable considered as time), an integer or vector with integer values
|
---|
| 33 | % representing time indices to select for each variable, the cell of other input variable names.
|
---|
[747] | 34 | % - the string 'TimeDimName', a string (the name of the dimension considered as time), an integer or vector with integer values
|
---|
[771] | 35 | % representing time indices to select for each variable, the cell of other input variable names.
|
---|
[648] | 36 |
|
---|
[809] | 37 | %=======================================================================
|
---|
| 38 | % Copyright 2008-2014, LEGI UMR 5519 / CNRS UJF G-INP, Grenoble, France
|
---|
| 39 | % http://www.legi.grenoble-inp.fr
|
---|
| 40 | % Joel.Sommeria - Joel.Sommeria (A) legi.cnrs.fr
|
---|
| 41 | %
|
---|
[8] | 42 | % This file is part of the toolbox UVMAT.
|
---|
[809] | 43 | %
|
---|
[8] | 44 | % UVMAT is free software; you can redistribute it and/or modify
|
---|
[809] | 45 | % it under the terms of the GNU General Public License as published
|
---|
| 46 | % by the Free Software Foundation; either version 2 of the license,
|
---|
| 47 | % or (at your option) any later version.
|
---|
| 48 | %
|
---|
[8] | 49 | % UVMAT is distributed in the hope that it will be useful,
|
---|
| 50 | % but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 51 | % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
[809] | 52 | % GNU General Public License (see LICENSE.txt) for more details.
|
---|
| 53 | %=======================================================================
|
---|
[8] | 54 |
|
---|
[747] | 55 | function [Data,var_detect,ichoice,errormsg]=nc2struct(nc,varargin)
|
---|
| 56 | errormsg='';%default error message
|
---|
[55] | 57 | if isempty(varargin)
|
---|
[56] | 58 | varargin{1}='*';
|
---|
[8] | 59 | end
|
---|
| 60 | hhh=which('netcdf.open');% look for built-in matlab netcdf library
|
---|
| 61 |
|
---|
| 62 | if ~isequal(hhh,'')
|
---|
[140] | 63 | %% default output
|
---|
| 64 | Data=[];%default
|
---|
| 65 | var_detect=[];%default
|
---|
[8] | 66 | ichoice=[];%default
|
---|
[140] | 67 |
|
---|
| 68 | %% open the netcdf file for reading
|
---|
[747] | 69 | if ischar(nc)
|
---|
[8] | 70 | if exist(nc,'file')
|
---|
[150] | 71 | try
|
---|
[747] | 72 | nc=netcdf.open(nc,'NC_NOWRITE');
|
---|
| 73 | testfile=1;
|
---|
[227] | 74 | catch ME
|
---|
[747] | 75 | errormsg=['ERROR opening ' nc ': ' ME.message];
|
---|
| 76 | return
|
---|
[150] | 77 | end
|
---|
[8] | 78 | else
|
---|
[747] | 79 | errormsg=['ERROR:file ' nc ' does not exist'];
|
---|
| 80 | return
|
---|
[8] | 81 | end
|
---|
| 82 | else
|
---|
| 83 | testfile=0;
|
---|
| 84 | end
|
---|
[140] | 85 |
|
---|
[227] | 86 | %% short reading option for global attributes only, if the first argument is 'ListGlobalAttribute'
|
---|
[56] | 87 | if isequal(varargin{1},'ListGlobalAttribute')
|
---|
| 88 | for ilist=2:numel(varargin)
|
---|
[227] | 89 | valuestr=[];%default
|
---|
[45] | 90 | try
|
---|
[747] | 91 | valuestr = netcdf.getAtt(nc,netcdf.getConstant('NC_GLOBAL'),varargin{ilist});
|
---|
[227] | 92 | catch ME
|
---|
[45] | 93 | end
|
---|
[56] | 94 | eval(['Data.' varargin{ilist} '=valuestr;'])
|
---|
[8] | 95 | end
|
---|
| 96 | netcdf.close(nc)
|
---|
[747] | 97 | return
|
---|
[8] | 98 | end
|
---|
[648] | 99 |
|
---|
| 100 | %% time variable or dimension
|
---|
| 101 | input_index=1;
|
---|
[747] | 102 | CheckTimeVar=0;
|
---|
| 103 | TimeVarName='';
|
---|
[648] | 104 | if isequal(varargin{1},'TimeVarName')
|
---|
| 105 | TimeVarName=varargin{2};
|
---|
[747] | 106 | CheckTimeVar=1;
|
---|
| 107 | TimeIndex=varargin{3};
|
---|
| 108 | input_index=4;% list of varibles to read is at fourth argument
|
---|
[648] | 109 | elseif isequal(varargin{1},'TimeDimName')
|
---|
| 110 | TimeDimName=varargin{2};
|
---|
[747] | 111 | TimeIndex=varargin{3};
|
---|
[648] | 112 | input_index=4;
|
---|
| 113 | end
|
---|
[747] | 114 |
|
---|
[140] | 115 | %% full reading: get the nbre of dimensions, variables, global attributes
|
---|
[747] | 116 | ListVarName=varargin{input_index};
|
---|
[140] | 117 | [ndims,nvars,ngatts]=netcdf.inq(nc);%nbre of dimensions, variables, global attributes, in the netcdf file
|
---|
[8] | 118 |
|
---|
[140] | 119 | %% -------- read all global attributes (constants)-----------
|
---|
[8] | 120 | Data.ListGlobalAttribute={};%default
|
---|
[527] | 121 | att_key=cell(1,ngatts);%default
|
---|
[8] | 122 | for iatt=1:ngatts
|
---|
| 123 | keystr= netcdf.inqAttName(nc,netcdf.getConstant('NC_GLOBAL'),iatt-1);
|
---|
[227] | 124 | valuestr = netcdf.getAtt(nc,netcdf.getConstant('NC_GLOBAL'),keystr);
|
---|
| 125 | keystr=regexprep(keystr,{'\','/','\.','-',' '},{'','','','',''});%remove '\','.' or '-' if exists
|
---|
| 126 | if strcmp(keystr(1),'_')
|
---|
| 127 | keystr(1)=[];
|
---|
| 128 | end
|
---|
| 129 | try
|
---|
[236] | 130 | if ischar(valuestr) %& length(valuestr)<200 & double(valuestr)<=122 & double(valuestr)>=48 %usual characters
|
---|
[227] | 131 | eval(['Data.' keystr '=''' valuestr ''';'])
|
---|
[8] | 132 | elseif isnumeric(valuestr)
|
---|
| 133 | eval(['Data.' keystr '=valuestr;'])
|
---|
[227] | 134 | else
|
---|
[747] | 135 | eval(['Data.' keystr '='';'])
|
---|
[8] | 136 | end
|
---|
[227] | 137 | att_key{iatt}=keystr;
|
---|
| 138 | catch ME
|
---|
| 139 | att_key{iatt}=['attr_' num2str(iatt)];
|
---|
[527] | 140 | Data.(att_key{iatt})=[];
|
---|
[8] | 141 | end
|
---|
| 142 | end
|
---|
| 143 | Data.ListGlobalAttribute=att_key;
|
---|
[747] | 144 |
|
---|
[140] | 145 | %% -------- read dimension names-----------
|
---|
[527] | 146 | ListDimNameNetcdf=cell(1,ndims);
|
---|
| 147 | dim_value=zeros(1,ndims);
|
---|
[140] | 148 | for idim=1:ndims %loop on the dimensions of the netcdf file
|
---|
| 149 | [ListDimNameNetcdf{idim},dim_value(idim)] = netcdf.inqDim(nc,idim-1);%get name and value of each dimension
|
---|
[8] | 150 | end
|
---|
[747] | 151 | if ~isempty(ListDimNameNetcdf)
|
---|
[140] | 152 | flag_used=zeros(1,ndims);%initialize the flag indicating the selected dimensions in the list (0=unused)
|
---|
[8] | 153 | end
|
---|
[648] | 154 | if isequal(varargin{1},'TimeDimName')% time dimension introduced
|
---|
[747] | 155 | TimeDimIndex=find(strcmp(TimeDimName,ListDimNameNetcdf));
|
---|
[648] | 156 | if isempty(TimeDimIndex)
|
---|
[747] | 157 | errormsg=['requested time dimension ' varargin{2} ' not found'];
|
---|
[648] | 158 | return
|
---|
| 159 | end
|
---|
| 160 | if dim_value(TimeDimIndex)<varargin{3}
|
---|
[747] | 161 | errormsg=['requested time index ' num2str(varargin{3}) ' exceeds matrix dimension'];
|
---|
[648] | 162 | return
|
---|
| 163 | end
|
---|
[747] | 164 | end
|
---|
| 165 |
|
---|
[140] | 166 | %% -------- read names of variables -----------
|
---|
[527] | 167 | ListVarNameNetcdf=cell(1,nvars); %default
|
---|
| 168 | dimids=cell(1,nvars);
|
---|
| 169 | nbatt=zeros(1,nvars);
|
---|
[140] | 170 | for ncvar=1:nvars %loop on the variables of the netcdf file
|
---|
[747] | 171 | %get name, type, dimensions and attribute numbers of each variable
|
---|
[693] | 172 | [ListVarNameNetcdf{ncvar},xtype(ncvar),dimids{ncvar},nbatt(ncvar)] = netcdf.inqVar(nc,ncvar-1);
|
---|
[747] | 173 | end
|
---|
| 174 | % testmulti=0;
|
---|
[140] | 175 | if isequal(ListVarName,'*')||isempty(ListVarName)
|
---|
[747] | 176 | var_index=1:nvars; %all the variables are selected in the netcdf file
|
---|
[140] | 177 | Data.ListVarName=ListVarNameNetcdf;
|
---|
| 178 | else %select input variables, if requested by the input ListVarName
|
---|
[527] | 179 | check_keep=ones(1,size(ListVarName,2));
|
---|
| 180 | for ivar=1:size(ListVarName,2) % check redondancy of variable names
|
---|
| 181 | if ~isempty(find(strcmp(ListVarName{1,ivar},ListVarName(1:ivar-1)), 1))
|
---|
| 182 | check_keep(ivar)=0;% the variable #ivar is already in the list
|
---|
[517] | 183 | end
|
---|
| 184 | end
|
---|
[747] | 185 | ListVarName=ListVarName(:,logical(check_keep));
|
---|
[748] | 186 | if size(ListVarName,1)>1 %multiple choice of variable ranked by order of priority
|
---|
| 187 | for iline=1:size(ListVarName,1)
|
---|
[140] | 188 | search_index=find(strcmp(ListVarName{iline,1},ListVarNameNetcdf),1);%look for the first variable name in the list of netcdf variables
|
---|
| 189 | if ~isempty(search_index)
|
---|
| 190 | break % go to the next line
|
---|
[8] | 191 | end
|
---|
| 192 | end
|
---|
[140] | 193 | ichoice=iline-1;%selected line number in the list of input names of variables
|
---|
| 194 | else
|
---|
| 195 | iline=1;
|
---|
[8] | 196 | end
|
---|
[747] | 197 | %ListVarName=ListVarName(iline,:);% select the appropriate option for input variable (lin ein the input name matrix)
|
---|
| 198 | if CheckTimeVar
|
---|
| 199 | TimeVarIndex=find(strcmp(TimeVarName,ListVarNameNetcdf),1); %look for the index of the time variable in the netcdf list
|
---|
| 200 | if isempty(TimeVarIndex)
|
---|
| 201 | errormsg='requested variable for time is missing';
|
---|
| 202 | return
|
---|
| 203 | end
|
---|
| 204 | TimeDimIndex=dimids{TimeVarIndex}(1)+1;
|
---|
| 205 | ListVarName=[ListVarName {TimeVarName}];
|
---|
| 206 | end
|
---|
[748] | 207 | var_index=zeros(1,size(ListVarName,2));%default list of variable indices
|
---|
[747] | 208 | for ivar=1:size(ListVarName,2)
|
---|
[140] | 209 | search_index=find(strcmp(ListVarName{iline,ivar},ListVarNameNetcdf),1);%look for the variable name in the list of netcdf file
|
---|
| 210 | if ~isempty(search_index)
|
---|
| 211 | var_index(ivar)=search_index;%index of the netcdf list corresponding to the input list index ivar
|
---|
[8] | 212 | end
|
---|
| 213 | end
|
---|
[747] | 214 | var_detect=(var_index~=0);%=1 for detected variables
|
---|
[140] | 215 | list_index=find(var_index);% indices in the input list corresponding to a detected variable
|
---|
| 216 | var_index=var_index(list_index);% netcdf variable indices corresponding to the output list of read variable
|
---|
| 217 | Data.ListVarName=ListVarName(1,list_index);%the first line of ListVarName sets the output names of the variables
|
---|
[8] | 218 | end
|
---|
[747] | 219 |
|
---|
| 220 | %% get the dimensions and attributes associated to variables
|
---|
| 221 | var_dim=cell(size(var_index));% initiate list of dimensions for variables
|
---|
[140] | 222 | for ivar=1:length(var_index)
|
---|
| 223 | var_dim{ivar}=dimids{var_index(ivar)}+1; %netcdf dimension indices used by the variable #ivar
|
---|
| 224 | Data.VarDimName{ivar}=ListDimNameNetcdf(var_dim{ivar});
|
---|
| 225 | flag_used(var_dim{ivar})=ones(size(var_dim{ivar}));%flag_used =1 for the indices of used dimensions
|
---|
[8] | 226 | for iatt=1:nbatt(var_index(ivar))
|
---|
| 227 | attname = netcdf.inqAttName(nc,var_index(ivar)-1,iatt-1);
|
---|
| 228 | valuestr= netcdf.getAtt(nc,var_index(ivar)-1,attname);
|
---|
[227] | 229 | attname=regexprep(attname,{'\','/','\.','-',' '},{'','','','',''});%remove '\','.' or '-' if exists
|
---|
| 230 | if strcmp(attname(1),'_')
|
---|
| 231 | attname(1)=[];
|
---|
| 232 | end
|
---|
| 233 | try
|
---|
[747] | 234 | if isempty(valuestr)
|
---|
| 235 | Data.VarAttribute{ivar}.(attname)=valuestr;
|
---|
| 236 | end
|
---|
[227] | 237 | catch ME
|
---|
| 238 | display(attname)
|
---|
| 239 | display(valuestr)
|
---|
[747] | 240 | display(ME.message)
|
---|
[693] | 241 | Data.VarAttribute{ivar}.(['atrr_' num2str(iatt)])='not read';
|
---|
[227] | 242 | end
|
---|
[8] | 243 | end
|
---|
| 244 | end
|
---|
[648] | 245 |
|
---|
[140] | 246 | %% select the dimensions used for the set of input variables
|
---|
[747] | 247 | if ~isempty(var_index)
|
---|
| 248 | dim_index=find(flag_used);%list of netcdf dimensions indices corresponding to used dimensions
|
---|
| 249 | Data.ListDimName=ListDimNameNetcdf(dim_index);
|
---|
[421] | 250 | Data.DimValue=dim_value(dim_index);
|
---|
[747] | 251 | if input_index==4% if a dimension is selected as time
|
---|
| 252 | Data.DimValue(TimeDimIndex)=numel(TimeIndex);
|
---|
| 253 | end
|
---|
[8] | 254 | end
|
---|
[140] | 255 |
|
---|
| 256 | %% get the values of the input variables
|
---|
[8] | 257 | if ~isempty(ListVarName)
|
---|
[140] | 258 | for ivar=1:length(var_index)
|
---|
[8] | 259 | VarName=Data.ListVarName{ivar};
|
---|
[747] | 260 | VarName=regexprep(VarName,'-','_'); %suppress '-' if it exists in the netcdf variable name (leads to errors in matlab)
|
---|
| 261 | % CheckSub=0;
|
---|
[648] | 262 | if input_index==4% if a dimension is selected as time
|
---|
[747] | 263 | ind_vec=zeros(1,numel(var_dim{ivar}));% vector with zeros corresponding to al the dimensions of the variable VarName
|
---|
[756] | 264 | ind_size=dim_value(var_dim{ivar});% vector giving the size (for each dimension) of the variable VarName
|
---|
[747] | 265 | index_time=find(var_dim{ivar}==TimeDimIndex);
|
---|
| 266 | if ~isempty(index_time)
|
---|
[756] | 267 | if ind_size(index_time)<max(TimeIndex)
|
---|
| 268 | errormsg=['requested index ' num2str(TimeIndex) ' exceeds matrix dimension'];
|
---|
| 269 | return
|
---|
| 270 | end
|
---|
[747] | 271 | ind_vec(index_time)=TimeIndex-1;% selected index(or indices) to read
|
---|
| 272 | ind_size(index_time)=numel(TimeIndex);%length of the selected set of time indices
|
---|
| 273 | if numel(TimeIndex)==1 && ~strcmp(VarName,TimeVarName)
|
---|
| 274 | Data.VarDimName{ivar}(index_time)=[];% for a single selected time remove the time in the list of dimensions (except for tTime itself)
|
---|
| 275 | end
|
---|
| 276 | end
|
---|
| 277 | Data.(VarName)=double(netcdf.getVar(nc,var_index(ivar)-1,ind_vec,ind_size)); %read the variable data
|
---|
| 278 | Data.(VarName)=squeeze(Data.(VarName));%remove singeton dimension
|
---|
| 279 | else
|
---|
| 280 | Data.(VarName)=netcdf.getVar(nc,var_index(ivar)-1); %read the whole variable data
|
---|
[648] | 281 | end
|
---|
[747] | 282 | if xtype(var_index(ivar))==5
|
---|
[693] | 283 | Data.(VarName)=double(Data.(VarName)); %transform to double for single pecision
|
---|
[648] | 284 | end
|
---|
[8] | 285 | end
|
---|
| 286 | end
|
---|
[693] | 287 | Data.VarType=xtype(var_index);
|
---|
[140] | 288 |
|
---|
| 289 | %% -------- close fle-----------
|
---|
[8] | 290 | if testfile==1
|
---|
[747] | 291 | netcdf.close(nc)
|
---|
[8] | 292 | end
|
---|
[140] | 293 |
|
---|
[747] | 294 | %% old netcdf library
|
---|
[8] | 295 | else
|
---|
| 296 | [Data,var_detect,ichoice]=nc2struct_toolbox(nc,varargin);
|
---|
[801] | 297 | end
|
---|