Get header of the source information
[ Yokogawa MEG Reader toolbox for MATLAB ]
brief:
This function retrieves information of the sources in the specified file.
usage:
source = getYkgwHdrSource(filepath)
arguments:
filepath : file path
return values:
source : structure array of analyzed source information.
Note : Sources are arranged in order of estimated time.
.type : double, Type of source
DipoleModel = 1;
DistributedSourceModel = 2;
.time : double, Analyzed Time [second] from 1970.1.1
.sample_no : double, Time sample index of source
.channel_list : row vector(double), Channel number (0 origin) list which used to estimate
.model : structure of conductor model
.type : double, Conductor model type
UNKNOWN_MODEL = -1;
NO_MODEL = 0;
SPHERICAL_MODEL = 1;
LAYERED_MODEL = 2;
If Conductor model type is SPHERICAL_MODEL,
.cx : double, x coordinate of spherical center position on MEG coordinate [meter]
.cy : double, y coordinate of spherical center position on MEG coordinate [meter]
.cz : double, z coordinate of spherical center position on MEG coordinate [meter]
.radius : double, radius of spherical conductor on MRI coordinate [meter]
If Conductor model type is LAYERED_MODEL,
.ax : double, Coefficient 'ax' of planar equation 'ax * x + ay * y + az * z = c'
.ay : double, Coefficient 'ay' of planar equation 'ax * x + ay * y + az * z = c'
.az : double, Coefficient 'az' of planar equation 'ax * x + ay * y + az * z = c'
.c : double, Coefficient 'c' of planar equation 'ax * x + ay * y + az * z = c'
.algorithm : structure of conductor algorithm
.magnetic_field_calc : double, Algorithm of magnetic field calculation
BiotSavartLaw = 1;
SarvasLaw = 2;
MagneticDipoleLaw = 3;
.variable_restraint : double, Algorithm of variable restraint
NoRestraint = 0;
PositionRestraint = 1;
DirectionRestraint = 2;
IntensityRestraint = 3;
.optimization : double, Algorithm of optimization
GradientAlgorithm = 1;
LeadFieldReconstructionAlgorithm = 2;
ManualSetAlgorithm = 3;
UserAlgorithm = 4;
.filter : structure of spectral filter setting
.hpf , .lpf : structure of high-pass / low-pass filter setting
.enable : bool, Does this filter enable?
.cutoff_frequency : double, Cutoff frequency [Hz]
.window_type : double, Window type
NoWindow = 0;
HanningWindow = 1;
HammingWindow = 2;
.width : double, Filter width
.bpf, .bef : structure of band-pass / band-eliminate filter setting
.enable : bool, Does this filter enable?
.low_frequency : double, Low frequency [Hz]
.high_frequency : double, High frequency [Hz]
.window_type : double, Window type
.width : double, Filter width
.moveave : structure of moving average setting
.enable : bool, Does this filter enable?
.width : double, Filter width
.baseadj : structure of baseline adjustment setting
.enable : bool, Does this filter enable?
.type : double, Type of baseline adjustment
PretriggerBaselineAdjust = 0;
PosttriggerBaselineAdjust = 1;
AllRangeBaselineAdjust = 2;
ExplicitBaselineAdjust = 3;
.start_time : double, Start time [millisecond]
.end_time : double, End time [millisecond]
.gof : double, Goodness-of-fit (GOF)
.correlation : double, Corrlation Coefficiency
.label : double, Label
.comment : string, Comment
.total_intensity : double, Total intensity of sources
.dipole_count : double, Number of dipole sources
.dipole_list : structure array of dipole sources
.x : double, x coordinate of dipole position on MEG coordinate [meter]
.y : double, y coordinate of dipole position on MEG coordinate [meter]
.z : double, z coordinate of dipole position on MEG coordinate [meter]
.zdir : double, Dipole orientation from z-axis [degree]
.xdir : double, Dipole orientation from z-axis [degree]
.intensity : double, Dipole intensity (moment) [Ampere Meter]
rivision history
2 : 2011.03.03 : Structure fields (confidence volume, confidence ratio, reference_no)
which are not used were removed.
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.0001 % Get header of the source information 0002 % [ Yokogawa MEG Reader toolbox for MATLAB ] 0003 % 0004 % brief: 0005 % This function retrieves information of the sources in the specified file. 0006 % 0007 % usage: 0008 % source = getYkgwHdrSource(filepath) 0009 % 0010 % arguments: 0011 % filepath : file path 0012 % 0013 % return values: 0014 % source : structure array of analyzed source information. 0015 % Note : Sources are arranged in order of estimated time. 0016 % .type : double, Type of source 0017 % DipoleModel = 1; 0018 % DistributedSourceModel = 2; 0019 % .time : double, Analyzed Time [second] from 1970.1.1 0020 % .sample_no : double, Time sample index of source 0021 % .channel_list : row vector(double), Channel number (0 origin) list which used to estimate 0022 % .model : structure of conductor model 0023 % .type : double, Conductor model type 0024 % UNKNOWN_MODEL = -1; 0025 % NO_MODEL = 0; 0026 % SPHERICAL_MODEL = 1; 0027 % LAYERED_MODEL = 2; 0028 % If Conductor model type is SPHERICAL_MODEL, 0029 % .cx : double, x coordinate of spherical center position on MEG coordinate [meter] 0030 % .cy : double, y coordinate of spherical center position on MEG coordinate [meter] 0031 % .cz : double, z coordinate of spherical center position on MEG coordinate [meter] 0032 % .radius : double, radius of spherical conductor on MRI coordinate [meter] 0033 % If Conductor model type is LAYERED_MODEL, 0034 % .ax : double, Coefficient 'ax' of planar equation 'ax * x + ay * y + az * z = c' 0035 % .ay : double, Coefficient 'ay' of planar equation 'ax * x + ay * y + az * z = c' 0036 % .az : double, Coefficient 'az' of planar equation 'ax * x + ay * y + az * z = c' 0037 % .c : double, Coefficient 'c' of planar equation 'ax * x + ay * y + az * z = c' 0038 % .algorithm : structure of conductor algorithm 0039 % .magnetic_field_calc : double, Algorithm of magnetic field calculation 0040 % BiotSavartLaw = 1; 0041 % SarvasLaw = 2; 0042 % MagneticDipoleLaw = 3; 0043 % .variable_restraint : double, Algorithm of variable restraint 0044 % NoRestraint = 0; 0045 % PositionRestraint = 1; 0046 % DirectionRestraint = 2; 0047 % IntensityRestraint = 3; 0048 % .optimization : double, Algorithm of optimization 0049 % GradientAlgorithm = 1; 0050 % LeadFieldReconstructionAlgorithm = 2; 0051 % ManualSetAlgorithm = 3; 0052 % UserAlgorithm = 4; 0053 % .filter : structure of spectral filter setting 0054 % .hpf , .lpf : structure of high-pass / low-pass filter setting 0055 % .enable : bool, Does this filter enable? 0056 % .cutoff_frequency : double, Cutoff frequency [Hz] 0057 % .window_type : double, Window type 0058 % NoWindow = 0; 0059 % HanningWindow = 1; 0060 % HammingWindow = 2; 0061 % .width : double, Filter width 0062 % .bpf, .bef : structure of band-pass / band-eliminate filter setting 0063 % .enable : bool, Does this filter enable? 0064 % .low_frequency : double, Low frequency [Hz] 0065 % .high_frequency : double, High frequency [Hz] 0066 % .window_type : double, Window type 0067 % .width : double, Filter width 0068 % .moveave : structure of moving average setting 0069 % .enable : bool, Does this filter enable? 0070 % .width : double, Filter width 0071 % .baseadj : structure of baseline adjustment setting 0072 % .enable : bool, Does this filter enable? 0073 % .type : double, Type of baseline adjustment 0074 % PretriggerBaselineAdjust = 0; 0075 % PosttriggerBaselineAdjust = 1; 0076 % AllRangeBaselineAdjust = 2; 0077 % ExplicitBaselineAdjust = 3; 0078 % .start_time : double, Start time [millisecond] 0079 % .end_time : double, End time [millisecond] 0080 % .gof : double, Goodness-of-fit (GOF) 0081 % .correlation : double, Corrlation Coefficiency 0082 % .label : double, Label 0083 % .comment : string, Comment 0084 % .total_intensity : double, Total intensity of sources 0085 % .dipole_count : double, Number of dipole sources 0086 % .dipole_list : structure array of dipole sources 0087 % .x : double, x coordinate of dipole position on MEG coordinate [meter] 0088 % .y : double, y coordinate of dipole position on MEG coordinate [meter] 0089 % .z : double, z coordinate of dipole position on MEG coordinate [meter] 0090 % .zdir : double, Dipole orientation from z-axis [degree] 0091 % .xdir : double, Dipole orientation from z-axis [degree] 0092 % .intensity : double, Dipole intensity (moment) [Ampere Meter] 0093 % 0094 % rivision history 0095 % 2 : 2011.03.03 : Structure fields (confidence volume, confidence ratio, reference_no) 0096 % which are not used were removed. 0097 % 1 : 2011.02.14 : 1st argument is modified from file ID to file path. 0098 % 0 : 2010.06.24 : first release 0099 % 0100 % Copyright (C) 2010-2011 Yokogawa Electric Corporation, All Rights Reserved.