/matlab_tools/Converted/kkclip.m

%kkclip 'Clip or Threshold the Range of Values in Object'
% This MatLab function was automatically generated by a converter (KhorosToMatLab) from the Khoros kclip.pane file
%
% Parameters: 
% InputFile: i 'Input ', required: 'Input file'
% OutputFile: o ' Output ', required: 'output file'
% InputFile: ilc 'Lower Cutoff Values File', optional: 'File containing lower cutoff values'
% InputFile: iuc 'Upper Cutoff Values File', optional: 'File containing upper cutoff values'
%
% Example: o = kkclip({i, ilc, iuc}, {'i','';'o','';'ilc','';'iuc',''})
%
% Khoros helpfile follows below:
%
%  PROGRAM
% kclip - Clip or Threshold the Range of Values in Object
%
%  DESCRIPTION
% .I kclip
% performs clipping and thresholding operations on the input data 
% object (i).  Clipping limits the range of values in the data object, and
% thresholding generates a two-level output by thresholding the values in 
% the object.  For both operations, upper and lower cutoff values can be 
% specified as either single constant values (lc, uc), or sets of values 
% passed in as data objects (ilc, iuc).  Output levels can be set using 
% the true and false value options (tval, fval). The data type of the 
% output object will be the same as the input object data type.
% 
%  Clipping
% When clipping is enabled (-thresh 0), the values in the object are 
% clipped within the range specified by the upper and/or lower cutoff limits.  
% In the default mode (where neither fval nor tval are selected) data values 
% above the upper cutoff are set equal to the upper cutoff, and values below 
% the lower cutoff are set equal to the lower cutoff value.  If the fval 
% parameter is provided, then data values below the lower cutoff are set to 
% fval.  If the tval parameter is provided, data values greater than the upper
% cutoff are set to that value.  Exception: any time that both the upper and 
% lower cutoff values are provided, and the upper cutoff is less than the 
% lower cutoff, then data values between the two cutoffs are always set 
% equal to fval.
% 
%  Thresholding
% If thresholding is enabled (-thresh 1), thresholding is performed using 
% the specified lower and upper cutoff values, creating a two-level output 
% data object.  It is not necessary to specify both of the upper and lower 
% cutoff values. If only the lower cutoff is specified, all values above it 
% are in the threshold range. If only the upper cutoff is 
% specified, all values below it are in the threshold range. 
% The true value (tval) is assigned to values that are within the threshold 
% range, and all values outside of the threshold range are set to fval.
% 
% The following four diagrams illustrate how the given operation is evaluated
% for different combinations of upper and lower cutoffs.  The plots
% are example data histograms.  Clipping and threshold output assignment
% rules are given following the diagrams.
% .KS
% 
%  "\fBLower Cutoff Only:"" 5
% 
% 
% \f(CW
%      lower cutoff result:       |<-F->|<----T---->|
%                                 |     | :     .   |
%                                 |    .:.:.  .:::  |
%                                 |:. .::::::.::::: |
%                                 |::::::::::::::::.|
%                                 ------|------------
%                                       lower cutoff (lc)
% 
%         if value <  lc  cutoff result = False
%         if value >= lc  cutoff result = True
% "
% 
% .KE
% .KS
% 
%  "\fBUpper Cutoff Only:"" 5
% 
% 
% \f(CW
%         upper cutoff result:    |<----T---->|<-F->|
%                                 |       :   | .   |
%                                 |    .:.:.  .:::  |
%                                 |:. .::::::.::::: |
%                                 |::::::::::::::::.|
%                                 ------------|------
%                                             upper cutoff (uc)
% 
%         if value >  uc  cutoff result = False
%         if value <= uc  cutoff result = True
% "
% 
% .KE
% .KS
% 
%  "\fBUpper Cutoff is Greater than Lower Cutoff:""  5
% When both upper and lower cutoff values are specified, and the upper cutoff
% is greater than the lower cutoff, the combined cutoff result is the logical 
% AND of the individual results.
% 
% 
% \f(CW
%         lower cutoff result:    |<-F->|<----T---->|
%         upper cutoff result:    |<----T---->|<-F->|
% 
%         combined cutoff result: |<-F->|<-T->|<-F->|
%                                 |     | :   | .   |
%                                 |    .:.:.  .:::  |
%                                 |:. .::::::.::::: |
%                                 |::::::::::::::::.|
%                                 ------|-----|------
%                                      lc     uc
% 
%         if value <  lc OR  value >  uc  cutoff result = False
%         if value >= lc AND value <= uc  cutoff result = True
% "
% 
% .KE
% .KS
% 
%  "\fBUpper Cutoff is Less than Lower Cutoff:""  5
% When both upper and lower cutoff values are specified, but the upper cutoff
% is less than the lower cutoff, the combined cutoff result is the logical 
% OR of the individual results.  (Specifying the lower cutoff to be greater
% than the upper cutoff inverts the operation.)
% In this case, the false value assigned to the output will always be fval 
% for both clipping and thresholding.
% 
% 
% \f(CW
%         upper cutoff result:    |<-T->|<----F---->|
%         lower cutoff result:    |<----F---->|<-T->|
% 
%         combined cutoff result: |<-T->|<-F->|<-T->|
%                                 |     | :   | .   |
%                                 |    .:.:.  .:::  |
%                                 |:. .::::::.::::: |
%                                 |::::::::::::::::.|
%                                 ------|-----|------
%                                      uc     lc
% 
%         if value <  lc AND value >  uc  cutoff result = False
%         if value >= lc OR  value <= uc  cutoff result = True
% "
% 
% .KE
% 
% Clipping results are assigned according to the following rules.  ("Lower
% result" and "upper result" are either the clipping values or fval and 
% tval - see discussion above.)
% 
%  "1.  When lower cutoff < upper cutoff" 5
% If the data value is less than the lower cutoff, set the
% output value to "lower result".
% If the data value is greater than the upper cutoff, set
% the output value to "upper result".
% Otherwise, the data value remains the same.
% 
%  "2.  When upper cutoff < lower cutoff" 5
% If the data value is less than the upper cutoff and
% it is greater than the lower cutoff, set output
% value to the "lower result".
% Otherwise, the data value remains the same.
% 
% Thresholding results are assigned according to the following rules.
% 
%  "1.  When lower cutoff < upper cutoff" 5
% If the data value is less than the lower cutoff, or
% it is greater than the upper cutoff, set the output
% value to fval.
% Otherwise, set the output value to tval.
% 
%  "2.  When upper cutoff < lower cutoff" 5
% If the data value is less than the lower cutoff and
% it is greater than the upper cutoff, set output
% value to fval.
% Otherwise, set the output value to tval.
% 
% When upper and lower cutoff values are equal, the only data values that
% are evaluated as TRUE are those that are equal to the cutoff values.
% 
%  "Data Type" 5
% .cI $DATAMANIP/repos/shared/man/sections/value_type_1input
% 
%  "Data Objects of Different Sizes" 5
% If, in addition to the input data object (i), upper or lower cutoff 
% objects (ilc, iuc) are supplied, 
% the source objects can be of different sizes.  If the sizes are different, 
% the size of the destination object's data will be the the same as that of
% the input data object.  When resizing the cutoff objects, the data is 
% zero padded, or truncated to the size of the input object. 
% Alignment between the input files will always be the upper-left hand corner, 
% position (0,0,0,0,0).
% 
%  "Map Data - Single Input" 5
% .cI $DATAMANIP/repos/shared/man/sections/map_1input
% 
%  "Map Data - Multiple Input Objects" 5
% .cI $DATAMANIP/repos/shared/man/sections/map_2input
% 
%  "Validity Mask - Single Input" 5
% .cI $DATAMANIP/repos/shared/man/sections/mask_1input
% 
%  "Validity Mask - Multiple Input Objects" 5
% .cI $DATAMANIP/repos/shared/man/sections/mask_2input
% 
%  "Explicit Location and Time Data - Single Input" 5
% .cI $DATAMANIP/repos/shared/man/sections/loc_and_time_1input
% 
%  "Explicit Location and Time Data - Two Input Objects" 5
% .cI $DATAMANIP/repos/shared/man/sections/loc_and_time_2input
% 
%  "Failure Modes - Single Input"
% .cI $DATAMANIP/repos/shared/man/sections/fail_1input
% 
%  "Failure Modes - Two Input Objects"
% .cI $DATAMANIP/repos/shared/man/sections/fail_2input
%
%  
%
%  EXAMPLES
% kclip -thresh 1 -i image:ball -lc 128 -uc 202 -tval 12 -fval 0 -o thresh.out
% 
% causes all pixels between the values on 128 and 202 (inclusively)
% to have a value of 12 in the output image. All other output image pixels
% have the value of zero.
% kclip -i full_range.viff -uc 123 -lc 17 -o restricted_range.viff
% Limits the range of values in the input file full_range.viff to 17...123 
% and writes the result to restricted_range.viff.
%
%  "SEE ALSO"
% kbitwise
%
%  RESTRICTIONS 
% This program has not yet been updated to completely support the
% polymorphic data model.
%
%  REFERENCES 
%
%  COPYRIGHT
% Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI")  All rights reserved.
% 


function varargout = kkclip(varargin)
if nargin ==0
  Inputs={};arglist={'',''};
elseif nargin ==1
  Inputs=varargin{1};arglist={'',''};
elseif nargin ==2
  Inputs=varargin{1}; arglist=varargin{2};
else error('Usage: [out1,..] = kkclip(Inputs,arglist).');
end
if size(arglist,2)~=2
  error('arglist must be of form {''ParameterTag1'',value1;''ParameterTag2'',value2}')
 end
narglist={'i', '__input';'o', '__output';'ilc', '__input';'iuc', '__input'};
maxval={0,0,1,1};
minval={0,0,1,1};
istoggle=[0,0,1,1];
was_set=istoggle * 0;
paramtype={'InputFile','OutputFile','InputFile','InputFile'};
% identify the input arrays and assign them to the arguments as stated by the user
if ~iscell(Inputs)
Inputs = {Inputs};
end
NumReqOutputs=1; nextinput=1; nextoutput=1;
  for ii=1:size(arglist,1)
  wasmatched=0;
  for jj=1:size(narglist,1)
   if strcmp(arglist{ii,1},narglist{jj,1})  % a given argument was matched to the possible arguments
     wasmatched = 1;
     was_set(jj) = 1;
     if strcmp(narglist{jj,2}, '__input')
      if (nextinput > length(Inputs)) 
        error(['Input ' narglist{jj,1} ' has no corresponding input!']); 
      end
      narglist{jj,2} = 'OK_in';
      nextinput = nextinput + 1;
     elseif strcmp(narglist{jj,2}, '__output')
      if (nextoutput > nargout) 
        error(['Output nr. ' narglist{jj,1} ' is not present in the assignment list of outputs !']); 
      end
      if (isempty(arglist{ii,2}))
        narglist{jj,2} = 'OK_out';
      else
        narglist{jj,2} = arglist{ii,2};
      end

      nextoutput = nextoutput + 1;
      if (minval{jj} == 0)  
         NumReqOutputs = NumReqOutputs - 1;
      end
     elseif isstr(arglist{ii,2})
      narglist{jj,2} = arglist{ii,2};
     else
        if strcmp(paramtype{jj}, 'Integer') & (round(arglist{ii,2}) ~= arglist{ii,2})
            error(['Argument ' arglist{ii,1} ' is of integer type but non-integer number ' arglist{ii,2} ' was supplied']);
        end
        if (minval{jj} ~= 0 | maxval{jj} ~= 0)
          if (minval{jj} == 1 & maxval{jj} == 1 & arglist{ii,2} < 0)
            error(['Argument ' arglist{ii,1} ' must be bigger or equal to zero!']);
          elseif (minval{jj} == -1 & maxval{jj} == -1 & arglist{ii,2} > 0)
            error(['Argument ' arglist{ii,1} ' must be smaller or equal to zero!']);
          elseif (minval{jj} == 2 & maxval{jj} == 2 & arglist{ii,2} <= 0)
            error(['Argument ' arglist{ii,1} ' must be bigger than zero!']);
          elseif (minval{jj} == -2 & maxval{jj} == -2 & arglist{ii,2} >= 0)
            error(['Argument ' arglist{ii,1} ' must be smaller than zero!']);
          elseif (minval{jj} ~= maxval{jj} & arglist{ii,2} < minval{jj})
            error(['Argument ' arglist{ii,1} ' must be bigger than ' num2str(minval{jj})]);
          elseif (minval{jj} ~= maxval{jj} & arglist{ii,2} > maxval{jj})
            error(['Argument ' arglist{ii,1} ' must be smaller than ' num2str(maxval{jj})]);
          end
        end
     end
     if ~strcmp(narglist{jj,2},'OK_out') &  ~strcmp(narglist{jj,2},'OK_in') 
       narglist{jj,2} = arglist{ii,2};
     end
   end
   end
   if (wasmatched == 0 & ~strcmp(arglist{ii,1},''))
        error(['Argument ' arglist{ii,1} ' is not a valid argument for this function']);
   end
end
% match the remaining inputs/outputs to the unused arguments and test for missing required inputs
 for jj=1:size(narglist,1)
     if  strcmp(paramtype{jj}, 'Toggle')
        if (narglist{jj,2} ==0)
          narglist{jj,1} = ''; 
        end;
        narglist{jj,2} = ''; 
     end;
     if  ~strcmp(narglist{jj,2},'__input') && ~strcmp(narglist{jj,2},'__output') && istoggle(jj) && ~ was_set(jj)
          narglist{jj,1} = ''; 
          narglist{jj,2} = ''; 
     end;
     if strcmp(narglist{jj,2}, '__input')
      if (minval{jj} == 0)  % meaning this input is required
        if (nextinput > size(Inputs)) 
           error(['Required input ' narglist{jj,1} ' has no corresponding input in the list!']); 
        else
          narglist{jj,2} = 'OK_in';
          nextinput = nextinput + 1;
        end
      else  % this is an optional input
        if (nextinput <= length(Inputs)) 
          narglist{jj,2} = 'OK_in';
          nextinput = nextinput + 1;
        else 
          narglist{jj,1} = '';
          narglist{jj,2} = '';
        end;
      end;
     else 
     if strcmp(narglist{jj,2}, '__output')
      if (minval{jj} == 0) % this is a required output
        if (nextoutput > nargout & nargout > 1) 
           error(['Required output ' narglist{jj,1} ' is not stated in the assignment list!']); 
        else
          narglist{jj,2} = 'OK_out';
          nextoutput = nextoutput + 1;
          NumReqOutputs = NumReqOutputs-1;
        end
      else % this is an optional output
        if (nargout - nextoutput >= NumReqOutputs) 
          narglist{jj,2} = 'OK_out';
          nextoutput = nextoutput + 1;
        else 
          narglist{jj,1} = '';
          narglist{jj,2} = '';
        end;
      end
     end
  end
end
if nargout
   varargout = cell(1,nargout);
else
  varargout = cell(1,1);
end
global KhorosRoot
if exist('KhorosRoot') && ~isempty(KhorosRoot)
w=['"' KhorosRoot];
else
if ispc
  w='"C:\Program Files\dip\khorosBin\';
else
[s,w] = system('which cantata');
w=['"' w(1:end-8)];
end
end
[varargout{:}]=callKhoros([w 'kclip"  '],Inputs,narglist);