source: trunk/src/series/turb_stat.m @ 1128

Last change on this file since 1128 was 1127, checked in by g7moreau, 5 months ago

Update Joel email

File size: 14.2 KB
RevLine 
[751]1%'aver_stat': calculate Reynolds steress components over time series
2%------------------------------------------------------------------------
3% function ParamOut=turb_stat(Param)
4%
5%%%%%%%%%%% GENERAL TO ALL SERIES ACTION FCTS %%%%%%%%%%%%%%%%%%%%%%%%%%%
6%
7%OUTPUT
8% ParamOut: sets options in the GUI series.fig needed for the function
9%
10%INPUT:
11% In run mode, the input parameters are given as a Matlab structure Param copied from the GUI series.
12% In batch mode, Param is the name of the corresponding xml file containing the same information
13% when Param.Action.RUN=0 (as activated when the current Action is selected
14% in series), the function ouput paramOut set the activation of the needed GUI elements
15%
16% Param contains the elements:(use the menu bar command 'export/GUI config' in series to
17% see the current structure Param)
18%    .InputTable: cell of input file names, (several lines for multiple input)
19%                      each line decomposed as {RootPath,SubDir,Rootfile,NomType,Extension}
20%    .OutputSubDir: name of the subdirectory for data outputs
21%    .OutputDirExt: directory extension for data outputs
22%    .Action: .ActionName: name of the current activated function
23%             .ActionPath:   path of the current activated function
24%             .ActionExt: fct extension ('.m', Matlab fct, '.sh', compiled   Matlab fct
25%             .RUN =0 for GUI input, =1 for function activation
26%             .RunMode='local','background', 'cluster': type of function  use
27%             
28%    .IndexRange: set the file or frame indices on which the action must be performed
29%    .FieldTransform: .TransformName: name of the selected transform function
30%                     .TransformPath:   path  of the selected transform function
31%    .InputFields: sub structure describing the input fields withfields
32%              .FieldName: name(s) of the field
33%              .VelType: velocity type
34%              .FieldName_1: name of the second field in case of two input series
35%              .VelType_1: velocity type of the second field in case of two input series
36%              .Coord_y: name of y coordinate variable
37%              .Coord_x: name of x coordinate variable
38%    .ProjObject: %sub structure describing a projection object (read from ancillary GUI set_object)
39%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
40
[810]41%=======================================================================
[1126]42% Copyright 2008-2024, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France
[810]43%   http://www.legi.grenoble-inp.fr
[1127]44%   Joel.Sommeria - Joel.Sommeria (A) univ-grenoble-alpes.fr
[810]45%
46%     This file is part of the toolbox UVMAT.
47%
48%     UVMAT is free software; you can redistribute it and/or modify
49%     it under the terms of the GNU General Public License as published
50%     by the Free Software Foundation; either version 2 of the license,
51%     or (at your option) any later version.
52%
53%     UVMAT is distributed in the hope that it will be useful,
54%     but WITHOUT ANY WARRANTY; without even the implied warranty of
55%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
56%     GNU General Public License (see LICENSE.txt) for more details.
57%=======================================================================
58
[751]59function ParamOut=turb_stat(Param)
60
61%% set the input elements needed on the GUI series when the action is selected in the menu ActionName
62if isstruct(Param) && isequal(Param.Action.RUN,0)
63    ParamOut.AllowInputSort='off';% allow alphabetic sorting of the list of input file SubDir (options 'off'/'on', 'off' by default)
64    ParamOut.WholeIndexRange='off';% prescribes the file index ranges from min to max (options 'off'/'on', 'off' by default)
[1082]65    ParamOut.NbSlice='on'; %nbre of slices ('on' if needed as input, fixed value e.g. 1, 'off' by default)
[751]66    ParamOut.VelType='one';% menu for selecting the velocity type (options 'off'/'one'/'two',  'off' by default)
[1031]67    ParamOut.FieldName='off';% menu for selecting the field (s) in the input file(options 'off'/'one'/'two', 'off' by default)
68    ParamOut.FieldTransform = 'off';%can use a transform function
[751]69    ParamOut.ProjObject='off';%can use projection object(option 'off'/'on',
70    ParamOut.Mask='off';%can use mask option   (option 'off'/'on', 'off' by default)
71    ParamOut.OutputDirExt='.staturb';%set the output dir extension
72    ParamOut.OutputFileMode='NbSlice';% '=NbInput': 1 output file per input file index, '=NbInput_i': 1 file per input file index i, '=NbSlice': 1 file per slice
73%     filecell=get_file_series(Param);%check existence of the first input file
74%     if ~exist(filecell{1,1},'file')
75%         msgbox_uvmat('WARNING','the first input file does not exist')
76%     end
77    return
78end
79
80%%%%%%%%%%%%  STANDARD PART  %%%%%%%%%%%%
81ParamOut=[];%default output
82%% read input parameters from an xml file if input is a file name (batch mode)
83checkrun=1;
84if ischar(Param)
85    Param=xml2struct(Param);% read Param as input file (batch case)
86    checkrun=0;
87end
88hseries=findobj(allchild(0),'Tag','series');
89RUNHandle=findobj(hseries,'Tag','RUN');%handle of RUN button in GUI series
90WaitbarHandle=findobj(hseries,'Tag','Waitbar');%handle of waitbar in GUI series
91
92%% define the directory for result file (with path=RootPath{1})
93OutputDir=[Param.OutputSubDir Param.OutputDirExt];
94   
95%% root input file(s) name, type and index series
96RootPath=Param.InputTable(:,1);
97RootFile=Param.InputTable(:,3);
98SubDir=Param.InputTable(:,2);
99NomType=Param.InputTable(:,4);
100FileExt=Param.InputTable(:,5);
101[filecell,i1_series,i2_series,j1_series,j2_series]=get_file_series(Param);
102%%%%%%%%%%%%
103% The cell array filecell is the list of input file names, while
104% filecell{iview,fileindex}:
105%        iview: line in the table corresponding to a given file series
106%        fileindex: file index within  the file series,
107% i1_series(iview,ref_j,ref_i)... are the corresponding arrays of indices i1,i2,j1,j2, depending on the input line iview and the two reference indices ref_i,ref_j
108% i1_series(iview,fileindex) expresses the same indices as a 1D array in file indices
109%%%%%%%%%%%% NbView=1 : a single input series
110NbView=numel(i1_series);%number of input file series (lines in InputTable)
111NbField_j=size(i1_series{1},1); %nb of fields for the j index (bursts or volume slices)
112NbField_i=size(i1_series{1},2); %nb of fields for the i index
113NbField=NbField_j*NbField_i; %total number of fields
114
115%% determine the file type on each line from the first input file
116NcTypeOptions={'netcdf','civx','civdata'};
117for iview=1:NbView
118    if ~exist(filecell{iview,1}','file')
119        msgbox_uvmat('ERROR',['the first input file ' filecell{iview,1} ' does not exist'])
120        return
121    end
[784]122    [FileInfo{iview},MovieObject{iview}]=get_file_info(filecell{iview,1});
[783]123    FileType{iview}=FileInfo{iview}.FileType;
[751]124    CheckNc{iview}=~isempty(find(strcmp(FileType{iview},NcTypeOptions)));% =1 for netcdf files
125    if ~isempty(j1_series{iview})
126        frame_index{iview}=j1_series{iview};
127    else
128        frame_index{iview}=i1_series{iview};
129    end
130end
131
132%% calibration data and timing: read the ImaDoc files
133XmlData=[];
134[XmlData,NbSlice_calib,time,errormsg]=read_multimadoc(RootPath,SubDir,RootFile,FileExt,i1_series,i2_series,j1_series,j2_series);
135if size(time,1)>1
136    diff_time=max(max(diff(time)));
137    if diff_time>0
138        msgbox_uvmat('WARNING',['times of series differ by (max) ' num2str(diff_time)])
139    end   
140end
141
142%% coordinate transform or other user defined transform
143transform_fct='';%default
144if isfield(Param,'FieldTransform')&&~isempty(Param.FieldTransform.TransformName)
145    addpath(Param.FieldTransform.TransformPath)
146    transform_fct=str2func(Param.FieldTransform.TransformName);
147    rmpath(Param.FieldTransform.TransformPath)
148end
149
150%%%%%%%%%%%% END STANDARD PART  %%%%%%%%%%%%
151 % EDIT FROM HERE
152
153%% settings for the output file
[1033]154FileExtOut='.nc';% write result as .nc files for netcdf inputs
[751]155NomTypeOut=nomtype2pair(NomType{1});% determine the index nomenclature type for the output file
156first_i=i1_series{1}(1);
157last_i=i1_series{1}(end);
158if isempty(j1_series{1})% if there is no second index j
159    first_j=1;last_j=1;
160else
161    first_j=j1_series{1}(1);
162    last_j=j1_series{1}(end);
163end
164
165%% Set field names and velocity types
166InputFields{1}=[];%default (case of images)
167if isfield(Param,'InputFields')
168    InputFields{1}=Param.InputFields;
169end
[1032]170if isempty(InputFields{1}.FieldName)
171    disp('ERROR: input fields U, V and posibly curl and div must be entered by get_field...')
172    return
173end
[751]174
175nbfiles=0;
176nbmissing=0;
177
178%initialisation
179DataOut.ListGlobalAttribute= {'Conventions'};
180DataOut.Conventions= 'uvmat';
[1082]181DataOut.ListVarName={};
182DataOut.VarDimName={};
[751]183DataOut.UMean=0;
184DataOut.VMean=0;
185DataOut.u2Mean=0;
186DataOut.v2Mean=0;
187DataOut.u2Mean_1=0;
188DataOut.v2Mean_1=0;
189DataOut.uvMean=0;
190DataOut.Counter=0;
[1032]191DataOut.CurlMean=0;
192DataOut.DivMean=0;
193DataOut.Curl2Mean=0;
194DataOut.Div2Mean=0;
[1077]195DataOut.KEflux=0;
[751]196U2Mean=0;
197V2Mean=0;
198UVMean=0;
199U2Mean_1=0;
200V2Mean_1=0;
[761]201Counter_1=0;
202
[751]203%%%%%%%%%%%%%%%% loop on field indices %%%%%%%%%%%%%%%%
[1100]204% for i_slice=1:Param.IndexRange.NbSlice
205%     i_slice
[1115]206    ind_first=Param.IndexRange.first_i;
[1100]207    for index_i=ind_first:Param.IndexRange.NbSlice:Param.IndexRange.last_i
208        if ~isempty(RUNHandle)&& ~strcmp(get(RUNHandle,'BusyAction'),'queue')
209            disp('program stopped by user')
210            break
211        end
[1115]212        for index_j=first_j:last_j
[1100]213            InputFile=fullfile_uvmat(RootPath{1},SubDir{1},RootFile{1},FileExt{1},NomType{1},index_i,index_i,index_j,index_j);
214            [Field,tild,errormsg] = read_field(InputFile,FileType{iview},InputFields{iview});
215           
216            %[Field,tild,errormsg] = read_field(filecell{1,index},FileType{iview},InputFields{iview},frame_index{iview}(index));
217           
218            %%%%%%%%%%%% MAIN RUNNING OPERATIONS  %%%%%%%%%%%%
[1115]219            if index_i==ind_first && index_j==first_j %initiate the output data structure in the first field
[1100]220                [CellInfo,NbDim,errormsg]=find_field_cells(Field);
221                YName='coord_y';%default
222                XName='coord_x';%default
223                for icell=1:numel(NbDim)
224                    if NbDim(icell)==2 && strcmp(CellInfo{icell}.CoordType,'grid')
225                        YName=CellInfo{icell}.YName;
226                        XName=CellInfo{icell}.XName;
227                        break
228                    end
229                end
230                DataOut.ListVarName={YName, XName ,'UMean' , 'VMean','u2Mean','v2Mean','u2Mean_1','v2Mean_1','uvMean','CurlMean','DivMean','Curl2Mean','Div2Mean','Counter'};
231                DataOut.VarDimName={YName,XName,{YName,XName},{YName,XName},{YName,XName},{YName,XName},{YName,XName},{YName,XName},...
232                    {YName,XName},{YName,XName},{YName,XName},{YName,XName},{YName,XName},{YName,XName}};
233                DataOut.(YName)=Field.(YName);
234                DataOut.(XName)=Field.(XName);
235                Uprev=Field.U;% store the current field for next iteration
236                Vprev=Field.V;
237                if isfield(Field,'FF')
238                    FFprev=Field.FF;% possible flag for false data
239                else
240                    %FFprev=true(size(Field.U));
241                    FFprev=isnan(Field.U);
242                end
[1082]243            end
[1100]244            FF=isnan(Field.U);%|Field.U<-60|Field.U>30;% threshold on U
245            DataOut.Counter=DataOut.Counter+ (~FF);% add 1 to the couter for non NaN point
246            Counter_1=Counter_1+(~FF & ~FFprev);
247            Field.U(FF)=0;% set to 0 the nan values
248            Field.V(FF)=0;
249            DataOut.UMean=DataOut.UMean+Field.U; %increment the sum
250            DataOut.VMean=DataOut.VMean+Field.V; %increment the sum
251           
252            U2Mean=U2Mean+(Field.U).*(Field.U); %increment the U squared sum
253            V2Mean=V2Mean+(Field.V).*(Field.V); %increment the V squared sum
254            UVMean=UVMean+(Field.U).*(Field.V); %increment the sum
255            U2Mean_1=U2Mean_1+(Field.U).*Uprev; %increment the U squared sum
256            V2Mean_1=V2Mean_1+(Field.V).*Vprev; %increment the V squared sum
257            Uprev=Field.U; %store for next iteration
258            Vprev=Field.V;
259            FFprev=FF;
260            if isfield(Field,'curl') && isfield(Field,'div')
261                Field.curl(FF)=0;% set to 0 the nan values
262                Field.div(FF)=0;
263                DataOut.CurlMean=DataOut.CurlMean+Field.curl;
264                DataOut.DivMean=DataOut.DivMean+Field.div;
265                DataOut.Curl2Mean=DataOut.Curl2Mean+Field.curl.*Field.curl;
266                DataOut.Div2Mean=DataOut.Div2Mean+Field.div.*Field.div;
267            end
[1082]268        end
[751]269    end
[1100]270    %%%%%%%%%%%%%%%% end loop on field indices %%%%%%%%%%%%%%%%
[1077]271   
[1100]272    DataOut.Counter(DataOut.Counter==0)=1;% put counter to 1 when it is zero
273    DataOut.UMean=DataOut.UMean./DataOut.Counter; % normalize the mean
274    DataOut.VMean=DataOut.VMean./DataOut.Counter; % normalize the mean
275    U2Mean=U2Mean./DataOut.Counter; % normalize the mean
276    V2Mean=V2Mean./DataOut.Counter; % normalize the mean
277    UVMean=UVMean./DataOut.Counter; % normalize the mean
278    U2Mean_1=U2Mean_1./Counter_1; % normalize the mean
279    V2Mean_1=V2Mean_1./Counter_1; % normalize the mean
280    DataOut.u2Mean=U2Mean-DataOut.UMean.*DataOut.UMean; % normalize the mean
281    DataOut.v2Mean=V2Mean-DataOut.VMean.*DataOut.VMean; % normalize the mean
282    DataOut.uvMean=UVMean-DataOut.UMean.*DataOut.VMean; % normalize the mean \
283    DataOut.u2Mean_1=U2Mean_1-DataOut.UMean.*DataOut.UMean; % normalize the mean
284    DataOut.v2Mean_1=V2Mean_1-DataOut.VMean.*DataOut.VMean; % normalize the mean
285    DataOut.CurlMean=DataOut.CurlMean./DataOut.Counter;
286    DataOut.DivMean=DataOut.DivMean./DataOut.Counter;
287    DataOut.Curl2Mean=DataOut.Curl2Mean./DataOut.Counter-DataOut.CurlMean.*DataOut.CurlMean;
288    DataOut.Div2Mean=DataOut.Div2Mean./DataOut.Counter-DataOut.DivMean.*DataOut.DivMean;   
289   
290    %% writing the result file as netcdf file
291    OutputFile=fullfile_uvmat(RootPath{1},OutputDir,RootFile{1},FileExtOut,NomTypeOut,ind_first,ind_first,first_j,last_j);
292    %case of netcdf input file , determine global attributes
293    errormsg=struct2nc(OutputFile,DataOut); %save result file
294    if isempty(errormsg)
295        disp([OutputFile ' written']);
296    else
297        disp(['error in writting result file: ' errormsg])
[1032]298    end
[1100]299   
[751]300% end
301%% open the result file with uvmat (in RUN mode)
[1095]302if checkrun && isequal(Param.IndexRange.NbSlice,1)
[751]303    uvmat(OutputFile)% open the last result file with uvmat
304end
Note: See TracBrowser for help on using the repository browser.