profilesMatlabProcessing/profiles_misc/MITprof_resample.m

function [profOut]=MITprof_resample(profIn,fldIn,filOut,method);
%
%[profOut]=MITPROF_RESAMPLE(profIn,fldIn,filOut,method);
%
%     resamples a set of fields (fldIn) to profile 3D locations (profIn)
%     and output the result to nc file (filOut) and memory (profOut).
%     using a chosen interpolation method (method).
%
%     profIn (structure) should contain: prof_depth, prof_lon, prof_lat, prof_date
%     fldIn (structure) should contain: fil, name, long_name, units, tim, 
%         missing_value, FillValue (for nc output), and fld ([] by default).
%         If fld is not [] then it is assumed that user already loaded 
%         the fields from fldIn.fil.
%
%     fldIn.tim can be set to
%         'const' (for time invariant climatology),
%         'monclim' (for monthly climatology)
%         'monser' (for monthly time series)
%         'monloop' (for cyclic monthly time series)
%
%     method can be set to
%         'polygons' (linear in space)
%         'bindata' (nearest neighbor in space)
%
% Example: 
%  grid_load; gcmfaces_global; MITprof_global; addpath matlab/;
%  profIn=idma_float_plot('4900828');
%  %
%  fldIn.fil=fullfile(myenv.MITprof_climdir,filesep,'T_OWPv1_M_eccollc_90x50.bin');
%  fldIn.name='prof_Towp';
%  fldIn.long_name='pot. temp. estimate (OCCA-WOA-PHC combination)';
%  fldIn.units='degree C';
%  fldIn.tim='monclim';
%  fldIn.missing_value=-9999.;
%  fldIn.FillValue=-9999.;
%  fldIn.fld=[];
%  %
%  profOut=MITprof_resample(profIn,fldIn);


gcmfaces_global;

doOut=~isempty(who('filOut')); doOutInit=false;
if doOut; doOut=~isempty(filOut); end;
if doOut; doOutInit=isempty(dir(filOut)); end;

if isempty(who('method')); method='polygons'; end;

%0) check for file types
test0=~isempty(dir(fldIn.fil));
[PATH,NAME,EXT]=fileparts(fldIn.fil);
fil_nc=fullfile(PATH,NAME,[NAME '.0001.nc']);
fil_nctiles=fullfile(PATH,NAME,NAME);
test1=~isempty(dir(fil_nc));
test2=~isempty(fldIn.fld);

%1) deal with time line
if strcmp(fldIn.tim,'monclim');
    tim_fld=[-0.5:12.5]; rec_fld=[12 1:12 1];
    tmp1=datevec(profIn.prof_date);
    tmp2=datenum([tmp1(:,1) ones(profIn.np,2) zeros(profIn.np,3)]);
    tim_prof=(profIn.prof_date-tmp2);
    tim_prof(tim_prof>365)=365;
    tim_prof=tim_prof/365*12;%neglecting differences in months length
elseif strcmp(fldIn.tim,'monloop')|strcmp(fldIn.tim,'monser');
    if test1;
      eval(['ncload ' fil_nc ' tim']);
      nt=length(tim);
    elseif ~test2;
      %note: 2D case still needs to be treated here ... or via fldIn.is3d ?
      tmp1=dir(fldIn.fil);
      nt=tmp1.bytes/prod(mygrid.ioSize)/length(mygrid.RC)/4;
    else;
      error('gcmfaces input case is missing here');
    end;
    tmp1=[1:nt]'; tmp2=ones(nt,1)*[1992 1 15 0 0 0]; tmp2(:,2)=tmp1;
    tim_fld=datenum(tmp2);
    tim_fld=[tim_fld(1)-31 tim_fld' tim_fld(end)+31];
    rec_fld=[nt 1:nt 1];
    if strcmp(fldIn.tim,'monloop');
      tmp1=datenum([1992 1 1 0 0 0]);
      tmp2=datenum([1992+nt/12 1 1 0 0 0]);;
      tim_prof=tmp1+mod(profIn.prof_date-tmp1,tmp2-tmp1);
    else;
      tim_prof=profIn.prof_date;
    end;
    %round up tim_prof to prevent interpolation in time:
    %  tmp3=tim_prof*ones(1,length(tim_fld))-ones(length(tim_prof),1)*tim_fld;
    %  tmp4=sum(tmp3>0,2);
    %  tim_prof=tim_fld(tmp4)';
elseif strcmp(fldIn.tim,'const')|strcmp(fldIn.tim,'std');
    tim_fld=[1 2]; rec_fld=[1 1];
    tim_prof=1.5*ones(profIn.np,1);
else;
    error('this case remains to be implemented');
end;

lon=profIn.prof_lon; lat=profIn.prof_lat;
depIn=-mygrid.RC; depOut=profIn.prof_depth;
profOut=NaN*ones(profIn.np,profIn.nr);

%2) loop over record pairs
if ~strcmp(method,'bindata'); gcmfaces_bindata; end;
for tt=1:length(rec_fld)-1;
  ii=find(tim_prof>=tim_fld(tt)&tim_prof<tim_fld(tt+1));
  if ~isempty(ii);
    %tt
    %
    if test2;
      fld0=fldIn.fld(:,:,:,rec_fld(tt));
      fld1=fldIn.fld(:,:,:,rec_fld(tt+1));
    elseif test1;
      fld0=read_nctiles(fil_nctiles,NAME,rec_fld(tt));
      fld1=read_nctiles(fil_nctiles,NAME,rec_fld(tt+1));
    elseif test0;
      fld0=read_bin(fldIn.fil,rec_fld(tt));
      fld1=read_bin(fldIn.fil,rec_fld(tt+1));
    else;
      error(['file not found:' fldIn.fil]);
    end;
    %
    ndim=length(size(fld0{1}));
    if ndim==2;
      fld0=fld0.*mygrid.mskC(:,:,1);
      fld1=fld1.*mygrid.mskC(:,:,1);
      fldIs3d=0;
    else;
      fld0=fld0.*mygrid.mskC;
      fld1=fld1.*mygrid.mskC;
      fldIs3d=1;
    end;
    fld=cat(ndim+1,fld0,fld1);
    %
    if ~strcmp(method,'bindata');
      arr=gcmfaces_interp_2d(fld,lon(ii),lat(ii),method);
      if fldIs3d;
        arr2=gcmfaces_interp_1d(2,depIn,arr,depOut);
      else;
        arr2=arr;
      end;
      %now linear in time:
      k0=floor(tim_prof(ii));
      a0=tim_prof(ii)-k0;
      if fldIs3d;
        a0=a0*ones(1,profIn.nr);
        profOut(ii,:)=(1-a0).*arr2(:,:,1)+a0.*arr2(:,:,2);
      else;
        profOut(ii,1)=(1-a0).*arr2(:,1)+a0.*arr2(:,2);
      end;
    elseif fldIs3d;
      [prof_i,prof_j]=gcmfaces_bindata(lon(ii),lat(ii));
      FLD=convert2array(fld(:,:,:,1));
      nk=length(mygrid.RC); kk=ones(1,nk);
      np=length(ii); pp=ones(np,1);
      ind2prof=sub2ind(size(FLD),prof_i*kk,prof_j*kk,pp*[1:nk]);
      arr=FLD(ind2prof);
      arr2=gcmfaces_interp_1d(2,depIn,arr,depOut);
      profOut(ii,:)=arr2;
    else;
      error('2D field case is missing here');
    end;
    %    
    if strcmp(fldIn.tim,'std');
      profOut(ii,:)=profOut(ii,:).*randn(size(profOut(ii,:)));
    end;

  end;%if ~isempty(ii);
end;

if ~fldIs3d;
  profOut=profOut(:,1);
end;

%3) deal with file output
if doOutInit;
    %create a header only file to later append resampled fields
    prof=profIn;
    tmp1=fieldnames(prof);
    nt=length(prof.prof_date);
    nr=length(prof.prof_depth);
    for ii=1:length(tmp1);
        tmp2=prod(size(getfield(prof,tmp1{ii})));
        if tmp2==nt*nr; prof=rmfield(prof,tmp1{ii}); end;
    end;
    MITprof_write(filOut,prof);
end;

if doOut;
    if ~fldIs3d;
      dims={'iPROF'};
    else;
      dims={'iDEPTH','iPROF'};
    end;
    %add the array itelf    
    MITprof_addVar(filOut,fldIn.name,'double',dims,profOut);
    
    %add its attributes
    nc=ncopen(filOut,'write');
    ncaddAtt(nc,fldIn.name,'long_name',fldIn.long_name);
    ncaddAtt(nc,fldIn.name,'units',fldIn.units);
    ncaddAtt(nc,fldIn.name,'missing_value',fldIn.missing_value);
    ncaddAtt(nc,fldIn.name,'_FillValue',fldIn.FillValue);
    ncclose(nc);
end;

%4) deal with argument output
if nargout>0; profOut=setfield(profIn,fldIn.name,profOut); end;


1	gforget	1.7	function [profOut]=MITprof_resample(profIn,fldIn,filOut,method);
2	gforget	1.1	%
3	gforget	1.7	%[profOut]=MITPROF_RESAMPLE(profIn,fldIn,filOut,method);
4			%
5			% resamples a set of fields (fldIn) to profile 3D locations (profIn)
6			% and output the result to nc file (filOut) and memory (profOut).
7			% using a chosen interpolation method (method).
8			%
9			% profIn (structure) should contain: prof_depth, prof_lon, prof_lat, prof_date
10			% fldIn (structure) should contain: fil, name, long_name, units, tim,
11	gforget	1.8	% missing_value, FillValue (for nc output), and fld ([] by default).
12			% If fld is not [] then it is assumed that user already loaded
13			% the fields from fldIn.fil.
14	gforget	1.7	%
15			% fldIn.tim can be set to
16			% 'const' (for time invariant climatology),
17			% 'monclim' (for monthly climatology)
18			% 'monser' (for monthly time series)
19			% 'monloop' (for cyclic monthly time series)
20			%
21			% method can be set to
22			% 'polygons' (linear in space)
23			% 'bindata' (nearest neighbor in space)
24			%
25			% Example:
26			% grid_load; gcmfaces_global; MITprof_global; addpath matlab/;
27			% profIn=idma_float_plot('4900828');
28			% %
29			% fldIn.fil=fullfile(myenv.MITprof_climdir,filesep,'T_OWPv1_M_eccollc_90x50.bin');
30			% fldIn.name='prof_Towp';
31			% fldIn.long_name='pot. temp. estimate (OCCA-WOA-PHC combination)';
32			% fldIn.units='degree C';
33			% fldIn.tim='monclim';
34			% fldIn.missing_value=-9999.;
35			% fldIn.FillValue=-9999.;
36	gforget	1.8	% fldIn.fld=[];
37	gforget	1.7	% %
38			% profOut=MITprof_resample(profIn,fldIn);
39
40	gforget	1.1
41			gcmfaces_global;
42
43			doOut=~isempty(who('filOut')); doOutInit=false;
44			if doOut; doOut=~isempty(filOut); end;
45			if doOut; doOutInit=isempty(dir(filOut)); end;
46
47			if isempty(who('method')); method='polygons'; end;
48
49	gforget	1.8	%0) check for file types
50			test0=~isempty(dir(fldIn.fil));
51			[PATH,NAME,EXT]=fileparts(fldIn.fil);
52			fil_nc=fullfile(PATH,NAME,[NAME '.0001.nc']);
53			fil_nctiles=fullfile(PATH,NAME,NAME);
54			test1=~isempty(dir(fil_nc));
55			test2=~isempty(fldIn.fld);
56
57	gforget	1.1	%1) deal with time line
58			if strcmp(fldIn.tim,'monclim');
59			tim_fld=[-0.5:12.5]; rec_fld=[12 1:12 1];
60			tmp1=datevec(profIn.prof_date);
61			tmp2=datenum([tmp1(:,1) ones(profIn.np,2) zeros(profIn.np,3)]);
62			tim_prof=(profIn.prof_date-tmp2);
63			tim_prof(tim_prof>365)=365;
64			tim_prof=tim_prof/365*12;%neglecting differences in months length
65	gforget	1.8	elseif strcmp(fldIn.tim,'monloop')\|strcmp(fldIn.tim,'monser');
66			if test1;
67			eval(['ncload ' fil_nc ' tim']);
68			nt=length(tim);
69			elseif ~test2;
70			%note: 2D case still needs to be treated here ... or via fldIn.is3d ?
71			tmp1=dir(fldIn.fil);
72			nt=tmp1.bytes/prod(mygrid.ioSize)/length(mygrid.RC)/4;
73			else;
74			error('gcmfaces input case is missing here');
75			end;
76	gforget	1.5	tmp1=[1:nt]'; tmp2=ones(nt,1)*[1992 1 15 0 0 0]; tmp2(:,2)=tmp1;
77			tim_fld=datenum(tmp2);
78			tim_fld=[tim_fld(1)-31 tim_fld' tim_fld(end)+31];
79			rec_fld=[nt 1:nt 1];
80	gforget	1.8	if strcmp(fldIn.tim,'monloop');
81			tmp1=datenum([1992 1 1 0 0 0]);
82			tmp2=datenum([1992+nt/12 1 1 0 0 0]);;
83			tim_prof=tmp1+mod(profIn.prof_date-tmp1,tmp2-tmp1);
84			else;
85			tim_prof=profIn.prof_date;
86			end;
87	gforget	1.6	%round up tim_prof to prevent interpolation in time:
88			% tmp3=tim_profones(1,length(tim_fld))-ones(length(tim_prof),1)tim_fld;
89			% tmp4=sum(tmp3>0,2);
90			% tim_prof=tim_fld(tmp4)';
91	gforget	1.3	elseif strcmp(fldIn.tim,'const')\|strcmp(fldIn.tim,'std');
92			tim_fld=[1 2]; rec_fld=[1 1];
93	gforget	1.1	tim_prof=1.5*ones(profIn.np,1);
94			else;
95			error('this case remains to be implemented');
96			end;
97
98			lon=profIn.prof_lon; lat=profIn.prof_lat;
99			depIn=-mygrid.RC; depOut=profIn.prof_depth;
100			profOut=NaN*ones(profIn.np,profIn.nr);
101
102			%2) loop over record pairs
103	gforget	1.5	if ~strcmp(method,'bindata'); gcmfaces_bindata; end;
104	gforget	1.1	for tt=1:length(rec_fld)-1;
105	gforget	1.8	ii=find(tim_prof>=tim_fld(tt)&tim_prof<tim_fld(tt+1));
106			if ~isempty(ii);
107			%tt
108			%
109			if test2;
110			fld0=fldIn.fld(:,:,:,rec_fld(tt));
111			fld1=fldIn.fld(:,:,:,rec_fld(tt+1));
112			elseif test1;
113			fld0=read_nctiles(fil_nctiles,NAME,rec_fld(tt));
114			fld1=read_nctiles(fil_nctiles,NAME,rec_fld(tt+1));
115			elseif test0;
116			fld0=read_bin(fldIn.fil,rec_fld(tt));
117			fld1=read_bin(fldIn.fil,rec_fld(tt+1));
118			else;
119			error(['file not found:' fldIn.fil]);
120			end;
121	gforget	1.5	%
122	gforget	1.1	ndim=length(size(fld0{1}));
123	gforget	1.8	if ndim==2;
124			fld0=fld0.*mygrid.mskC(:,:,1);
125			fld1=fld1.*mygrid.mskC(:,:,1);
126			fldIs3d=0;
127			else;
128			fld0=fld0.*mygrid.mskC;
129			fld1=fld1.*mygrid.mskC;
130			fldIs3d=1;
131			end;
132	gforget	1.1	fld=cat(ndim+1,fld0,fld1);
133			%
134	gforget	1.8	if ~strcmp(method,'bindata');
135			arr=gcmfaces_interp_2d(fld,lon(ii),lat(ii),method);
136			if fldIs3d;
137	gforget	1.1	arr2=gcmfaces_interp_1d(2,depIn,arr,depOut);
138	gforget	1.8	else;
139			arr2=arr;
140			end;
141			%now linear in time:
142			k0=floor(tim_prof(ii));
143			a0=tim_prof(ii)-k0;
144			if fldIs3d;
145			a0=a0*ones(1,profIn.nr);
146	gforget	1.5	profOut(ii,:)=(1-a0).arr2(:,:,1)+a0.arr2(:,:,2);
147			else;
148	gforget	1.8	profOut(ii,1)=(1-a0).arr2(:,1)+a0.arr2(:,2);
149	gforget	1.5	end;
150	gforget	1.8	elseif fldIs3d;
151			[prof_i,prof_j]=gcmfaces_bindata(lon(ii),lat(ii));
152			FLD=convert2array(fld(:,:,:,1));
153			nk=length(mygrid.RC); kk=ones(1,nk);
154			np=length(ii); pp=ones(np,1);
155			ind2prof=sub2ind(size(FLD),prof_ikk,prof_jkk,pp*[1:nk]);
156			arr=FLD(ind2prof);
157			arr2=gcmfaces_interp_1d(2,depIn,arr,depOut);
158			profOut(ii,:)=arr2;
159			else;
160			error('2D field case is missing here');
161			end;
162			%
163			if strcmp(fldIn.tim,'std');
164			profOut(ii,:)=profOut(ii,:).*randn(size(profOut(ii,:)));
165	gforget	1.4	end;
166	gforget	1.8
167			end;%if ~isempty(ii);
168			end;
169
170			if ~fldIs3d;
171			profOut=profOut(:,1);
172	gforget	1.1	end;
173
174			%3) deal with file output
175			if doOutInit;
176			%create a header only file to later append resampled fields
177			prof=profIn;
178			tmp1=fieldnames(prof);
179			nt=length(prof.prof_date);
180			nr=length(prof.prof_depth);
181			for ii=1:length(tmp1);
182			tmp2=prod(size(getfield(prof,tmp1{ii})));
183			if tmp2==nt*nr; prof=rmfield(prof,tmp1{ii}); end;
184			end;
185			MITprof_write(filOut,prof);
186			end;
187
188			if doOut;
189	gforget	1.8	if ~fldIs3d;
190			dims={'iPROF'};
191			else;
192			dims={'iDEPTH','iPROF'};
193			end;
194	gforget	1.1	%add the array itelf
195	gforget	1.8	MITprof_addVar(filOut,fldIn.name,'double',dims,profOut);
196	gforget	1.1
197			%add its attributes
198			nc=ncopen(filOut,'write');
199			ncaddAtt(nc,fldIn.name,'long_name',fldIn.long_name);
200			ncaddAtt(nc,fldIn.name,'units',fldIn.units);
201			ncaddAtt(nc,fldIn.name,'missing_value',fldIn.missing_value);
202			ncaddAtt(nc,fldIn.name,'_FillValue',fldIn.FillValue);
203			ncclose(nc);
204			end;
205
206			%4) deal with argument output
207			if nargout>0; profOut=setfield(profIn,fldIn.name,profOut); end;
208
209