source: trunk/src/transform_field/phys.m @ 977

Last change on this file since 977 was 977, checked in by g7moreau, 4 years ago
  • Update Copyright 2008-2017 notice
File size: 9.7 KB
Line 
1%'phys': transforms image (Unit='pixel') to real world (phys) coordinates using geometric calibration parameters.  It acts if the input field contains the tag 'CoordTUnit' with value 'pixel'
2%------------------------------------------------------------------------
3%%%%  Use the general syntax for transform fields %%%%
4% OUTPUT:
5% DataOut:   output field structure
6%
7%INPUT:
8% DataIn:  first input field structure
9% XmlData: first input parameter structure,
10%        .GeometryCalib: substructure of the calibration parameters
11% DataIn_1: optional second input field structure
12% XmlData_1: optional second input parameter structure
13%         .GeometryCalib: substructure of the calibration parameters
14
15%=======================================================================
16% Copyright 2008-2017, LEGI UMR 5519 / CNRS UGA G-INP, Grenoble, France
17%   http://www.legi.grenoble-inp.fr
18%   Joel.Sommeria - Joel.Sommeria (A) legi.cnrs.fr
19%
20%     This file is part of the toolbox UVMAT.
21%
22%     UVMAT is free software; you can redistribute it and/or modify
23%     it under the terms of the GNU General Public License as published
24%     by the Free Software Foundation; either version 2 of the license,
25%     or (at your option) any later version.
26%
27%     UVMAT is distributed in the hope that it will be useful,
28%     but WITHOUT ANY WARRANTY; without even the implied warranty of
29%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30%     GNU General Public License (see LICENSE.txt) for more details.
31%=======================================================================
32
33function DataOut=phys(DataIn,XmlData,DataIn_1,XmlData_1)
34%------------------------------------------------------------------------
35
36% A FAIRE: 1- verifier si DataIn est une 'field structure'(.ListVarName'):
37% chercher ListVarAttribute, for each field (cell of variables):
38%   .CoordType: 'phys' or 'px'   (default==phys, no transform)
39%   .scale_factor: =dt (to transform displacement into velocity) default=1
40%   .covariance: 'scalar', 'coord', 'D_i': covariant (like velocity), 'D^i': contravariant (like gradient), 'D^jD_i' (like strain tensor)
41%   (default='coord' if .Role='coord_x,_y...,
42%            'D_i' if '.Role='vector_x,...',
43%              'scalar', else (thenno change except scale factor)
44
45DataOut=[];
46DataOut_1=[]; %default second  output field
47if isfield(DataIn,'Action') && isfield(DataIn.Action,'RUN') && isequal(DataIn.Action.RUN,0)
48    if isfield(XmlData,'GeometryCalib')&& isfield(XmlData.GeometryCalib,'CoordUnit')
49        DataOut.CoordUnit=XmlData.GeometryCalib.CoordUnit;% states that the output is in unit defined by GeometryCalib, then erased all projection objects with different units
50    end
51    return
52end
53
54%% analyse input and set default output
55DataOut=DataIn;%default first output field
56if nargin>=2 % nargin =nbre of input variables
57    if isfield(XmlData,'GeometryCalib')
58        Calib{1}=XmlData.GeometryCalib;
59    else
60        Calib{1}=[];
61    end
62    if nargin>=3  %two input fields
63        DataOut_1=DataIn_1;%default second output field
64        if nargin>=4 && isfield(XmlData_1,'GeometryCalib')
65            Calib{2}=XmlData_1.GeometryCalib;
66        else
67            Calib{2}=Calib{1};
68        end
69    end
70end
71
72%% get the z index defining the section plane
73if isfield(DataIn,'ZIndex')&&~isempty(DataIn.ZIndex)&&~isnan(DataIn.ZIndex)
74    ZIndex=DataIn.ZIndex;
75else
76    ZIndex=1;
77end
78
79%% transform first field
80iscalar=0;% counter of scalar fields
81if  ~isempty(Calib{1})
82    if ~isfield(Calib{1},'CalibrationType')||~isfield(Calib{1},'CoordUnit')
83        return %bad calib parameter input
84    end
85    if ~(isfield(DataIn,'CoordUnit')&& strcmp(DataIn.CoordUnit,'pixel'))
86        return % transform only fields in pixel coordinates
87    end
88    DataOut=phys_1(DataIn,Calib{1},ZIndex);% transform coordinates and velocity components
89    %case of images or scalar: in case of two input fields, we need to project the transform  on the same regular grid
90    if isfield(DataIn,'A') && isfield(DataIn,'Coord_x') && ~isempty(DataIn.Coord_x) && isfield(DataIn,'Coord_y')&&...
91                                           ~isempty(DataIn.Coord_y) && length(DataIn.A)>1
92        iscalar=1;
93        A{1}=DataIn.A;
94    end
95end
96
97%% document the selected  plane position and angle if relevant
98if isfield(Calib{1},'SliceCoord')&&size(Calib{1}.SliceCoord,1)>=ZIndex
99    DataOut.PlaneCoord=Calib{1}.SliceCoord(ZIndex,:);% transfer the slice position corresponding to index ZIndex
100    if isfield(Calib{1},'SliceAngle') % transfer the slice rotation angles
101        if isequal(size(Calib{1}.SliceAngle,1),1)% case of a unique angle
102            DataOut.PlaneAngle=Calib{1}.SliceAngle;
103        else  % case of multiple planes with different angles: select the plane with index ZIndex
104            DataOut.PlaneAngle=Calib{1}.SliceAngle(ZIndex,:);
105        end
106    end
107end
108
109%% transform second field if relevant
110if ~isempty(DataOut_1)
111    if isfield(DataIn_1,'ZIndex') && ~isequal(DataIn_1.ZIndex,ZIndex)
112        DataOut_1.Txt='different plane indices for the two input fields';
113        return
114    end
115    if ~isfield(Calib{2},'CalibrationType')||~isfield(Calib{2},'CoordUnit')
116        return %bad calib parameter input
117    end
118    if (isfield(DataIn_1,'CoordUnit')&& strcmp(DataIn_1.CoordUnit,'pixel'))
119        DataOut_1=phys_1(DataOut_1,Calib{2},ZIndex);
120    end
121    if isfield(Calib{1},'SliceCoord')
122        if ~(isfield(Calib{2},'SliceCoord') && isequal(Calib{2}.SliceCoord,Calib{1}.SliceCoord))
123            DataOut_1.Txt='different plane positions for the two input fields';
124            return
125        end
126        DataOut_1.PlaneCoord=DataOut.PlaneCoord;% same plane position for the two input fields
127        if isfield(Calib{1},'SliceAngle')
128            if ~(isfield(Calib{2},'SliceAngle') && isequal(Calib{2}.SliceAngle,Calib{1}.SliceAngle))
129                DataOut_1.Txt='different plane angles for the two input fields';
130                return
131            end
132            DataOut_1.PlaneAngle=DataOut.PlaneAngle; % same plane angle for the two input fields
133        end
134    end
135    if isfield(DataIn_1,'A')&&isfield(DataIn_1,'Coord_x')&&~isempty(DataIn_1.Coord_x) && isfield(DataIn_1,'Coord_y')&&...
136            ~isempty(DataIn_1.Coord_y)&&length(DataIn_1.A)>1
137        iscalar=iscalar+1;
138        Calib{iscalar}=Calib{2};
139        A{iscalar}=DataIn_1.A;
140    end
141end
142
143%% transform the scalar(s) or image(s)
144if iscalar~=0
145    [A,Coord_x,Coord_y]=phys_ima(A,XmlData,ZIndex);%TODO : introduire interp2_uvmat ds phys_ima
146    if iscalar==1 && ~isempty(DataOut_1) % case for which only the second field is a scalar
147         DataOut_1.A=A{1};
148         DataOut_1.Coord_x=Coord_x;
149         DataOut_1.Coord_y=Coord_y;
150    else
151        DataOut.A=A{1};
152        DataOut.Coord_x=Coord_x;
153        DataOut.Coord_y=Coord_y;
154    end
155    if iscalar==2
156        DataOut_1.A=A{2};
157        DataOut_1.Coord_x=Coord_x;
158        DataOut_1.Coord_y=Coord_y;
159    end
160end
161
162% subtract fields
163if ~isempty(DataOut_1)
164    DataOut=sub_field(DataOut,[],DataOut_1);
165end
166%------------------------------------------------
167%--- transform a single field
168function DataOut=phys_1(Data,Calib,ZIndex)
169%------------------------------------------------
170%% set default output
171DataOut=Data;%default
172DataOut.CoordUnit=Calib.CoordUnit;% the output coord unit is set by the calibration parameters
173
174%% transform  X,Y coordinates for velocity fields (transform of an image or scalar done in phys_ima)
175if isfield(Data,'X') &&isfield(Data,'Y')&&~isempty(Data.X) && ~isempty(Data.Y)
176  [DataOut.X,DataOut.Y]=phys_XYZ(Calib,Data.X,Data.Y,ZIndex);
177    Dt=1; %default
178    if isfield(Data,'dt')&&~isempty(Data.dt)
179        Dt=Data.dt;
180    end
181    if isfield(Data,'Dt')&&~isempty(Data.Dt)
182        Dt=Data.Dt;
183    end
184    if isfield(Data,'U')&&isfield(Data,'V')&&~isempty(Data.U) && ~isempty(Data.V)
185        [XOut_1,YOut_1]=phys_XYZ(Calib,Data.X-Data.U/2,Data.Y-Data.V/2,ZIndex);
186        [XOut_2,YOut_2]=phys_XYZ(Calib,Data.X+Data.U/2,Data.Y+Data.V/2,ZIndex);
187        DataOut.U=(XOut_2-XOut_1)/Dt;
188        DataOut.V=(YOut_2-YOut_1)/Dt;
189    end
190end
191
192%% suppress tps
193list_tps={'Coord_tps'  'U_tps'  'V_tps'  'SubRange'  'NbSites'};
194ind_remove=[];
195for ilist=1:numel(list_tps)
196    ind_tps=find(strcmp(list_tps{ilist},Data.ListVarName));
197    if ~isempty(ind_tps)
198        ind_remove=[ind_remove ind_tps];
199        DataOut=rmfield(DataOut,list_tps{ilist});
200    end
201end
202if isfield(DataOut,'VarAttribute') && numel(DataOut.VarAttribute)>=3 && isfield(DataOut.VarAttribute{3},'VarIndex_tps')
203    DataOut.VarAttribute{3}=rmfield(DataOut.VarAttribute{3},'VarIndex_tps');
204end
205if isfield(DataOut,'VarAttribute')&& numel(DataOut.VarAttribute)>=4 && isfield(DataOut.VarAttribute{4},'VarIndex_tps')
206    DataOut.VarAttribute{4}=rmfield(DataOut.VarAttribute{4},'VarIndex_tps');
207end
208if ~isempty(ind_remove)
209    DataOut.ListVarName(ind_remove)=[];
210    DataOut.VarDimName(ind_remove)=[];
211    DataOut.VarAttribute(ind_remove)=[];
212end
213   
214%% transform of spatial derivatives: TODO check the case with plane angles
215if isfield(Data,'X') && ~isempty(Data.X) && isfield(Data,'DjUi') && ~isempty(Data.DjUi)
216    % estimate the Jacobian matrix DXpx/DXphys
217    for ip=1:length(Data.X)
218        [Xp1,Yp1]=phys_XYZ(Calib,Data.X(ip)+0.5,Data.Y(ip),ZIndex);
219        [Xm1,Ym1]=phys_XYZ(Calib,Data.X(ip)-0.5,Data.Y(ip),ZIndex);
220        [Xp2,Yp2]=phys_XYZ(Calib,Data.X(ip),Data.Y(ip)+0.5,ZIndex);
221        [Xm2,Ym2]=phys_XYZ(Calib,Data.X(ip),Data.Y(ip)-0.5,ZIndex);
222        %Jacobian matrix DXpphys/DXpx
223        DjXi(1,1)=(Xp1-Xm1);
224        DjXi(2,1)=(Yp1-Ym1);
225        DjXi(1,2)=(Xp2-Xm2);
226        DjXi(2,2)=(Yp2-Ym2);
227        DjUi(:,:)=Data.DjUi(ip,:,:);
228        DjUi=(DjXi*DjUi')/DjXi;% =J-1*M*J , curvature effects (derivatives of J) neglected
229        DataOut.DjUi(ip,:,:)=DjUi';
230    end
231    DataOut.DjUi =  DataOut.DjUi/Dt;   %     min(Data.DjUi(:,1,1))=DUDX
232end
233
234
235%%%%%%%%%%%%%%%%%%%%
236
Note: See TracBrowser for help on using the repository browser.