source: trunk/src/read_field.m @ 1162

Last change on this file since 1162 was 1162, checked in by sommeria, 4 months ago

further cleaning
File size: 14.2 KB
Line 
1%'read_field': read the fields from files in different formats (netcdf files, images, video)
2%--------------------------------------------------------------------------
3%  function [Field,ParamOut,errormsg] = read_field(FileName,FileType,ParamIn,frame_index)
4%
5% OUTPUT:
6% Field: matlab structure representing the field
7% ParamOut: structure representing parameters:
8%        .FieldName; field name
9%        .VelType
10%        .CivStage: stage of civx processing (=0, not Civx, =1 (civ1), =2  (fix1)....
11%        .Npx,.Npy: for images, nbre of pixels in x and y
12% errormsg: error message, ='' by default
13%
14%INPUT
15% FileName: name of the input file
16% FileType: type of file, as determined by the function get_file_info.m
17% ParamIn: movie object or Matlab structure of input parameters
18%     .FieldName: name (char string) of the input field (for Civx data)
19%     .VelType: char string giving the type of velocity data ('civ1', 'filter1', 'civ2'...)
20%     .ColorVar: variable used for vector color
21%     .Npx, .Npy: nbre of pixels along x and y (used for .vol input files)
22%     .TimeDimName: name of the dimension considered as 'time', selected index value then set by input 'frame_index'
23% frame_index: frame number for movies or multidimensional netcdf files with dim >2
24%
25% see also read_image.m,read_civxdata.m,read_civdata.m,
26
27%=======================================================================
28% Copyright 2008-2024, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France
29%   http://www.legi.grenoble-inp.fr
30%   Joel.Sommeria - Joel.Sommeria (A) univ-grenoble-alpes.fr
31%
32%     This file is part of the toolbox UVMAT.
33%
34%     UVMAT is free software; you can redistribute it and/or modify
35%     it under the terms of the GNU General Public License as published
36%     by the Free Software Foundation; either version 2 of the license,
37%     or (at your option) any later version.
38%
39%     UVMAT is distributed in the hope that it will be useful,
40%     but WITHOUT ANY WARRANTY; without even the implied warranty of
41%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
42%     GNU General Public License (see LICENSE.txt) for more details.
43%=======================================================================
44
45function [Field,ParamOut,errormsg] = read_field(FileName,FileType,ParamIn,frame_index)
46%% default output and check input
47Field=[];
48if ~exist('frame_index','var')
49    frame_index=1;
50end
51if isempty(frame_index)
52    frame_index=1;
53end
54if ~exist('ParamIn','var')
55    ParamIn=[];
56end
57ParamOut=ParamIn;%default
58errormsg='';
59if isempty(regexp(FileName,'^http://', 'once'))&& ~exist(FileName,'file')
60    errormsg=['input file ' FileName ' does not exist'];
61    return
62end
63A=[];
64InputField={};
65check_colorvar=0;
66if isstruct(ParamIn)
67    if isfield(ParamIn,'FieldName')
68        if ischar(ParamIn.FieldName)
69            InputField={ParamIn.FieldName};
70        else
71            InputField= ParamIn.FieldName;
72        end
73    end
74    check_colorvar=zeros(size(InputField));
75    if isfield(ParamIn,'ColorVar')&&~isempty(ParamIn.ColorVar)
76        InputField=[ParamIn.FieldName {ParamIn.ColorVar}];
77        check_colorvar(numel(InputField))=1;
78    end
79end
80
81%% distingush different input file types
82switch FileType
83    case {'civdata','civdata_3D'}% new format for civ results
84        [Field,ParamOut.VelType,errormsg]=read_civdata(FileName,InputField,ParamIn.VelType,frame_index);
85        if ~isempty(errormsg),errormsg=['read_civdata / ' errormsg];return,end
86        ParamOut.CivStage=Field.CivStage;
87    case 'pivdata_fluidimage'
88        if ~isfield(ParamIn,'VelType')
89            ParamIn.VelType='';
90        end
91        [Field,ParamOut.VelType,errormsg]=read_pivdata_fluidimage(FileName,InputField,ParamIn.VelType);
92        ParamOut.CivStage=Field.CivStage;
93    case 'civx'% old (obsolete) format for civ results
94        ParamOut.FieldName='velocity';%Civx data found, set .FieldName='velocity' by default
95        [Field,ParamOut.VelType,errormsg]=read_civxdata(FileName,InputField,ParamIn.VelType);
96        if ~isempty(errormsg),errormsg=['read_civxdata / ' errormsg];return,end
97        ParamOut.CivStage=Field.CivStage;
98    case {'netcdf','mat'}% general netcdf file (not recognized as civ)
99        ListVarName={};
100        Role={};
101        ProjModeRequest={};
102        % scan the list InputField
103        Operator=cell(1,numel(InputField));
104        %InputVar=cell(1,numel(InputField));
105        for ilist=1:numel(InputField)
106            % look for input variables to read
107            r=regexp(InputField{ilist},'(?<Operator>(^vec|^norm))\((?<UName>.+),(?<VName>.+)\)$','names');
108            if isempty(r)%  no operator used
109                ListVarName=[ListVarName InputField(ilist)];%append the variable name
110                if check_colorvar(ilist)% case of field used for vector color
111                    Role{numel(ListVarName)}='ancillary';% not projected with interpolation
112                    ProjModeRequest{numel(ListVarName)}='';
113                else
114                    Role{numel(ListVarName)}='scalar';
115                    ProjModeRequest{numel(ListVarName)}='interp_lin';%scalar field (requires interpolation for plot)
116                end
117                Operator{numel(ListVarName)}='';
118            else  % an operator 'vec' or 'norm' is used
119                ListVarName=[ListVarName {r.UName}]; % append the variable in the list if not previously listed
120                if  strcmp(r.Operator,'norm')
121                    if check_colorvar(ilist)
122                    Role=[Role {'ancillary'}];
123                    else
124                       Role=[Role {'scalar'}];
125                    end
126                else
127                     Role=[Role {'vector_x'}];
128                end
129                ListVarName=[ListVarName {r.VName}];% append the variable in the list if not previously listed
130                Role=[Role {'vector_y'}];
131                Operator{numel(ListVarName)-1}=r.Operator;
132                Operator{numel(ListVarName)}='';           
133                if ~check_colorvar(ilist) && strcmp(r.Operator,'norm')
134                    ProjModeRequest{numel(ListVarName)}='interp_lin';%scalar field (requires interpolation for plot)
135                    ProjModeRequest{numel(ListVarName)-1}='interp_lin';%scalar field (requires interpolation for plot)
136                else
137                    ProjModeRequest{numel(ListVarName)}='';
138                    ProjModeRequest{numel(ListVarName)-1}='';
139                end
140            end
141        end
142        if ~isfield(ParamIn,'Coord_z')
143            ParamIn.Coord_z=[];
144        end
145        NbCoord=~isempty(ParamIn.Coord_x)+~isempty(ParamIn.Coord_y)+~isempty(ParamIn.Coord_z);
146        if isfield(ParamIn,'TimeDimName')% case of reading of a single time index in a multidimensional array
147            [Field,var_detect,ichoice,errormsg]=nc2struct(FileName,'TimeDimName',ParamIn.TimeDimName,frame_index,[ParamIn.Coord_x ParamIn.Coord_y ParamIn.Coord_z ListVarName]);
148        elseif isfield(ParamIn,'TimeVarName')% case of reading of a single time  in a multidimensional array
149            [Field,var_detect,ichoice,errormsg]=nc2struct(FileName,'TimeVarName',ParamIn.TimeVarName,frame_index,[ParamIn.Coord_x ParamIn.Coord_y ParamIn.Coord_z ListVarName]);
150            if numel(frame_index)~=1
151                NbCoord=NbCoord+1;% adds time coordinate, except if a single time has been selected
152            end
153        else
154            [Field,var_detect,ichoice,errormsg]=nc2struct(FileName,[ParamIn.Coord_x ParamIn.Coord_y ParamIn.Coord_z ListVarName]);
155        end
156        if ~isempty(errormsg)
157            return
158        end
159       % CheckStructured=1;
160        %scan all the variables
161        NbCoord=0;
162        if ~isempty(ParamIn.Coord_x)
163            index_Coord_x=strcmp(ParamIn.Coord_x,Field.ListVarName);
164            Field.VarAttribute{index_Coord_x}.Role='coord_x';%
165            NbCoord=NbCoord+1;
166        end
167        if ~isempty(ParamIn.Coord_y)
168            if ischar(ParamIn.Coord_y)
169                index_Coord_y=strcmp(ParamIn.Coord_y,Field.ListVarName);
170                Field.VarAttribute{index_Coord_y}.Role='coord_y';%
171                NbCoord=NbCoord+1;
172            else
173                for icoord_y=1:numel(ParamIn.Coord_y)
174                    index_Coord_y=strcmp(ParamIn.Coord_y{icoord_y},Field.ListVarName);
175                    Field.VarAttribute{index_Coord_y}.Role='coord_y';%
176                    NbCoord=NbCoord+1;
177                end
178            end
179        end
180        NbDim=1;
181        if ~isempty(ParamIn.Coord_z)
182            index_Coord_z=strcmp(ParamIn.Coord_z,Field.ListVarName);
183            Field.VarAttribute{index_Coord_z}.Role='coord_z';%
184            NbCoord=NbCoord+1;
185            NbDim=3;
186        elseif ~isempty(ParamIn.FieldName)
187            NbDim=2;
188        end
189        if numel(Field.ListVarName)>NbCoord % if there are variables beyond coord (exclude 1 D plots)
190            VarAttribute=cell(1,numel(ListVarName));
191            for ilist=1:numel(ListVarName)
192                index_var=find(strcmp(ListVarName{ilist},Field.ListVarName),1);
193                VarDimName{ilist}=Field.VarDimName{index_var};
194                DimOrder=[];
195                if NbDim ==2
196                    DimOrder=[find(strcmp(ParamIn.Coord_y,VarDimName{ilist})) find(strcmp(ParamIn.Coord_x,VarDimName{ilist}))];
197                elseif NbDim ==3
198                    DimOrder=[find(strcmp(ParamIn.Coord_z,VarDimName{ilist}))...
199                        find(strcmp(ParamIn.Coord_y,VarDimName{ilist}))...
200                        find(strcmp(ParamIn.Coord_x,VarDimName{ilist}))];
201                end
202                if numel(DimOrder)>=ndims(Field.(ListVarName{ilist}))
203                    Field.(ListVarName{ilist})=permute(Field.(ListVarName{ilist}),DimOrder);
204                    VarDimName{ilist}=VarDimName{ilist}(DimOrder);
205                end
206                if numel(Field.VarAttribute)>=index_var
207                VarAttribute{ilist}=Field.VarAttribute{index_var};% read var attributes from input if exist
208                end
209            end
210            check_remove=false(1,numel(Field.ListVarName));
211            for ilist=1:numel(ListVarName)
212                VarAttribute{ilist}.Role=Role{ilist};
213                VarAttribute{ilist}.ProjModeRequest=ProjModeRequest{ilist};
214                if isfield(ParamIn,'FieldName')
215                    VarAttribute{ilist}.Operator=Operator{ilist};
216                end
217                if strcmp(Operator{ilist},'norm')
218                    UName=ListVarName{ilist};
219                    VName=ListVarName{ilist+1};
220                    ListVarName{ilist}='norm';
221                    Field.norm=Field.(UName).*Field.(UName)+Field.(VName).*Field.(VName);
222                    Field.norm=sqrt(Field.norm);
223                    check_remove(ilist+1)=true;
224                    VarAttribute{ilist}.Operator='';
225                end
226            end
227            ListVarName(check_remove)=[];
228            VarDimName(check_remove)=[];
229            VarAttribute(check_remove)=[];
230            Field.ListVarName=[Field.ListVarName(1:NbCoord) ListVarName];% complement the list of vqriables, which may be listed twice
231            Field.VarDimName=[Field.VarDimName(1:NbCoord) VarDimName];
232            Field.VarAttribute=[Field.VarAttribute(1:NbCoord) VarAttribute];
233        end 
234    case 'video'
235        if isa(ParamIn,'VideoReader')
236            A=read(ParamIn,frame_index);
237        else
238            ParamOut=VideoReader(FileName);
239            A=read(ParamOut,frame_index);
240        end
241    case 'mmreader'
242        if isa(ParamIn,'mmreader')
243            A=read(ParamIn,frame_index);
244        else
245            ParamOut=mmreader(FileName);
246            A=read(ParamOut,frame_index);
247        end
248    case 'vol'
249        A=imread(FileName);
250        Npz=size(A,1)/ParamIn.Npy;
251        A=reshape(A',ParamIn.Npx,ParamIn.Npy,Npz);
252        A=permute(A,[3 2 1]);
253    case 'multimage'
254        A=imread(FileName,frame_index);
255    case 'image'
256        A=imread(FileName);
257    case 'rdvision'
258        [A,FileInfo,timestamps,errormsg]=read_rdvision(FileName,frame_index);
259    case 'image_DaVis'
260        Input=readimx(FileName);
261        if numel(Input.Frames)==1
262            frame_index=1;
263        end
264        A=Input.Frames{frame_index}.Components{1}.Planes{1}';
265        for ilist=1:numel(Input.Frames{1}.Attributes)
266            if strcmp(Input.Frames{1}.Attributes{ilist}.Name,'AcqTimeSeries')
267                timestamps=str2num(Input.Frames{1}.Attributes{ilist}.Value(1:end-3))/1000000;
268                break
269            end
270        end
271    case 'cine_phantom'
272        [A,FileInfo] = read_cine_phantom(FileName,frame_index );
273    otherwise
274        errormsg=[ FileType ': invalid input file type for uvmat'];
275       
276end
277
278%% case of image
279if ~isempty(A)
280    if strcmp(FileType,'rdvision')||strcmp(FileType,'image_DaVis')
281        Field.Time=timestamps;
282    end
283    if isstruct(ParamOut)
284        ParamOut.FieldName='image';
285    end
286    Npz=1;%default
287    npxy=size(A);
288    Field.NbDim=2;%default
289    Field.AName='image';
290    Field.ListVarName={'Coord_y','Coord_x','A'}; %
291    Field.VarAttribute{1}.Unit='pixel';
292    Field.VarAttribute{2}.Unit='pixel';
293    Field.VarAttribute{1}.Role='coord_y';
294    Field.VarAttribute{2}.Role='coord_x';
295    Field.VarAttribute{3}.Role='scalar';
296    if ndims(A)==3
297        if Npz==1%color
298            Field.VarDimName={'Coord_y','Coord_x',{'Coord_y','Coord_x','rgb'}}; %
299            Field.Coord_y=[npxy(1)-0.5 0.5];
300            Field.Coord_x=[0.5 npxy(2)-0.5]; % coordinates of the first and last pixel centers
301            if isstruct(ParamOut)
302                ParamOut.Npx=npxy(2);% display image size on the interface
303                ParamOut.Npy=npxy(1);
304            end
305        else
306            Field.NbDim=3;
307            Field.ListVarName=['AZ' Field.ListVarName];
308            Field.VarDimName={'AZ','Coord_y','Coord_x',{'AZ','Coord_y','Coord_x'}};
309            Field.AZ=[npxy(1)-0.5 0.5];
310            Field.Coord_y=[npxy(2)-0.5 0.5];
311            Field.Coord_x=[0.5 npxy(3)-0.5]; % coordinates of the first and last pixel centers
312            if isstruct(ParamOut)
313                ParamOut.Npx=npxy(3);% display image size on the interface
314                ParamOut.Npy=npxy(2);
315            end
316        end
317    else
318        Field.VarDimName={'Coord_y','Coord_x',{'Coord_y','Coord_x'}}; %
319        Field.Coord_y=[npxy(1)-0.5 0.5];
320        Field.Coord_x=[0.5 npxy(2)-0.5]; % coordinates of the first and last pixel centers
321    end
322    Field.A=A;
323    Field.CoordUnit='pixel'; %used for mouse_motion
324end
325
326
327
Note: See TracBrowser for help on using the repository browser.