Home > vbmeg > external > yokogawa_lib > getYkgwHdrChannel.m

getYkgwHdrChannel

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 channel in the specified file.

 usage:
   channel_info = getYkgwHdrChannel(filepath)

 arguments:
   filepath           : file path

 return values:
   channel_info       : structure of channel information
     .channel_count   : double, total number of channel
     .channel         : structure array ('index 1' corresponds to 'channel 0')
        .type         : double, channel type as follows:
          NullChannel                     = 0;
          MagnetoMeter                    = 1;
          AxialGradioMeter                = 2;
          PlanarGradioMeter               = 3;
          ReferenceMagnetoMeter           = 257;
          ReferenceAxialGradioMeter       = 258;
          ReferencePlanarGradioMeter      = 259;
          TriggerChannel                  = -1;
          EegChannel                      = -2;
          EcgChannel                      = -3;
          EtcChannel                      = -4;
       .data          : structure of channel specifications, 
                        fields of each channel type is as follows:
         [ AxialGradioMeter, ReferenceAxialGradioMeter ]
           .x        : double, x coordinate [m] of pickup sensor position
           .y        : double, y coordinate [m] of pickup sensor position
           .z        : double, z coordinate [m] of pickup sensor position
           .zdir     : double, sensor direction [degree]
           .xdir     : double, sensor direction [degree]
           .baseline : double, length of baseline [m]
           .size     : double, pickup coil size [m] (diameter of coil circle)
           .name     : string, abbreviation name
         [ PlanarGradioMeter, ReferencePlanarGradioMeter ]
           .x        : double, x coordinate [m] of pickup sensor position
           .y        : double, y coordinate [m] of pickup sensor position
           .z        : double, z coordinate [m] of pickup sensor position
           .zdir1    : double, sensor direction [degree]
           .xdir1    : double, sensor direction [degree]
           .zdir2    : double, baseline direction (pickup coil to reference coil) [degree]
           .xdir2    : double, baseline direction (pickup coil to reference coil) [degree]
           .baseline : double, length of baseline [m]
           .size     : double, pickup coil size [m] (a side of square coil)
         [ MagnetoMeter, ReferenceMagnetoMeter ]
           .x        : double, x coordinate [m] of coil position
           .y        : double, y coordinate [m] of coil position
           .z        : double, z coordinate [m] of coil position
           .zdir     : double, coil direction [degree]
           .xdir     : double, coil direction [degree]
           .size     : double, coil size [m] (diameter of coil circle)
           .name     : string, abbreviation name
         [ TriggerChannel, EtcChannel ]
           .type     : double, type
           .id       : double, ID
           .name     : string, abbreviation name
         [ EegChannel, EcgChannel ]
           .type     : double, EEG/ECG type
           .id       : double, EEG/ECG ID
           .name     : string, abbreviation name
           .gain     : double, gain
         [ NullChannel ] no field
         * All coordinate is based on MEG device coordinate system.

 rivision history
   2 : 2011.04.27 : remove the end of unnecessary spaces for channel name
   1 : 2011.02.14 : 1st argument is modified from file ID to file path.
   0 : 2010.06.30 : 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 channel in the specified file.
0006 %
0007 % usage:
0008 %   channel_info = getYkgwHdrChannel(filepath)
0009 %
0010 % arguments:
0011 %   filepath           : file path
0012 %
0013 % return values:
0014 %   channel_info       : structure of channel information
0015 %     .channel_count   : double, total number of channel
0016 %     .channel         : structure array ('index 1' corresponds to 'channel 0')
0017 %        .type         : double, channel type as follows:
0018 %          NullChannel                     = 0;
0019 %          MagnetoMeter                    = 1;
0020 %          AxialGradioMeter                = 2;
0021 %          PlanarGradioMeter               = 3;
0022 %          ReferenceMagnetoMeter           = 257;
0023 %          ReferenceAxialGradioMeter       = 258;
0024 %          ReferencePlanarGradioMeter      = 259;
0025 %          TriggerChannel                  = -1;
0026 %          EegChannel                      = -2;
0027 %          EcgChannel                      = -3;
0028 %          EtcChannel                      = -4;
0029 %       .data          : structure of channel specifications,
0030 %                        fields of each channel type is as follows:
0031 %         [ AxialGradioMeter, ReferenceAxialGradioMeter ]
0032 %           .x        : double, x coordinate [m] of pickup sensor position
0033 %           .y        : double, y coordinate [m] of pickup sensor position
0034 %           .z        : double, z coordinate [m] of pickup sensor position
0035 %           .zdir     : double, sensor direction [degree]
0036 %           .xdir     : double, sensor direction [degree]
0037 %           .baseline : double, length of baseline [m]
0038 %           .size     : double, pickup coil size [m] (diameter of coil circle)
0039 %           .name     : string, abbreviation name
0040 %         [ PlanarGradioMeter, ReferencePlanarGradioMeter ]
0041 %           .x        : double, x coordinate [m] of pickup sensor position
0042 %           .y        : double, y coordinate [m] of pickup sensor position
0043 %           .z        : double, z coordinate [m] of pickup sensor position
0044 %           .zdir1    : double, sensor direction [degree]
0045 %           .xdir1    : double, sensor direction [degree]
0046 %           .zdir2    : double, baseline direction (pickup coil to reference coil) [degree]
0047 %           .xdir2    : double, baseline direction (pickup coil to reference coil) [degree]
0048 %           .baseline : double, length of baseline [m]
0049 %           .size     : double, pickup coil size [m] (a side of square coil)
0050 %         [ MagnetoMeter, ReferenceMagnetoMeter ]
0051 %           .x        : double, x coordinate [m] of coil position
0052 %           .y        : double, y coordinate [m] of coil position
0053 %           .z        : double, z coordinate [m] of coil position
0054 %           .zdir     : double, coil direction [degree]
0055 %           .xdir     : double, coil direction [degree]
0056 %           .size     : double, coil size [m] (diameter of coil circle)
0057 %           .name     : string, abbreviation name
0058 %         [ TriggerChannel, EtcChannel ]
0059 %           .type     : double, type
0060 %           .id       : double, ID
0061 %           .name     : string, abbreviation name
0062 %         [ EegChannel, EcgChannel ]
0063 %           .type     : double, EEG/ECG type
0064 %           .id       : double, EEG/ECG ID
0065 %           .name     : string, abbreviation name
0066 %           .gain     : double, gain
0067 %         [ NullChannel ] no field
0068 %         * All coordinate is based on MEG device coordinate system.
0069 %
0070 % rivision history
0071 %   2 : 2011.04.27 : remove the end of unnecessary spaces for channel name
0072 %   1 : 2011.02.14 : 1st argument is modified from file ID to file path.
0073 %   0 : 2010.06.30 : first release
0074 %
0075 % Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.

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