source: trunk/src/find_file_series.m

Last change on this file was 1093, checked in by g7moreau, 4 weeks ago
  • Update Copyright to 2021
File size: 15.8 KB
Line 
1%'find_file_series': check the content of an input file and find the corresponding file series
2%--------------------------------------------------------------------------
3% function [RootPath,SubDir,RootFile,i1_series,i2_series,j1_series,j2_series,NomType,FileInfo,Object,i1_input,i2_input,j1_input,j2_input]=find_file_series(FilePath,fileinput,checkxml)
4%
5% OUTPUT:
6% RootPath: path to the dir containing the input file
7% SubDir: data dir containing the input file series
8% RootFile: root file detected in fileinput, possibly modified for movies (indexing is then done on image view, not file)
9% i1_series(pair,ref_j+1, ref_i+1),i2_series,j1_series,j2_series: set of indices (i1,i2,j1,j2) sorted by ref index ref_i, ref_j, and pairindex in case of multiple pairs with the same ref
10%  (ref_i+1 is used to deal with the image index zero sometimes used)
11% NomType: nomenclature type corrected after checking the first file (problem of 0 before the number string)
12% FileInfo: structure containing info on the input files (assumed identical on the whole series)
13% FileInfo.FileType: type of file, =
14%       = 'image', usual image as recognised by Matlab
15%       = 'multimage', image series stored in a single file
16%       = 'civx', netcdf file with civx convention
17%       = 'civdata', civ data with new convention
18%       = 'netcdf' other netcdf files
19%       = 'video': movie recognised by VideoReader (e;g. avi)
20% MovieObject: video object (=[] otherwise
21% i1_input,i2_input,j1_input,j2_input: indices of the input file, or of the first file in the series if the input file does not exist
22%
23%INPUT
24% FilePath: path to the directory to be scanned
25% fileinput: name (without path) of the input file sample
26% checkxml: =1(default) take into account xml file existence to possibly include indexes in RootFile
27%           =0: do not take into account xml file existence
28
29%=======================================================================
30% Copyright 2008-2021, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France
31%   http://www.legi.grenoble-inp.fr
32%   Joel.Sommeria - Joel.Sommeria (A) legi.cnrs.fr
33%
34%     This file is part of the toolbox UVMAT.
35%
36%     UVMAT is free software; you can redistribute it and/or modify
37%     it under the terms of the GNU General Public License as published
38%     by the Free Software Foundation; either version 2 of the license,
39%     or (at your option) any later version.
40%
41%     UVMAT is distributed in the hope that it will be useful,
42%     but WITHOUT ANY WARRANTY; without even the implied warranty of
43%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
44%     GNU General Public License (see LICENSE.txt) for more details.
45%=======================================================================
46
47function [RootPath,SubDir,RootFile,i1_series,i2_series,j1_series,j2_series,NomType,FileInfo,MovieObject,i1_input,i2_input,j1_input,j2_input]=find_file_series(FilePath,fileinput,checkxml)
48%------------------------------------------------------------------------
49
50%% get input root name and info on the input file
51if isempty(regexp(FilePath,'^http://'))
52fullfileinput=fullfile(FilePath,fileinput);% input file name with path
53else
54  fullfileinput=[FilePath '/' fileinput];
55end
56[FileInfo,MovieObject]=get_file_info(fullfileinput);
57
58%% check for particular file types: images, movies, civ data
59[RootPath,SubDir,RootFile,i1_input,i2_input,j1_input,j2_input,FileExt,NomType]=fileparts_uvmat(fullfileinput);
60i1_series=zeros(1,1,1);
61i2_series=zeros(1,1,1);
62j1_series=zeros(1,1,1);
63j2_series=zeros(1,1,1);
64checkfileindexing=1;
65if isempty(regexp(FilePath,'^http://')) && ~exist(FilePath,'dir')
66    return % don't go further if the dir path does not exist
67end
68if checkfileindexing
69    NomTypePref='';
70    if isempty(NomType)||strcmp(NomType,'*')
71        if exist(fullfileinput,'file')
72            [tild,RootFile]=fileparts(fileinput);% case of constant name (no indexing), get the filename without its extension
73        else
74            RootFile='';
75        end
76    else
77        %% if checkxml=1, possibly include the first index in the root name, if there exists a corresponding xml file
78        if ~exist('checkxml','var')||checkxml
79            r=regexp(NomType,'^(?<tiretnum>_|\d+)','names');%look for a number or _1 at the beginning of NomType
80            if ~isempty(r) %if NomType begins by a number or _1
81                fileinput_end=regexprep(fileinput,['^' RootFile],'');%remove RootFile at the beginning of fileinput
82                if isempty(regexp(r.tiretnum,'^_','once'))% if a separator '_' is not  detected
83                    rr=regexp(fileinput_end,'^(?<i1>\d+)','names');
84                else% if a separator '_' is  detected
85                    rr=regexp(fileinput_end,'^(?<i1>_\d+)','names');
86                end
87                if ~isempty(rr)
88                    RootFile_i=[RootFile rr.i1];% new root file
89                    %look for an xml file correspoonding to the new root name
90                    if exist(fullfile(RootPath,SubDir,[RootFile_i '.xml']),'file') || (strcmp(FileExt,'.nc') && exist(fullfile(RootPath,[RootFile_i '.xml']),'file'))
91                        RootFile=RootFile_i;
92                        NomTypePref=r.tiretnum;
93                        NomType=regexprep(NomType,['^'  NomTypePref],'');
94                        i1_input=j1_input;
95                        i2_input=j2_input;
96                        j1_input=[];
97                        j2_input=[];
98                    end
99                end
100            end
101        end
102       
103        %% analyse the list of existing files when relevant
104        sep1='';
105        sep2='';
106        i1_str='(?<i1>)';%will set i1=[];
107        i1_star='';
108        i2_str='(?<i2>)';%will set i2=[];
109        i2_star='';
110        j1_str='(?<j1>)';%will set j1=[];
111        j1_star='';
112        j2_str='(?<j2>)';%will set j2=[];
113        j2_star='';
114        %Look for cases with letter indexing for the second index
115        r=regexp(NomType,'^(?<sep1>_?)(?<i1>\d+)(?<sep2>_?)(?<j1>[a|A])(?<j2>[b|B]?)$','names');
116        if ~isempty(r) %indexing image pair with letters
117            sep1=r.sep1;
118            sep2=r.sep2;
119            i1_str='(?<i1>\d+)';
120            i1_star='*';
121            if strcmp(lower(r.j1),r.j1)% lower case index
122                j1_str='(?<j1>[a-z])';
123            else
124                j1_str='(?<j1>[A-Z])'; % upper case index
125            end
126            j1_star='*';
127            if ~isempty(r.j2)
128                if strcmp(lower(r.j1),r.j1)
129                    j2_str='(?<j2>[a-z])';
130                else
131                    j2_str='(?<j2>[A-Z])';
132                end
133                j2_star='*';
134            end
135        else %numerical indexing
136            r=regexp(NomType,'^(?<sep1>_?)(?<i1>\d+)(?<i2>(-\d+)?)(?<j1>(_\d+)?)(?<j2>(-\d+)?)$','names');
137            if ~isempty(r)
138                sep1=r.sep1;
139                i1_str='(?<i1>\d+)';
140                i1_star='*';
141                if ~isempty(r.i2)
142                    i2_str='(?<i2>-\d+)';
143                    i2_star='-*';
144                end
145                if ~isempty(r.j1)
146                    j1_str='(?<j1>_\d+)';
147                    j1_star='_*';
148                end
149                if ~isempty(r.j2)
150                    j2_str='(?<j2>-\d+)';
151                    j2_star='-*';
152                end
153            end
154        end
155       
156        detect_string=['^' RootFile sep1 i1_str i2_str sep2 j1_str j2_str FileExt '$'];%string used in regexp to detect file indices
157        ListStruct=dir_uvmat(FilePath);% scan the content of the folder FilePath
158        ListCells=struct2cell(ListStruct);% transform dir struct to a cell arrray
159        ListFiles=ListCells(1,:);%list of file names
160        rr=regexp(ListFiles,detect_string,'names');
161        nbpair=numel(rr);
162        ref_i_list=zeros(1,nbpair);
163        ref_j_list=zeros(1,nbpair);
164        if nbpair==0% no detected file
165            RootFile='';
166        end
167        % scan the list of relevant files, extract the indices
168        for ifile=1:nbpair
169            %             rr=regexp(dirpair(ifile).name,detect_string,'names');
170            if ~isempty(rr{ifile})
171                i1=str2num(rr{ifile}.i1);
172                i2=str2num(regexprep(rr{ifile}.i2,'^-',''));
173                j1=stra2num(regexprep(rr{ifile}.j1,'^_',''));
174                j2=stra2num(regexprep(rr{ifile}.j2,'^-',''));
175                ref_i=i1;
176                if isempty(i2_input)
177                    if ~isempty(i2)% invalid file name if i2 does not exist in the input file
178                        break
179                    end
180                else
181                    ref_i=floor((i1+i2)/2);
182                end
183                ref_j=1;
184                if isempty(j1_input)
185                    if  ~isempty(j1)% invalid file name if j1 does not exist in the input file
186                        break
187                    end
188                else %j1_input is not empty
189                    if isempty(j1)% the detected name does not fit with the input
190                        break
191                    else
192                        ref_j=j1;
193                        if isempty(j2_input)
194                            if  ~isempty(j2)% invalid file name if j2 does not exist in the input file
195                                break
196                            end
197                        else
198                            ref_j=floor((j1+j2)/2);
199                        end
200                    end
201                end
202                % update the detected index series
203                if ~isempty(ref_i)&&~isempty(ref_j)
204                    ref_i_list(ifile)=ref_i;
205                    ref_j_list(ifile)=ref_j;
206                    nb_pairs=0;
207                    if ~isempty(i2_input)|| ~isempty(j2_input) %deals with  pairs
208                        if size(i1_series,1)>=ref_i+1 && size(i1_series,2)>=ref_j+1
209                            nb_pairs=numel(find(i1_series(ref_i+1,ref_j+1,:)~=0));
210                        end
211                    end
212                    if i1==0
213                        i1=-1;% set index 0 to -1 to distinguish from the absent index (set to 0)
214                    end
215                    if j1==0
216                        j1=-1;% set index 0 to -1 to distinguish from the absent index (set to 0)
217                    end
218                    i1_series(ref_i+1,ref_j+1,nb_pairs+1)=i1;
219                    if ~isempty(i2_input)
220                        i2_series(ref_i+1,ref_j+1,nb_pairs+1)=i2;
221                    end
222                    if ~isempty(j1_input)
223                        j1_series(ref_i+1,ref_j+1,nb_pairs+1)=j1;
224                    end
225                    if ~isempty(j2_input)
226                        j1_series(ref_i+1,ref_j+1,nb_pairs+1)=j1;
227                        j2_series(ref_i+1,ref_j+1,nb_pairs+1)=j2;
228                    end
229                end
230            end
231        end
232        % look for the numerical string of the first files to update the NomType (take into account the 0 before the number)
233        max_j=max(ref_j_list);
234        if isempty(max_j)
235            ref_ij=ref_i_list;
236        else
237            ref_ij=ref_i_list*max_j+ref_j_list; % ordered by index i, then by j for a given i.
238        end
239        ind_select=find(ref_ij>0);
240       
241        if ~isempty(ind_select)
242            [tild,ifile_min]=min(ref_ij(ind_select));
243            [tild,tild,tild,tild,tild,tild,tild,tild,NomType]=fileparts_uvmat(ListFiles{ind_select(ifile_min)});% update the representation of indices (number of 0 before the number)
244            NomType=regexprep(NomType,['^' NomTypePref],'');
245            %% update the file type if the input file does not exist (pb of 0001)
246            if isempty(FileInfo.FileType)
247                [FileInfo,MovieObject]=get_file_info(fullfile(FilePath,ListFiles{ifile_min}));
248            end
249        end
250        %         end
251    end
252   
253    %% set to empty array the irrelevant index series
254    if isequal(i1_series,0), i1_series=[]; end
255    if isequal(i2_series,0), i2_series=[]; end
256    if isequal(j1_series,0), j1_series=[]; end
257    if isequal(j2_series,0), j2_series=[]; end
258   
259    %% case of isolated input file, not member of an  indexed series
260    if isempty(i1_series)
261        [PathDir,RootFile]=fileparts(fullfileinput);
262        [RootPath,SubDir,DirExt]=fileparts(PathDir);
263        SubDir=[SubDir DirExt];% include part after . in the name (considered as a file extension)
264        NomType='*';
265        i2_series=[];j1_series=[];j2_series=[];
266        %         i1_input=1;i2_input=[];j1_input=[];j2_input=[];
267        if ~exist(fullfileinput,'file')
268            RootFile='';
269            return
270        end
271    end
272end
273
274%% introduce the frame index in case of movies or multimage type
275if isfield(FileInfo,'NumberOfFrames') && FileInfo.NumberOfFrames >1
276    if isempty(i1_series)% if there is no file index, i denotes the frame index
277        i1_series=zeros(FileInfo.NumberOfFrames+1,2);% first column =0
278        i1_series(:,2)=(0:FileInfo.NumberOfFrames)'; % second column=frame index -1
279        i1_input=1;
280        NomType='*';
281    else  % if there is a file index, j denotes the frame index while i denotes the file index
282        if ~isempty(regexp(NomType,'ab$', 'once'))% recognized as a pair
283            RootFile=fullfile_uvmat('','',RootFile,'',NomType,i1_input,i2_input,j1_input,j2_input);% restitute the root name without the detected indices
284            i1_series=zeros(FileInfo.NumberOfFrames+1,2);% first column =0
285            i1_series(:,2)=(0:FileInfo.NumberOfFrames)'; % second column=frame index -1
286            j1_series=[];
287            i1_input=1;
288            NomType='*';
289        else
290            i1_series=i1_series(:,2)*ones(1,FileInfo.NumberOfFrames);%
291            i1_series=[zeros(size(i1_series,1),1) i1_series];
292            j1_series=ones(size(i1_series,1),1)*(1:FileInfo.NumberOfFrames);%
293            j1_series=[zeros(size(i1_series,1),1) j1_series];
294            %  include the first index in the root name
295            r=regexp(NomType,'^(?<tiretnum>_?\d+)','names');%look for a number or _1 at the beginning of NomType
296            if ~isempty(r)
297                fileinput_end=regexprep(fileinput,['^' RootFile],'');%remove RootFile at the beginning of fileinput
298                if isempty(regexp(r.tiretnum,'^_','once'))% if a separator '_' is not  detected
299                    rr=regexp(fileinput_end,'^(?<i1>\d+)','names');
300                else% if a separator '_' is  detected
301                    rr=regexp(fileinput_end,'^(?<i1>_\d+)','names');
302                end
303                if ~isempty(rr)
304                    j1_input=1;
305                    j2_input=[];
306                end
307            end
308        end
309    end
310end
311
312%% sort pairs by decreasing index differences in case of multiple pairs at the same reference index
313if size(i2_series,3)>1 %pairs i1 -i2
314    diff_index=abs(i2_series-i1_series);
315    [tild,ind_pair]=sort(diff_index,3,'descend');
316    for ref_i=1:size(i1_series,1)
317        for ref_j=1:size(j1_series,2)
318            i1_series(ref_i,ref_j,:)=i1_series(ref_i,ref_j,ind_pair(ref_i,ref_j,:));
319            i2_series(ref_i,ref_j,:)=i2_series(ref_i,ref_j,ind_pair(ref_i,ref_j,:));
320            if ~isempty(j1_series)
321                j1_series(ref_i,ref_j,:)=j1_series(ref_i,ref_j,ind_pair(ref_i,ref_j,:));
322            end
323        end
324    end
325elseif size(j2_series,3)>1 %pairs j1 -j2
326    diff_index=abs(j2_series-j1_series);
327    [tild,ind_pair]=sort(diff_index,3,'descend');
328    for ref_i=1:size(i1_series,1)
329        for ref_j=1:size(j1_series,2)
330            i1_series(ref_i,ref_j,:)=i1_series(ref_i,ref_j,ind_pair(ref_i,ref_j,:));
331            if ~isempty(i2_series)
332                i2_series(ref_i,ref_j,:)=i2_series(ref_i,ref_j,ind_pair(ref_i,ref_j,:));
333            end
334            j1_series(ref_i,ref_j,:)=j1_series(ref_i,ref_j,ind_pair(ref_i,ref_j,:));
335            j2_series(ref_i,ref_j,:)=j2_series(ref_i,ref_j,ind_pair(ref_i,ref_j,:));
336        end
337    end
338end
339i1_series=permute(i1_series,[3 2 1]);% permute dimensions
340i2_series=permute(i2_series,[3 2 1]);% permute dimensions
341j1_series=permute(j1_series,[3 2 1]);% permute dimensions
342j2_series=permute(j2_series,[3 2 1]);% permute dimensions
Note: See TracBrowser for help on using the repository browser.