Home > vbmeg > functions > device > meg > yokogawa > vb_calibinfo_get_fll_gain.m

vb_calibinfo_get_fll_gain

PURPOSE ^

return FLL gain from calib_info

SYNOPSIS ^

function [gain] = vb_calibinfo_get_fll_gain(calib_info)

DESCRIPTION ^

 return FLL gain from calib_info

 [usage]
   [gain] = vb_calibinfo_get_fll_gain(calib_info)

 [input]
   calib_info : <required> <<struct>> calibration information
              :  temporary struct for pre-process
              :   .sensitivity <<struct array>> [1 x n_ch]
              :     .offset
              :     .gain
              :   .fll <struct array>> [1 x n_fll]
              :     .gain
              :   .ad
              :     .bit
              :     .analog_range
              :
              :   .sensor_label {n_ch x 1}

 [output]
         gain : FLL gain

 [note]
 
 [history]
   2007-06-28 (Sako) initial version
   2011-06-28 (Sako) modified to use the new YOKOGAWA library

 Copyright (C) 2011, ATR All Rights Reserved.
 License : New BSD License(see VBMEG_LICENSE.txt)

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function [gain] = vb_calibinfo_get_fll_gain(calib_info)
0002 % return FLL gain from calib_info
0003 %
0004 % [usage]
0005 %   [gain] = vb_calibinfo_get_fll_gain(calib_info)
0006 %
0007 % [input]
0008 %   calib_info : <required> <<struct>> calibration information
0009 %              :  temporary struct for pre-process
0010 %              :   .sensitivity <<struct array>> [1 x n_ch]
0011 %              :     .offset
0012 %              :     .gain
0013 %              :   .fll <struct array>> [1 x n_fll]
0014 %              :     .gain
0015 %              :   .ad
0016 %              :     .bit
0017 %              :     .analog_range
0018 %              :
0019 %              :   .sensor_label {n_ch x 1}
0020 %
0021 % [output]
0022 %         gain : FLL gain
0023 %
0024 % [note]
0025 %
0026 % [history]
0027 %   2007-06-28 (Sako) initial version
0028 %   2011-06-28 (Sako) modified to use the new YOKOGAWA library
0029 %
0030 % Copyright (C) 2011, ATR All Rights Reserved.
0031 % License : New BSD License(see VBMEG_LICENSE.txt)
0032 
0033 % --- CHECK ARGUMENTS --- %
0034 if ~exist('calib_info', 'var'), calib_info = []; end
0035 [calib_info] = inner_check_arguments(calib_info);
0036 
0037 
0038 % --- MAIN PROCEDURE --------------------------------------------------------- %
0039 %
0040 gain = [calib_info.fll(:).gain]';
0041 return;
0042 %
0043 % --- END OF MAIN PROCEDURE -------------------------------------------------- %
0044 
0045 
0046 % --- INNER FUNCTIONS -------------------------------------------------------- %
0047 %
0048 % --- inner_check_arguments()
0049 %
0050 function [calib_info] = inner_check_arguments(calib_info)
0051 
0052 func_ = mfilename;
0053 
0054 if isempty(calib_info)
0055   error('(%s) calib_info is a required parameter', func_);
0056 end
0057 
0058 if ~isfield(calib_info, 'fll')
0059   error('(%s) fll is a required field', func_);
0060 end
0061 
0062 if ~isfield(calib_info.fll, 'gain')
0063   error('(%s) fll.gain is a required field', func_);
0064 end
0065 return;
0066 %
0067 % --- end of inner_check_arguments()
0068 %
0069 % --- END OF INNER FUNCTIONS ------------------------------------------------- %
0070 
0071 % --- END OF FILE --- %

Generated on Mon 22-May-2023 06:53:56 by m2html © 2005