Home > vbmeg > external > yokogawa_lib > getYkgwHdrAcqCond.m

getYkgwHdrAcqCond

PURPOSE ^

Get header of the system information

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

 Get header of the system information
 [ Yokogawa MEG Reader toolbox for MATLAB ]

 brief:
   This function retrieves information about data acquisition condition in the specified file.

 usage:
   acq_cond = getYkgwHdrAcqCond(filepath)

 arguments:
   filepath                        : file path

 return values:
   acq_cond : structure of acquisition condition
    .acq_type                      : double, acquisition type (1 : ContinuousRaw, 2 : EvokedAverage, 3 : EvokedRaw)
         AcqTypeContinuousRaw      = 1;
         AcqTypeEvokedAve          = 2;
         AcqTypeEvokedRaw          = 3;

   [when ContinuousRaw(*.con) acquisition type]
    .sample_rate                   : double, sampling rate [Hz]
    .sample_count                  : double, number of sample which actually acquired [sample]
    .specified_sample_count        : double, The number of samples which were specified before starting acquisition [sample]

   [when EvokedRaw(*.raw) or EvokedAve(*.ave) acquisition type] 
    .sample_rate                   : double, sampling rate [Hz]
    .frame_length                  : double, frame length [sample]
    .pretrigger_length             : double, pretrigger length [sample]
    .average_count                 : double, The number of trials(frames) which were actually acquired [trial]
    .specified_average_count       : double, The number of trials(frames) which were specified before starting acquisition [trials]

    .multi_trigger                 : The structure of multi trigger information.
       .enable                     : boolean, Is multi trigger mode ? (true : multi trigger mode)
       .count                      : double,  Number of multi triggers
       .list                       : structure array List of multi triggers  
                                    (If not multi trigger mode, this structure array is set to empty.)
          .enable                  : boolean, Is current multi trigger set to enable ? (true : enable)
          .code                    : double,  Event code (1 origin)
          .name                    : string,  Event name
          .average_count           : double,  The number of trials(frames) which were actually acquired [trial]
          .specified_average_count : double,  The number of trials(frames) which were specified before starting acquisition [trials]
         
 rivision history
   2 : 2011.04.27 : 'multi_trigger' field was added to output structure.
   1 : 2011.02.14 : 1st argument is modified from file ID to file path.
   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 header of the system information
0002 % [ Yokogawa MEG Reader toolbox for MATLAB ]
0003 %
0004 % brief:
0005 %   This function retrieves information about data acquisition condition in the specified file.
0006 %
0007 % usage:
0008 %   acq_cond = getYkgwHdrAcqCond(filepath)
0009 %
0010 % arguments:
0011 %   filepath                        : file path
0012 %
0013 % return values:
0014 %   acq_cond : structure of acquisition condition
0015 %    .acq_type                      : double, acquisition type (1 : ContinuousRaw, 2 : EvokedAverage, 3 : EvokedRaw)
0016 %         AcqTypeContinuousRaw      = 1;
0017 %         AcqTypeEvokedAve          = 2;
0018 %         AcqTypeEvokedRaw          = 3;
0019 %
0020 %   [when ContinuousRaw(*.con) acquisition type]
0021 %    .sample_rate                   : double, sampling rate [Hz]
0022 %    .sample_count                  : double, number of sample which actually acquired [sample]
0023 %    .specified_sample_count        : double, The number of samples which were specified before starting acquisition [sample]
0024 %
0025 %   [when EvokedRaw(*.raw) or EvokedAve(*.ave) acquisition type]
0026 %    .sample_rate                   : double, sampling rate [Hz]
0027 %    .frame_length                  : double, frame length [sample]
0028 %    .pretrigger_length             : double, pretrigger length [sample]
0029 %    .average_count                 : double, The number of trials(frames) which were actually acquired [trial]
0030 %    .specified_average_count       : double, The number of trials(frames) which were specified before starting acquisition [trials]
0031 %
0032 %    .multi_trigger                 : The structure of multi trigger information.
0033 %       .enable                     : boolean, Is multi trigger mode ? (true : multi trigger mode)
0034 %       .count                      : double,  Number of multi triggers
0035 %       .list                       : structure array List of multi triggers
0036 %                                    (If not multi trigger mode, this structure array is set to empty.)
0037 %          .enable                  : boolean, Is current multi trigger set to enable ? (true : enable)
0038 %          .code                    : double,  Event code (1 origin)
0039 %          .name                    : string,  Event name
0040 %          .average_count           : double,  The number of trials(frames) which were actually acquired [trial]
0041 %          .specified_average_count : double,  The number of trials(frames) which were specified before starting acquisition [trials]
0042 %
0043 % rivision history
0044 %   2 : 2011.04.27 : 'multi_trigger' field was added to output structure.
0045 %   1 : 2011.02.14 : 1st argument is modified from file ID to file path.
0046 %   0 : 2010.06.24 : first release
0047 %
0048 % Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.

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