source: trunk/src/series/merge_proj.m @ 640

Last change on this file since 640 was 640, checked in by sommeria, 11 years ago

introduction of mask on projection: correction of merge_proj

File size: 16.4 KB
Line 
1%'merge_proj': concatene several fields from series, can project them on a regular grid in phys coordinates
2%------------------------------------------------------------------------
3% function ParamOut=merge_proj(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
41function ParamOut=merge_proj(Param)
42
43%% set the input elements needed on the GUI series when the function is selected in the menu ActionName or InputTable refreshed
44if isstruct(Param) && isequal(Param.Action.RUN,0)
45    ParamOut.AllowInputSort='off';% allow alphabetic sorting of the list of input file SubDir (options 'off'/'on', 'off' by default)
46    ParamOut.WholeIndexRange='off';% prescribes the file index ranges from min to max (options 'off'/'on', 'off' by default)
47    ParamOut.NbSlice='off'; %nbre of slices ('off' by default)
48    ParamOut.VelType='one';% menu for selecting the velocity type (options 'off'/'one'/'two',  'off' by default)
49    ParamOut.FieldName='one';% menu for selecting the field (s) in the input file(options 'off'/'one'/'two', 'off' by default)
50    ParamOut.FieldTransform = 'on';%can use a transform function
51    ParamOut.TransformPath=fullfile(fileparts(which('uvmat')),'transform_field');% path to transform functions (needed for compilation only)
52    ParamOut.ProjObject='on';%can use projection object(option 'off'/'on',
53    ParamOut.Mask='on';%can use mask option   (option 'off'/'on', 'off' by default)
54    ParamOut.OutputDirExt='.mproj';%set the output dir extension
55    ParamOut.OutputFileMode='NbInput';% '=NbInput': 1 output file per input file index, '=NbInput_i': 1 file per input file index i, '=NbSlice': 1 file per slice
56    filecell=get_file_series(Param);%check existence of the first input file
57    if ~exist(filecell{1,1},'file')
58        msgbox_uvmat('WARNING','the first input file does not exist')
59    elseif isequal(size(Param.InputTable,1),1) && ~isfield(Param,'ProjObject')
60        msgbox_uvmat('WARNING','You may need a projection object of type plane for merge_proj')
61    end
62    return
63end
64
65%%%%%%%%%%%% STANDARD PART (DO NOT EDIT) %%%%%%%%%%%%
66ParamOut=[]; %default output
67%% read input parameters from an xml file if input is a file name (batch mode)
68checkrun=1;
69if ischar(Param)
70    Param=xml2struct(Param);% read Param as input file (batch case)
71    checkrun=0;
72end
73hseries=findobj(allchild(0),'Tag','series');
74RUNHandle=findobj(hseries,'Tag','RUN');%handle of RUN button in GUI series
75WaitbarHandle=findobj(hseries,'Tag','Waitbar');%handle of waitbar in GUI series
76
77%% define the directory for result file (with path=RootPath{1})
78OutputDir=[Param.OutputSubDir Param.OutputDirExt];% subdirectory for output files
79
80if ~isfield(Param,'InputFields')
81    Param.InputFields.FieldName='';
82end
83
84%% root input file type
85RootPath=Param.InputTable(:,1);
86RootFile=Param.InputTable(:,3);
87SubDir=Param.InputTable(:,2);
88NomType=Param.InputTable(:,4);
89FileExt=Param.InputTable(:,5);
90[filecell,i1_series,i2_series,j1_series,j2_series]=get_file_series(Param);
91%%%%%%%%%%%%
92% The cell array filecell is the list of input file names, while
93% filecell{iview,fileindex}:
94%        iview: line in the table corresponding to a given file series
95%        fileindex: file index within  the file series,
96% 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
97% i1_series(iview,fileindex) expresses the same indices as a 1D array in file indices
98%%%%%%%%%%%%
99% NbSlice=1;%default
100% if isfield(Param.IndexRange,'NbSlice')&&~isempty(Param.IndexRange.NbSlice)
101%     NbSlice=Param.IndexRange.NbSlice;
102% end
103NbView=numel(i1_series);%number of input file series (lines in InputTable)
104NbField_j=size(i1_series{1},1); %nb of fields for the j index (bursts or volume slices)
105NbField_i=size(i1_series{1},2); %nb of fields for the i index
106NbField=NbField_j*NbField_i; %total number of fields
107
108%determine the file type on each line from the first input file
109ImageTypeOptions={'image','multimage','mmreader','video'};
110NcTypeOptions={'netcdf','civx','civdata'};
111for iview=1:NbView
112    if ~exist(filecell{iview,1}','file')
113        displ_uvmat('ERROR',['the first input file ' filecell{iview,1} ' does not exist'],checkrun)
114        return
115    end
116    [FileType{iview},FileInfo{iview},MovieObject{iview}]=get_file_type(filecell{iview,1});
117    CheckImage{iview}=~isempty(find(strcmp(FileType{iview},ImageTypeOptions)));% =1 for images
118    CheckNc{iview}=~isempty(find(strcmp(FileType{iview},NcTypeOptions)));% =1 for netcdf files
119    if ~isempty(j1_series{iview})
120        frame_index{iview}=j1_series{iview};
121    else
122        frame_index{iview}=i1_series{iview};
123    end
124end
125
126%% calibration data and timing: read the ImaDoc files
127[XmlData,NbSlice_calib,time,errormsg]=read_multimadoc(RootPath,SubDir,RootFile,FileExt,i1_series,i2_series,j1_series,j2_series);
128if size(time,1)>1
129    diff_time=max(max(diff(time)));
130    if diff_time>0
131        displ_uvmat('WARNING',['times of series differ by (max) ' num2str(diff_time)],checkrun)
132    end   
133end
134
135%% coordinate transform or other user defined transform
136transform_fct='';%default fct handle
137if isfield(Param,'FieldTransform')&&~isempty(Param.FieldTransform.TransformName)
138        currentdir=pwd;
139        cd(Param.FieldTransform.TransformPath)
140        transform_fct=str2func(Param.FieldTransform.TransformName);
141        cd (currentdir)
142end
143%%%%%%%%%%%% END STANDARD PART  %%%%%%%%%%%%
144 % EDIT FROM HERE
145
146%% check the validity of  input file types
147if CheckImage{1}
148    FileExtOut='.png'; % write result as .png images for image inputs
149elseif CheckNc{1}
150    FileExtOut='.nc';% write result as .nc files for netcdf inputs
151else
152    displ_uvmat('ERROR',['invalid file type input ' FileType{1}],checkrun)
153    return
154end
155for iview=1:NbView
156    if ~isequal(CheckImage{iview},CheckImage{1})||~isequal(CheckNc{iview},CheckNc{1})
157        displ_uvmat('ERROR','input set of input series: need  either netcdf either image series',checkrun)
158        return
159    end
160end
161NomTypeOut=NomType;% output file index will indicate the first and last ref index in the series
162
163%% Set field names and velocity types
164%use Param.InputFields for all views
165
166%% MAIN LOOP ON FIELDS
167%%%%%%%%%%%%% STANDARD PART (DO NOT EDIT) %%%%%%%%%%%%
168% for i_slice=1:NbSlice
169%     index_slice=i_slice:NbSlice:NbField;% select file indices of the slice
170%     NbFiles=0;
171%     nbmissing=0;
172
173    %%%%%%%%%%%%%%%% loop on field indices %%%%%%%%%%%%%%%%
174for index=1:NbField
175        update_waitbar(WaitbarHandle,index/NbField)
176    if ~isempty(RUNHandle) &&ishandle(RUNHandle) && ~strcmp(get(RUNHandle,'BusyAction'),'queue')
177        disp('program stopped by user')
178        return
179    end
180    %%%%%%%%%%%%%%%% loop on views (input lines) %%%%%%%%%%%%%%%%
181    Data=cell(1,NbView);%initiate the set Data
182    nbtime=0;
183    for iview=1:NbView
184        %% reading input file(s)
185        [Data{iview},tild,errormsg] = read_field(filecell{iview,index},FileType{iview},Param.InputFields,frame_index{iview}(index));
186        if ~isempty(errormsg)
187            disp(['ERROR in merge_proj/read_field/' errormsg])
188            return
189        end
190        timeread(iview)=0;
191        if isfield(Data{iview},'Time')
192            timeread(iview)=Data{iview}.Time;
193            nbtime=nbtime+1;
194        end
195        if ~isempty(NbSlice_calib)
196            Data{iview}.ZIndex=mod(i1_series{iview}(index)-1,NbSlice_calib{iview})+1;%Zindex for phys transform
197        end
198
199        %% transform the input field (e.g; phys) if requested (no transform involving two input fields)
200        if ~isempty(transform_fct)
201            if nargin(transform_fct)>=2
202                Data{iview}=transform_fct(Data{iview},XmlData{iview});
203            else
204                Data{iview}=transform_fct(Data{iview});
205            end
206        end
207       
208         %% calculate tps coefficients if needed
209        check_proj_tps= isfield(Param,'ProjObject')&&~isempty(Param.ProjObject)&& strcmp(Param.ProjObject.ProjMode,'interp_tps')&&~isfield(Data{iview},'Coord_tps');
210        Data{iview}=tps_coeff_field(Data{iview},check_proj_tps);
211
212        %% projection on object (gridded plane)
213        if Param.CheckObject
214            [Data{iview},errormsg]=proj_field(Data{iview},Param.ProjObject);
215            if ~isempty(errormsg)
216                disp(['ERROR in merge_proge/proj_field: ' errormsg])
217                return
218            end
219        end
220       
221        %% mask
222        if isfield(Param,'Mask')
223            %TODO: introduce a table of masks for multiple views
224            [MaskData{iview},tild,errormsg] = read_field(Param.Mask,'image');
225            if ~isempty(transform_fct) && nargin(transform_fct)>=2
226                    MaskData{iview}=transform_fct(MaskData,XmlData{iview});
227            end
228            [Data{iview},errormsg]=mask_proj(Data{iview},MaskData{iview});
229        end
230    end
231    %----------END LOOP ON VIEWS----------------------
232
233    %% merge the NbView fields
234    MergeData=merge_field(Data);
235    if isfield(MergeData,'Txt')
236        disp(MergeData.Txt);
237        return
238    end
239
240    % time of the merged field:
241    if ~isempty(time)% time defined from ImaDoc
242        timeread=time(:,index);
243    end
244    timeread=mean(timeread);
245
246    % generating the name of the merged field
247    i1=i1_series{iview}(index);
248    if ~isempty(i2_series{iview})
249        i2=i2_series{iview}(index);
250    else
251        i2=i1;
252    end
253    j1=1;
254    j2=1;
255    if ~isempty(j1_series{iview})
256        j1=j1_series{iview}(index);
257        if ~isempty(j2_series{iview})
258            j2=j2_series{iview}(index);
259        else
260            j2=j1;
261        end
262    end
263    OutputFile=fullfile_uvmat(RootPath{1},OutputDir,RootFile{1},FileExtOut,NomType{1},i1,i2,j1,j2);
264
265    % recording the merged field
266    if CheckImage{1}    %in case of input images an image is produced
267        if isa(MergeData.A,'uint8')
268            bitdepth=8;
269        elseif isa(MergeData.A,'uint16')
270            bitdepth=16;
271        end
272        imwrite(MergeData.A,OutputFile,'BitDepth',bitdepth);
273        %write xml calibration file
274        siz=size(MergeData.A);
275        npy=siz(1);
276        npx=siz(2);
277        if isfield(MergeData,'VarAttribute')&&isfield(MergeData.VarAttribute{1},'Coord_2')&&isfield(MergeData.VarAttribute{1},'Coord_1')
278            Rangx=MergeData.VarAttribute{1}.Coord_2;
279            Rangy=MergeData.VarAttribute{1}.Coord_1;
280        elseif isfield(MergeData,'AX')&& isfield(MergeData,'AY')
281            Rangx=[MergeData.AX(1) MergeData.AX(end)];
282            Rangy=[MergeData.AY(1) MergeData.AY(end)];
283        else
284            Rangx=[0.5 npx-0.5];
285            Rangy=[npy-0.5 0.5];%default
286        end
287        pxcmx=(npx-1)/(Rangx(2)-Rangx(1));
288        pxcmy=(npy-1)/(Rangy(1)-Rangy(2));
289        T_x=-pxcmx*Rangx(1)+0.5;
290        T_y=-pxcmy*Rangy(2)+0.5;
291        GeometryCal.focal=1;
292        GeometryCal.R=[pxcmx,0,0;0,pxcmy,0;0,0,1];
293        GeometryCal.Tx_Ty_Tz=[T_x T_y 1];
294        ImaDoc.GeometryCalib=GeometryCal;
295        %             t=struct2xml(ImaDoc);
296        %             t=set(t,1,'name','ImaDoc');
297        %             save(t,[filebase_merge '.xml'])
298        %             display([filebase_merge '.xml saved'])
299    else
300        MergeData.ListGlobalAttribute={'Conventions','Project','InputFile_1','InputFile_end','nb_coord','nb_dim','dt','Time','civ'};
301        MergeData.Conventions='uvmat';
302        MergeData.nb_coord=2;
303        MergeData.nb_dim=2;
304        dt=[];
305        if isfield(Data{1},'dt')&& isnumeric(Data{1}.dt)
306            dt=Data{1}.dt;
307        end
308        for iview =2:numel(Data)
309            if ~(isfield(Data{iview},'dt')&& isequal(Data{iview}.dt,dt))
310                dt=[];%dt not the same for all fields
311            end
312        end
313        if isempty(dt)
314            MergeData.ListGlobalAttribute(6)=[];
315        else
316            MergeData.dt=dt;
317        end
318        MergeData.Time=timeread;
319        error=struct2nc(OutputFile,MergeData);%save result file
320        if isempty(error)
321            display(['output file ' OutputFile ' written'])
322        else
323            display(error)
324        end
325    end
326end
327
328
329%'merge_field': concatene fields
330%------------------------------------------------------------------------
331function MergeData=merge_field(Data)
332%% default output
333if isempty(Data)||~iscell(Data)
334    MergeData=[];
335    return
336end
337MergeData=Data{1};%default
338error=0;
339NbView=length(Data);
340if NbView==1
341    return
342end
343
344%% group the variables (fields of 'Data') in cells of variables with the same dimensions
345[CellVarIndex,NbDim,VarTypeCell]=find_field_cells(Data{1});
346%LOOP ON GROUPS OF VARIABLES SHARING THE SAME DIMENSIONS
347% CellVarIndex=cells of variable index arrays
348for icell=1:length(CellVarIndex)
349    if NbDim(icell)==1
350        continue
351    end
352    VarIndex=CellVarIndex{icell};%  indices of the selected variables in the list FieldData.ListVarName
353    VarType=VarTypeCell{icell};
354    ivar_X=VarType.coord_x;
355    ivar_Y=VarType.coord_y;
356    ivar_FF=VarType.errorflag;
357    if isempty(ivar_X)
358        test_grid=1;%test for input data on regular grid (e.g. image)coordinates
359    else
360        if length(ivar_Y)~=1
361                displ_uvmat('ERROR','y coordinate missing in proj_field.m',checkrun)
362                return
363        end
364        test_grid=0;
365    end
366    %case of input fields with unstructured coordinates
367    if ~test_grid
368        for ivar=VarIndex
369            VarName=MergeData.ListVarName{ivar};
370            for iview=1:NbView
371                MergeData.(VarName)=[MergeData.(VarName); Data{iview}.(VarName)];
372            end
373        end
374    %case of fields defined on a structured  grid
375    else 
376        testFF=0;
377        for iview=2:NbView
378            for ivar=VarIndex
379                VarName=MergeData.ListVarName{ivar};
380                if isfield(MergeData,'VarAttribute')
381                    if length(MergeData.VarAttribute)>=ivar && isfield(MergeData.VarAttribute{ivar},'Role') && isequal(MergeData.VarAttribute{ivar}.Role,'errorflag')
382                        testFF=1;
383                    end
384                end
385                MergeData.(VarName)=MergeData.(VarName) + Data{iview}.(VarName);
386            end
387        end
388        if testFF
389            nbaver=NbView-MergeData.FF;
390            indgood=find(nbaver>0);
391            for ivar=VarIndex
392                VarName=MergeData.ListVarName{ivar};
393                MergeData.(VarName)(indgood)=double(MergeData.(VarName)(indgood))./nbaver(indgood);
394            end
395        else
396            for ivar=VarIndex
397                VarName=MergeData.ListVarName{ivar};
398                MergeData.(VarName)=double(MergeData.(VarName))./NbView;
399            end   
400        end
401    end
402end
403
404   
Note: See TracBrowser for help on using the repository browser.