/matlab_tools/Converted/kgspheres.m
Objective C | 216 lines | 213 code | 3 blank | 0 comment | 55 complexity | 6b1c32d455f84cc878d3d6cbfd2f2bf5 MD5 | raw file
Possible License(s): BSD-3-Clause
- %kgspheres 'Produce Spheres Whose Radii are Determined from Data'
- % This MatLab function was automatically generated by a converter (KhorosToMatLab) from the Khoros gspheres.pane file
- %
- % Parameters:
- % InputFile: i 'Input Data Object', required: 'input data object '
- % InputFile: cmap 'Vis Colormap', optional: 'input vis colormap'
- % String: name 'Name ', default: 'spheres': 'object name'
- % Double: scale 'Radius Scale ', default: 1: 'scale factor for radii'
- % OutputFile: o 'Output Geometry Object ', required: 'output geometry object'
- %
- % Example: o = kgspheres({i, cmap}, {'i','';'cmap','';'name','spheres';'scale',1;'o',''})
- %
- % Khoros helpfile follows below:
- %
- % PROGRAM
- % gspheres - Produce Spheres Whose Radii are Determined from Data
- %
- % DESCRIPTION
- % Used to create sphere geometry from input data, "gspheres" takes
- % input data containing both 3-space location values, as well as
- % value data, along with an optional visualization colormap.
- %
- %
- % When no colormap is present, and when the value segment of the input
- % data contains ONLY scalar data, then spheres are created such that the
- % radius of the sphere is proportional to the value of the scalar data
- % (multiplied by the "radius scale" parameter).
- %
- %
- % When the input data contains scalar data, and there is a colormap present,
- % the size (radius) of each sphere and it's color is computed as follows:
- % the radius is computed as a product of the input scalar data (multiplied
- % by the "radius scale" parameter) and the alpha channel of the colormap.
- % The color of the sphere is the color associated with the colormap index
- % computed as a function of the input scalar data and the colormap transfer
- % function in the colormap itself.
- %
- %
- % When the input data contains no value data, then all the spheres will
- % have the same output size (radius scale parameter), and they will not
- % be colored, regardless of whether or not an input colormap is present.
- %
- %
- % When the input data contains 4-vector data, this data is interpreted
- % as RGBA. The radius of each output sphere will the the A-component of
- % the 4-vector value data multiplied by the radius scale parameter. The
- % color of the sphere will be the RGBA value (this is the only way to
- % get spheres of varying transparency).
- %
- %
- %
- % EXAMPLES
- %
- % "SEE ALSO"
- % ggencmap - to create a visualization colormap.
- %
- %
- % gcolorize - to go from scalar to RGBA data.
- %
- % RESTRICTIONS
- %
- % REFERENCES
- %
- % COPYRIGHT
- % Copyright (C) 1996,1997 , The Regents of the University of California. All rights reserved.
- %
- function varargout = kgspheres(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,..] = kgspheres(Inputs,arglist).');
- end
- if size(arglist,2)~=2
- error('arglist must be of form {''ParameterTag1'',value1;''ParameterTag2'',value2}')
- end
- narglist={'i', '__input';'cmap', '__input';'name', 'spheres';'scale', 1;'o', '__output'};
- maxval={0,1,0,1,0};
- minval={0,1,0,1,0};
- istoggle=[0,1,1,1,0];
- was_set=istoggle * 0;
- paramtype={'InputFile','InputFile','String','Double','OutputFile'};
- % 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 'gspheres" '],Inputs,narglist);