Documentation needed - Githubissues

erfanzabeh / WaveMonk

Detection and Quantification of Traveling Wave in Monkey Utah array recordings

5 stars 0 forks source link

Documentation needed #1

Open OccassionalBioinformatician opened 1 year ago

OccassionalBioinformatician commented 1 year ago

Please have some documentation on the input variables ContinuesPhimatrix, Phi_matrix, Array_Pith_Size, and Fs. My guesses are:

Fs is the sampling rate.
Phi_matrix is a matrix of phase angles stored as x-coord * y-coord * time.
ContinuesPhimatrix appears to be an unwrapped version of Phi_matrix, obtained by running SmoothContinuesPhase.m or Periodic2ContinuesPhase2.m. That said, the latter function uses clustering — why?
Array_Pith_Size appears to be the distance between neighboring electrodes.

Likewise, it is good to have some documentation on the wave-detection functions:

RegressionMethodSpectrum.m is a simple version of RegressionMethod.m
GradientMethodSpectrum.m is a simple version of GradientMethod.m
But, why?

dervinism commented 1 year ago

Hi @OccassionalBioinformatician, @erfanzabeh,

Have you managed to use the function successfully? I'm planing to try it out too. Please let me know if you have any comments. It would also be good to know if there is a way to deal with missing/bad electrodes. Can they be set to NaNs. Would the Algorithm deal with NaNs correctly?