/matlab_tools/Converted/krc_seqsim.m
Objective C | 204 lines | 201 code | 3 blank | 0 comment | 57 complexity | c8274c2168207dd29b82a288885d7068 MD5 | raw file
Possible License(s): BSD-3-Clause
- %krc_seqsim 'sequential similarity detection algorithm'
- % This MatLab function was automatically generated by a converter (KhorosToMatLab) from the Khoros rc_seqsim.pane file
- %
- % Parameters:
- % InputFile: iref 'Input Reference Image', required: 'input reference image'
- % InputFile: idist 'Input Distorted Image', required: 'input distorted image'
- % OutputFile: o 'Output', required: 'Resulting output data object'
- % Double: sum_fraction 'fraction of min sum', default: 0.75: 'set threshold to fraction of minimum sum '
- % Integer: seed 'seed', default: 1234567: 'seed for krandom'
- % Double: threshold 'Set explicit threshold', default: 100: 'similarity metric threshold'
- % Integer: pix_number 'number of pixels', default: 20: 'number of pixels to sample for auto-threshold'
- % Double: pix_fraction 'fraction of pixels', default: 0.01: 'fraction of pixels to sample for auto-threshold'
- %
- % Example: o = krc_seqsim({iref, idist}, {'iref','';'idist','';'o','';'sum_fraction',0.75;'seed',1234567;'threshold',100;'pix_number',20;'pix_fraction',0.01})
- %
- % Khoros helpfile follows below:
- %
- % PROGRAM
- % rc_seqsim - sequential similarity detection algorithm
- %
- % DESCRIPTION
- % This program finds the translation correction needed to register the
- % distorted image to the reference image. It operates much like
- % standard correlation, but with two exceptions: (1) rather than summing
- % the squared differences, the absolute differences are summed, and (2)
- % rather than summing over the entire window, the algorithm sums until a
- % threshold is exceeded. The output image consists of the number of
- % terms summed until the threshold was exceeded at each offset.
- %
- % The threshold is established in one of three ways. First, you may
- % enter the threshold directly with the -threshold flag. Second, a
- % number of pixels are randomly sampled (set the number with
- % -pix_number) and the sum over all the pixels in the window
- % established. Then the threshold is set at the frac'th percentile of
- % this sampled population, where frac is set with the -sum_fraction
- % flag. Finally, the third method is the same as the second, except
- % instead of setting the absolute number of pixels to sample, the sample
- % size is some fraction of the total number of pixels determined by the
- % -pix_fraction flag.
- %
- %
- %
- % EXAMPLES
- % See the html tutorial in $REGISTER/examples/html/README_FIRST.html
- %
- % "SEE ALSO"
- %
- % RESTRICTIONS
- %
- % REFERENCES
- %
- % COPYRIGHT
- % Copyright (C) 1996 - 1997, University of New Mexico. All rights reserved.
- %
- function varargout = krc_seqsim(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,..] = krc_seqsim(Inputs,arglist).');
- end
- if size(arglist,2)~=2
- error('arglist must be of form {''ParameterTag1'',value1;''ParameterTag2'',value2}')
- end
- narglist={'iref', '__input';'idist', '__input';'o', '__output';'sum_fraction', 0.75;'seed', 1234567;'threshold', 100;'pix_number', 20;'pix_fraction', 0.01};
- maxval={0,0,0,1,2,0,2,1};
- minval={0,0,0,0,2,0,2,0};
- istoggle=[0,0,0,1,1,1,1,1];
- was_set=istoggle * 0;
- paramtype={'InputFile','InputFile','OutputFile','Double','Integer','Double','Integer','Double'};
- % 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 'rc_seqsim" '],Inputs,narglist);