Home > vbmeg > external > yokogawa_lib > getYkgwData.m

getYkgwData

PURPOSE ^

Get measured data

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 Get measured data
 [ Yokogawa MEG Reader toolbox for MATLAB ]

 brief:
   This function retrieves the measurement data of whole channel by the specified file and sample range.

 usage:
   data = getYkgwData(filepath, start_sample, sample_length)

 arguments:
   filepath        : file path

   start_sample    : The start number corresponding to each acquisition type is as follows :
    Continuous Raw : Start sample number for retrieving data. (0 origin)
    Evoked Average : Start sample number for retrieving data. (0 origin)
    Evoked Raw     : Start frame  number for retrieving data. (1 origin)
      note : When both start_sample and sample_length are omitted, you can get data of whole samples.

   sample_length   : The number of samples or trials corresponding to each acquisition type is as follows :
    Continuous Raw : Number of samples for retrieving data.
    Evoked Average : Number of frames for retrieving data.
    Evoked Raw     : Number of frames for retrieving data.
      note : When this parameter is omitted or is specified as 'Inf',
              you can get data from start_sample to the end of sample(frame).

 return values:
   data            : (number of channel x number of sample) double matrix of measured data 
          The unit corresponding to each channel type is as follows :
           AxialGradioMeter              [Tesla]
           PlannerGradioMeter            [Tesla]
           MagnetoMeter                  [Tesla]
           RefferenceMagnetoMeter        [Tesla]
           RefferenceAxialGradioMeter    [Tesla]
           RefferencePlannerGradioMeter  [Tesla]
           TriggerChannel                [Volt]
           EegChannel                    [Volt] *This has already been reflected EEG gain
           EcgChannel                    [Volt] *This has already been reflected ECG gain
           EtcChannel                    [Volt]
           NullChannel                   [Volt]


 rivision history
   4 : 2011.03.24 : Support GetSqf changes
   3 : 2011.03.03 : Support MegLaboratory R1.4.8 calibration for non-MEG
                    channels whose sensitivities are not specified.
   2 : 2011.02.14 : Fix EvokedRaw error if sample_length argument is omitted.
                    1st argument is modified from file ID to file path.
   1 : 2011.01.24 : Not apply averaged gain to reference channels if system id is 1000 later. 
   0 : 2010.06.24 : first release
 
 Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % Get measured data
0002 % [ Yokogawa MEG Reader toolbox for MATLAB ]
0003 %
0004 % brief:
0005 %   This function retrieves the measurement data of whole channel by the specified file and sample range.
0006 %
0007 % usage:
0008 %   data = getYkgwData(filepath, start_sample, sample_length)
0009 %
0010 % arguments:
0011 %   filepath        : file path
0012 %
0013 %   start_sample    : The start number corresponding to each acquisition type is as follows :
0014 %    Continuous Raw : Start sample number for retrieving data. (0 origin)
0015 %    Evoked Average : Start sample number for retrieving data. (0 origin)
0016 %    Evoked Raw     : Start frame  number for retrieving data. (1 origin)
0017 %      note : When both start_sample and sample_length are omitted, you can get data of whole samples.
0018 %
0019 %   sample_length   : The number of samples or trials corresponding to each acquisition type is as follows :
0020 %    Continuous Raw : Number of samples for retrieving data.
0021 %    Evoked Average : Number of frames for retrieving data.
0022 %    Evoked Raw     : Number of frames for retrieving data.
0023 %      note : When this parameter is omitted or is specified as 'Inf',
0024 %              you can get data from start_sample to the end of sample(frame).
0025 %
0026 % return values:
0027 %   data            : (number of channel x number of sample) double matrix of measured data
0028 %          The unit corresponding to each channel type is as follows :
0029 %           AxialGradioMeter              [Tesla]
0030 %           PlannerGradioMeter            [Tesla]
0031 %           MagnetoMeter                  [Tesla]
0032 %           RefferenceMagnetoMeter        [Tesla]
0033 %           RefferenceAxialGradioMeter    [Tesla]
0034 %           RefferencePlannerGradioMeter  [Tesla]
0035 %           TriggerChannel                [Volt]
0036 %           EegChannel                    [Volt] *This has already been reflected EEG gain
0037 %           EcgChannel                    [Volt] *This has already been reflected ECG gain
0038 %           EtcChannel                    [Volt]
0039 %           NullChannel                   [Volt]
0040 %
0041 %
0042 % rivision history
0043 %   4 : 2011.03.24 : Support GetSqf changes
0044 %   3 : 2011.03.03 : Support MegLaboratory R1.4.8 calibration for non-MEG
0045 %                    channels whose sensitivities are not specified.
0046 %   2 : 2011.02.14 : Fix EvokedRaw error if sample_length argument is omitted.
0047 %                    1st argument is modified from file ID to file path.
0048 %   1 : 2011.01.24 : Not apply averaged gain to reference channels if system id is 1000 later.
0049 %   0 : 2010.06.24 : first release
0050 %
0051 % Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.

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