Added input args

Author: k1o0

+hw/calibrate.m

@@ -1,7 +1,9 @@
 function calibration = calibrate(channel, rewardController, scales, tMin, tMax, varargin)
 %HW.CALIBRATE Performs measured reward deliveries for calibration
 %   This function is used by srv.expServer to return a water calibration.
-%   It still requires some scales to be attached to the computer.  
+%   It still requires some scales to be attached to the computer.  The
+%   resulting calibration data are returned and also appended to the
+%   rewardController 'Calibrations' property.
 %
 %   Inputs:
 %     channel (char) - the name of the channel to use.  Must match one of
@@ -26,6 +28,10 @@
 %     settleWait (double) - time in seconds to wait between delivering
 %       sample and recording a new weight.  Gives the scale reading time to
 %       stabalize.  Default 2 seconds.
+%
+%   Output:
+%     calibration (struct): An 1xnVolumes structure with the fields
+%       'durationSecs' and 'volumeMicroLitres'.
 %     
 %   TODO: Sanitize and integrate into HW.REWARDVALVECONTROL
 %

cortexlab/+hw/checkCalibration.m

@@ -1,24 +1,57 @@
-function c = checkCalibration()
-channel = 'rewardValve'; % The channel name of the reward controller
+function c = checkValveCalibration(channelName, volumes)
+% HW.CHECKVALVECALIBRATION Check two volumes along calibration plot
+%   This function is used to plot the measured volumes at two points along
+%   the last recorded calibration curve. This can be used to easily check
+%   whether the calibration is still accurate.
+%
+%   Inputs (Optional):
+%     channelName (char): The name of the reward valve channel to check.
+%       The channel name must be associated with a hw.RewardValveControl
+%       object in the rig's hw.DaqController object. Default 'rewardValve'.
+%     volumes (numerical): A 2-element array of volumes to check.  Default
+%       is to pick two evenly spaced volumes within the calibration range.
+%
+%   Ouput:
+%     c (struct): The measured volumes corresponding to the opening times.
+%
+% Examples:
+%   % Plot two measured volumes again the previous calibration data
+%   hw.checkRewardValveCalibration();
+%
+%   % Check by how much the deliveries have changed for some given volumes
+%   volumes = [2 3]; % Check 2 and 3ul deliveries
+%   c = hw.checkRewardValveCalibration('rewardValve', volumes);
+%   dV = diff([c.volumeMicroLitres; volumes])
+%
+% See also hw.calibrate, hw.RewardValveControl
+
+% The default channel name of the reward controller
+if nargin < 1, channelName = 'rewardValve'; end
 rig = hw.devices; % Load the hardware file
 
 % Fetch the reward control signal generator object
-rewardId = strcmp(rig.daqController.ChannelNames, channel);
+rewardId = strcmp(rig.daqController.ChannelNames, channelName);
 signalGen = rig.daqController.SignalGenerators(rewardID);
 % Fetch the most recent calibration
 [newestDate, I] = max([signalGen.Calibrations.dateTime]);
 lastCalibration = signalGen(rewardId).Calibrations(I);
 ul = [lastCalibration.volumeMicroLitres]; % Recorded volumes
 dt = [lastCalibration.durationSecs]; % Previous opening times
 
-% Two specific volumes to test
-volumes = [2, 3];
-durations = arrayfun(@(x)interp1(ul, dt, x, 'pchip'), volumes);
-% OR two equally spaced points within the range
-durations = pick(linspace(dt(1), dt(end), 4), [2,3]);
+if nargin > 1
+  % User provided two specific volumes to test
+  assert(isnumeric(volumes) && numel(volumes) == 2, ...
+    'Rigbox:hw:checkCalibration:volumesIncorrect', ...
+    'volumes must be a two element numerical array')
+  % Interpolate previous calibration data to find opening times
+  durations = arrayfun(@(x)interp1(ul, dt, x, 'pchip'), volumes);
+else
+  % Otherwise pick two equally spaced points within the calibration range
+  durations = pick(linspace(dt(1), dt(end), 4), 2:3);
+end
 
 % Run a quick calibration
-c = hw.calibrate(channel, rig.daqController, rig.scale, ...
+c = hw.calibrate(channelName, rig.daqController, rig.scale, ...
   durations(1), ...       % Min opening time
   durations(2), ...       % Max opening time
   'settleWait', 1, ...    % Set to 1 to trim test time