Back to the main page.

Bug 1650 - similar cfg options should have similar reference documentation

Status NEW
Reported 2012-08-13 13:14:00 +0200
Modified 2013-07-23 23:07:29 +0200
Product: FieldTrip
Component: documentation
Version: unspecified
Hardware: PC
Operating System: Mac OS
Importance: P3 normal
Assigned to:
Depends on:
See also:

Robert Oostenveld - 2012-08-13 13:14:56 +0200

if you look scroll over you see that some options have almost -- but not exactly the same -- reference documentation (i.e. in the help in the m-file). For example cfg.baselinewindow is explained in three different ways, whereas they all seem to have the same meaning/interpretation/explanation and the same default values. Also has slightly different documentations. These should (where possible) all be made the same. In case of doubt keep the original documentation. If you see any other inconsistencies (e.g. I noticed cfg.unit and cfg.units both being used, but in slightly different functions), please write them down.

Robert Oostenveld - 2012-08-13 13:33:52 +0200

see also ft_documentationindex which runs every evening

Lilla Magyari - 2012-09-04 18:08:18 +0200

(In reply to comment #1) are cfg options of ft_artifact_eog "default" options or "hard-wired" options that users can't change? because it looks like the later one now.

Lilla Magyari - 2012-09-04 18:21:03 +0200

(In reply to comment #1) How should the reference look like? for example: cfg.baseline = [begin end] (default = 'no') cfg.baselinetype = 'absolute', 'relchange' or 'relative' (default = 'absolute') cfg.parameter = field for which to apply baseline normalization, or cell array of strings to specify multiple fields to normalize (default = 'powspctrm') could be better like this? cfg.baseline = number or string, [begin end] in seconds or 'no' if no baseline should be applied (default = 'no') cfg.baselinetype = string, 'absolute', 'relchange' or 'relative' (default = 'absolute') cfg.parameter = string, name of field for which to apply baseline normalization, or cell array of strings, name of fields to specify multiple fields to normalize (default = 'powspctrm')

Robert Oostenveld - 2012-09-04 18:23:54 +0200

I like the second style!

Jan-Mathijs Schoffelen - 2012-09-05 14:03:15 +0200

(In reply to comment #3) specify also: string,scalar,1xN vector, MxN matrix, cell array of strings width for help in a certain scope: 100-120 character

Robert Oostenveld - 2012-09-19 22:21:16 +0200

*** Bug 1252 has been marked as a duplicate of this bug. ***

Lilla Magyari - 2012-10-19 15:47:05 +0200

(In reply to comment #3) cfg.absnoise in ft_connectivitysimulation: trial{tr} = ft_preproc_baselinecorrect(trial{tr} + cfg.absnoise*randn(size(trial{tr}))); cfg.absnoise in ft_dipolesimulation: relnoise = randn(size(simulated.trial{trial})) * cfg.relnoise * rms; absnoise = randn(size(simulated.trial{trial})) * cfg.absnoise; simulated.trial{trial} = simulated.trial{trial} + relnoise + absnoise; am I getting well that they do almost the same? (there default is different though) because then the description in the reference docu could be the same.

Robert Oostenveld - 2012-10-20 08:28:00 +0200

(In reply to comment #7) No, they do something different. Relnoise is relative to the signal amplitude in the data (i.e. the underlying dipole) whereas absnoise is absolute and independent of the underlying signal amplitude. The rms term in the equation is the signal amplitude.

Lilla Magyari - 2013-07-23 23:07:29 +0200

I started but I didn't finish. I re-assign it to joint development user. lilla