tutorial_global_oce_latlon/diags_matlab/change.m

function new = change(old,relation,flag,value)

% CHANGE     Change values in a matrix
%--------------------------------------------------------------------
% CHANGE   1.3   92/03/25
%
% new = change(old,relation,flag,value)
%
% DESCRIPTION:
%    Changes the 'flag' values in the matrix "old" to the new "value"
%    according to the "relation".
% 
% INPUT:
%    old      = matrix containing values related to "flag"
%               are to be converted to "value"
%    flag     = values related to "flag" then replaced by "value"
%    value    = replacement value
%    relation = string relation e.g. '<', '>', '=='
%
% OUTPUT:
%    new      = matrix "old" with all flagged values changed
%               to "value" (can be returned to same matrix "old")
%
% EXAMPLE:  A = change(A,'==',NaN,0  )
%           B = change(A,'<', -99,NaN) 
%
% CALLER:   general purpose
% CALLEE:   none
%
% AUTHOR:   Phil Morgan 3-02-92

% @(#)change.m   1.3   92/03/25
% @(#)change.m   Martin Losch 02/03/08, 
%                fixed bug that couldn't handle ~= NaN
% 
% Re-created after 2-2-92 hard disk crash.
% Based on flagnan.m - Steve Rintoul  Dec 90
%          alter.m   - Phil  Morgan    Feb 91
%          convert.m - Peter Mcintosh Aug 91
%--------------------------------------------------------------------
% $Header:  $
% $Name:  $

% CHECK INPUT ARGUMENTS CALL
if nargin ~= 4
  error('CHANGE.M: Must have 4 input arguments')
end

if (strcmp(relation,'==') | strcmp(relation,'>') | strcmp(relation,'<') | ...
                      strcmp(relation,'~=') | strcmp(relation,'>=') | ...
                      strcmp(relation,'<=')) 
    % valid relation
  else
    error(['CHANGE.M: Relation ''' relation ''' not valid'])
end

% BODY
if isnan(flag)
  if strcmp(relation,'==')
    replace = find(isnan(old));
  elseif strcmp(relation,'~=')
    replace = find(~isnan(old));
  else
    error(['CHANGE.M: Relation ''' relation ''' not valid for flag NaN'])
  end
else
   eval(['replace = find(old',relation,'flag);']);
end
nreplace = length(replace);
new      = old;
if nreplace>0
   new(replace) = value*ones(1,nreplace);
end %if
%--------------------------------------------------------------------


1	function new = change(old,relation,flag,value)
2
3	% CHANGE Change values in a matrix
4	%--------------------------------------------------------------------
5	% CHANGE 1.3 92/03/25
6	%
7	% new = change(old,relation,flag,value)
8	%
9	% DESCRIPTION:
10	% Changes the 'flag' values in the matrix "old" to the new "value"
11	% according to the "relation".
12	%
13	% INPUT:
14	% old = matrix containing values related to "flag"
15	% are to be converted to "value"
16	% flag = values related to "flag" then replaced by "value"
17	% value = replacement value
18	% relation = string relation e.g. '<', '>', '=='
19	%
20	% OUTPUT:
21	% new = matrix "old" with all flagged values changed
22	% to "value" (can be returned to same matrix "old")
23	%
24	% EXAMPLE: A = change(A,'==',NaN,0 )
25	% B = change(A,'<', -99,NaN)
26	%
27	% CALLER: general purpose
28	% CALLEE: none
29	%
30	% AUTHOR: Phil Morgan 3-02-92
31
32	% @(#)change.m 1.3 92/03/25
33	% @(#)change.m Martin Losch 02/03/08,
34	% fixed bug that couldn't handle ~= NaN
35	%
36	% Re-created after 2-2-92 hard disk crash.
37	% Based on flagnan.m - Steve Rintoul Dec 90
38	% alter.m - Phil Morgan Feb 91
39	% convert.m - Peter Mcintosh Aug 91
40	%--------------------------------------------------------------------
41	% $Header: $
42	% $Name: $
43
44	% CHECK INPUT ARGUMENTS CALL
45	if nargin ~= 4
46	error('CHANGE.M: Must have 4 input arguments')
47	end
48
49	if (strcmp(relation,'==') \| strcmp(relation,'>') \| strcmp(relation,'<') \| ...
50	strcmp(relation,'~=') \| strcmp(relation,'>=') \| ...
51	strcmp(relation,'<='))
52	% valid relation
53	else
54	error(['CHANGE.M: Relation ''' relation ''' not valid'])
55	end
56
57	% BODY
58	if isnan(flag)
59	if strcmp(relation,'==')
60	replace = find(isnan(old));
61	elseif strcmp(relation,'~=')
62	replace = find(~isnan(old));
63	else
64	error(['CHANGE.M: Relation ''' relation ''' not valid for flag NaN'])
65	end
66	else
67	eval(['replace = find(old',relation,'flag);']);
68	end
69	nreplace = length(replace);
70	new = old;
71	if nreplace>0
72	new(replace) = value*ones(1,nreplace);
73	end %if
74	%--------------------------------------------------------------------
75
76