Fix issue 692 -- remove varargout

doc/PsPM_Developers_Guide.lyx

@@ -24203,7 +24203,7 @@ Function
 \begin_layout Standard
 
 \family typewriter
-wavedata = pspm_pulse_convert(pulsedata, resamplingrate, samplingrate)
+[sts, wavedata] = pspm_pulse_convert(pulsedata, resamplingrate, samplingrate)
 \end_layout
 
 \begin_layout Subsubsection

src/pspm_data_editor.m

@@ -1,15 +1,14 @@
-function varargout = pspm_data_editor(varargin)
+function [sts, out] = pspm_data_editor(varargin)
 % ● Description
 %   pspm_data_editor MATLAB code for pspm_data_editor.fig
 % ● Format
-%   [varargout] = pspm_data_editor(varargin)
 %   [sts, out]  = pspm_data_editor(indata, options)
 % ● Arguments
 %   *      indata:  Can be multiple kinds of data types. In order to use
 %                   pspm_data_editor() to edit acquisition data, the actual
 %                   data vector has to be passed via the varargin
 %                   argmument. The data should be 1xn or nx1 double vector.
-%   ┌─────options 
+%   ┌─────options
 %   ├.output_file:  Use output_file to specify a file the changed data
 %   │               is saved to when clicking 'save' or 'apply'. Only
 %   │               works in 'file' mode.
@@ -46,7 +45,7 @@
 end
 
 if nargout
-  [varargout{1:nargout}] = gui_mainfcn(gui_State, varargin{:});
+  [sts, out] = gui_mainfcn(gui_State, varargin{:});
 else
   gui_mainfcn(gui_State, varargin{:});
 end
@@ -358,9 +357,6 @@ function RemovePlot(hObject, chan_id)
 guidata(hObject, handles);
 
 function varargout = pspm_data_editor_OutputFcn(hObject, ~, handles)
-% Comments
-%   It used to be function varargout = pspm_data_editor_OutputFcn(hObject, ~, handles)
-%   Where the varargout seems not modified?
 % Feature
 %   Outputs from this function are returned to the command line.
 % Varargout
@@ -371,7 +367,6 @@ function RemovePlot(hObject, chan_id)
 %   handles    structure with handles and user data (see GUIDATA)
 % UIWAIT makes pspm_data_editor wait for user response (see UIRESUME)
 % handles.lbEpochsvarargout{1} = handles.output;
-varargout{1} = handles.output;
 delete(hObject);
 
 function lbEpochs_Callback(hObject, ~, ~)

src/pspm_display.m

@@ -157,14 +157,14 @@ function pspm_display_OpeningFcn(hObject, ~, handles, varargin)
 
 
 % --- Outputs from this function are returned to the command line.
-function varargout = pspm_display_OutputFcn(~, ~, handles)
+function handles.output = pspm_display_OutputFcn(~, ~, handles)
 % varargout  cell array for returning output args (see VARARGOUT);
 % hObject    handle to figure
 % eventdata  reserved - to be defined in a future version of MATLAB
 % handles    structure with handles and user data (see GUIDATA)
 
 % Get default command line output from handles structure
-varargout{1} = handles.output;
+
 end
 
 

src/pspm_ecg_editor.m

@@ -1,4 +1,4 @@
-function varargout = pspm_ecg_editor(varargin)
+function [sts, R] = pspm_ecg_editor(varargin)
 % ● Description
 %   pspm_ecg_edtior allows manual correction of ecg data and creates a hb
 %   output. Function can be called seperately.
@@ -50,7 +50,7 @@
 end
 
 if nargout
-  [varargout{1:nargout}] = gui_mainfcn(gui_State, varargin{:});
+  [sts, R] = gui_mainfcn(gui_State, varargin{:});
 else
   gui_mainfcn(gui_State, varargin{:});
 end

src/pspm_extract_segments.m

@@ -75,7 +75,7 @@
         (~strcmpi(method, 'model') && nargin < 4)
     warning('ID:invalid_input', 'Don''t know what to do'); return
 elseif strcmpi(method, 'model')
-     data = pspm_load1(data, 'all');
+     [~, data, ~] = pspm_load1(data, 'all');
     if nargin > 2
         options = varargin{1};
     end

src/pspm_filtfilt.m

@@ -1,4 +1,4 @@
-function varargout = pspm_filtfilt(b,a,x)
+function [sts, y] = pspm_filtfilt(b,a,x)
 % ● Description
 %   pspm_filtfilt. Zero-phase forward and reverse digital filtering
 % ● Format
@@ -39,13 +39,6 @@
 end
 sts = -1;
 y = [];
-switch nargout
-  case 1
-    varargout{1} = y;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = y;
-end
 %% Check input data
 if nargin < 3
   warning('ID:invalid_input','Not enough parameters were specified.'); return;
@@ -54,7 +47,7 @@
 if n>1 && m>1
   y = zeros(size(x));
   for i=1:n
-    y(:,i) = pspm_filtfilt(b,a,x(:,i));
+    [~, y(:,i)] = pspm_filtfilt(b,a,x(:,i));
   end
   return
 end
@@ -97,11 +90,4 @@
 if m == 1, y = y.'; end
 %% Sort outputs
 sts = 1;
-switch nargout
-  case 1
-    varargout{1} = y;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = y;
-end
 return

src/pspm_find_channel.m

@@ -1,9 +1,8 @@
-function varargout = pspm_find_channel(headercell, channeltype)
+function channel = pspm_find_channel(headercell, channeltype)
 % ● Description
 %   pspm_find_channel searches a cell arrays of channel headers and
 %   finds the channel that matches the desired type.
 % ● Format
-%   [sts, channel] = pspm_find_channel(headercell, channeltype) or
 %   channel = pspm_find_channel(headercell, channeltype)
 % ● Arguments
 %   *  headercell: cell array of names (e.g. from acq import)
@@ -26,13 +25,6 @@
 end
 sts = -1;
 channel = [];
-switch nargout
-  case 1
-    varargout{1} = channel;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = channel;
-end
 %% 1 check input
 if nargin < 2
   warning('ID:invalid_input', '\Not enough input arguments.\n');
@@ -76,13 +68,4 @@
 else
   channel = find(channelflag==1);
 end
-%% 4 Sort output
-sts = 1;
-switch nargout
-  case 1
-    varargout{1} = channel;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = channel;
-end
 return

src/pspm_get_smr.m

@@ -76,7 +76,7 @@
       % get minimum frequency for reporting resolution
       import{iImport}.minfreq = min(1./diff(chandata{channel}))*1000;
       % convert pulse to waveform
-      import{iImport}.data = pspm_pulse_convert(chandata{channel}, settings.import.rsr, settings.import.sr);
+      [~, import{iImport}.data] = pspm_pulse_convert(chandata{channel}, settings.import.rsr, settings.import.sr);
       import{iImport}.sr   = settings.import.sr;
       import{iImport}.minfreq = min(import{iImport}.data);
     elseif chanhead{channel}.kind == 4 % up and down timestamps
@@ -86,7 +86,7 @@
         pulse(1)=[];
       end
       pulse = pulse(1:2:end);
-      import{iImport}.data = pspm_pulse_convert(pulse, settings.import.rsr, settings.import.sr);
+      [~, import{iImport}.data] = pspm_pulse_convert(pulse, settings.import.rsr, settings.import.sr);
       import{iImport}.sr = settings.import.sr;
       import{iImport}.minfreq = min(import{iImport}.data);
     else

src/pspm_get_smrx.m

@@ -100,7 +100,7 @@
     if import{iImport}.channel > 0
         channel = chanindx(import{iImport}.channel);
     else
-        [sts, channel] = pspm_find_channel({fileinfo.chaninfo.kind},...
+        channel = pspm_find_channel({fileinfo.chaninfo.kind},...
             import{iImport}.type);
         if sts < 1, return; end
     end

src/pspm_jobman.m

@@ -1,4 +1,4 @@
-function varargout = pspm_jobman(varargin)
+function job_id = pspm_jobman(varargin)
 % ● Description
 %   Main interface for PsPM Batch System
 %   Initialise jobs configuration and set MATLAB path accordingly.
@@ -53,7 +53,7 @@
 
 if ~nargin
   h = cfg_ui;
-  if nargout > 0, varargout = {h}; end
+  if nargout > 0, job_id = {h}; end
   return;
 end
 
@@ -113,19 +113,19 @@
     end
     cfg_ui('local_showjob', findobj(0,'tag','cfg_ui'), cjob);
     if nargout > 0
-      varargout{1} = cjob;
+      job_id = cjob;
     end
 
   case {'run'}
     cjob = cfg_util('initjob', mljob);
     cfg_util('run', cjob);
     if nargout > 0
-      varargout{1} = cfg_util('getalloutputs', cjob);
+      job_id = cfg_util('getalloutputs', cjob);
     end
     cfg_util('deljob', cjob);
 
   otherwise
-    error([varargin{1} ': unknown option']);
+    error([job_id ': unknown option']);
 end
 sts = 1;
 return

src/pspm_load1.m

@@ -1,4 +1,4 @@
-function varargout = pspm_load1(fn, action, savedata, options)
+function [sts, data, mdltype] = pspm_load1(fn, action, savedata, options)
 % ● Format
 %   [sts, data, mdltype] = pspm_load1(fn, action, savedata, options)
 % ● Arguments
@@ -310,17 +310,5 @@
   otherwise
     warning('ID:unknown_action', 'Unknown action. Just checking file. File is valid.'); return;
 end
-
 sts = 1;
-switch nargout
-  case 1
-    varargout{1} = data;
-  case 2
-    varargout{1} = data;
-    varargout{2} = mdltype;
-  case 3
-    varargout{1} = sts;
-    varargout{2} = data;
-    varargout{3} = mdltype;
-end
 return

src/pspm_overwrite.m

@@ -1,4 +1,4 @@
-function varargout = pspm_overwrite(varargin)
+function overwrite_final = pspm_overwrite(varargin)
 % ● Description
 %   pspm_overwrite generalises the overwriting operation
 %   pspm_overwrite considers the following situations
@@ -18,7 +18,7 @@
 %                 If a value, can be 0 (not to overwrite) or 1 (to overwrite).
 %                 If a struct, check if the field `overwrite` exist.
 % ● Examples
-%   [sts, overwrite_final] = pspm_overwrite(fn, overwrite)
+%   overwrite_final = pspm_overwrite(fn, overwrite)
 % ● Outputs
 %   * overwrite_final:  option of overwriting determined by pspm_overwrite
 %                       0: not to overwrite
@@ -35,13 +35,6 @@
 end
 sts = -1;
 overwrite_final = 0;
-switch nargout
-  case 1
-    varargout{1} = overwrite_final;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = overwrite_final;
-end
 %% 2 Check inputs
 switch numel(varargin)
   case 0
@@ -106,14 +99,4 @@
   warning('ID:invalid_input', 'overwrite can be only 0 or 1');
   return
 end
-%% 5 Check outputs
-switch nargout
-  case 1
-    varargout{1} = overwrite_final;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = overwrite_final;
-  otherwise
-    varargout{1} = overwrite_final;
-end
 return

src/pspm_prepdata.m

@@ -1,4 +1,4 @@
-function varargout = pspm_prepdata(varargin)
+function [sts, data, newsr] = pspm_prepdata(varargin)
 % ● Description
 %   pspm_prepdata is a shared PsPM function for twofold butterworth filting and
 %   downsampling raw data `on the fly`. This data is usually stored in results
@@ -47,17 +47,6 @@
 end
 outdata = data;
 newsr = 0;
-switch nargout
-  case 1
-    varargout{1} = outdata;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = outdata;
-  case 3
-    varargout{1} = sts;
-    varargout{2} = outdata;
-    varargout{3} = newsr;
-end
 
 %% Check input
 options = pspm_options(options, 'prepdata');
@@ -128,7 +117,7 @@
       data = filter(filt.b, filt.a, data);
       data = filter(filt.b, filt.a, data);
     else
-      data = pspm_filtfilt(filt.b, filt.a, data);
+      [~, data] = pspm_filtfilt(filt.b, filt.a, data);
     end
   end
 end
@@ -143,7 +132,7 @@
     data = filter(filt.b, filt.a, data);
     data = filter(filt.b, filt.a, data);
   else
-    data = pspm_filtfilt(filt.b, filt.a, data);
+    [~, data] = pspm_filtfilt(filt.b, filt.a, data);
   end
 end
 % if uni, remove dummy data
@@ -197,15 +186,4 @@
 %% Prepare the final data
 outdata = data;
 sts = 1;
-switch nargout
-  case 1
-    varargout{1} = outdata;
-  case 2
-    varargout{1} = sts;
-    varargout{2} = outdata;
-  case 3
-    varargout{1} = sts;
-    varargout{2} = outdata;
-    varargout{3} = newsr;
-end
 return