Home > vbmeg > external > yokogawa_lib > getYkgwHdrDigitize.m

getYkgwHdrDigitize

PURPOSE ^

Get header of the digitization information

SYNOPSIS ^

This is a script file.

DESCRIPTION ^

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

 brief:
   This function retrieves information of the digitization in the specified file.

 usage:
   digitize = getYkgwHdrDigitize(filepath)

 arguments:
   filepath              : file path

 return values:
   digitize
    .info : structure of system information
      .digitizer_file    : string, file path of digitizer file
      .done              :   bool, is matching done?
      .meg2digitizer     : 4 x 4 matrix, to transform MEG coordinate to Digitizer coordinate 
      .digitizer2meg     : 4 x 4 matrix, to transform Digitizer coordinate to MEG coordinate 
    .point               : structure array of point data
      .name              : string, point name
      .x                 : double, x-coordinate on digitizer coordinate [meter]
      .y                 : double, y-coordinate on digitizer coordinate [meter]
      .z                 : double, z-coordinate on digitizer coordinate [meter]

 rivision history
   2 : 2011.04.27 : fix .meg2digitizer .digitizer2meg
   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 digitization information
0002 % [ Yokogawa MEG Reader toolbox for MATLAB ]
0003 %
0004 % brief:
0005 %   This function retrieves information of the digitization in the specified file.
0006 %
0007 % usage:
0008 %   digitize = getYkgwHdrDigitize(filepath)
0009 %
0010 % arguments:
0011 %   filepath              : file path
0012 %
0013 % return values:
0014 %   digitize
0015 %    .info : structure of system information
0016 %      .digitizer_file    : string, file path of digitizer file
0017 %      .done              :   bool, is matching done?
0018 %      .meg2digitizer     : 4 x 4 matrix, to transform MEG coordinate to Digitizer coordinate
0019 %      .digitizer2meg     : 4 x 4 matrix, to transform Digitizer coordinate to MEG coordinate
0020 %    .point               : structure array of point data
0021 %      .name              : string, point name
0022 %      .x                 : double, x-coordinate on digitizer coordinate [meter]
0023 %      .y                 : double, y-coordinate on digitizer coordinate [meter]
0024 %      .z                 : double, z-coordinate on digitizer coordinate [meter]
0025 %
0026 % rivision history
0027 %   2 : 2011.04.27 : fix .meg2digitizer .digitizer2meg
0028 %   1 : 2011.02.14 : 1st argument is modified from file ID to file path.
0029 %   0 : 2010.06.24 : first release
0030 %
0031 % Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.

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