Back to the main page.

Bug 1090 - cfg.elec, cfg.elecfile etc have to be documented consistently

Reported 2011-10-28 17:24:00 +0200
Modified 2012-08-23 14:02:01 +0200
Product: FieldTrip
Component: documentation
Version: unspecified
Hardware: All
Operating System: All
Importance: P2 enhancement
Assigned to: Jörn M. Horschig
Depends on:
See also:

Robert Oostenveld - 2011-10-28 17:24:41 +0200

I noticed in ft_prepare_neighbours the following % The positions of the channel are specified in a gradiometer or electrode configuration or % from a layout. The sensor configuration can be passed into this function in three ways: % (1) in a configuration field, % (2) in a file whose name is passed in a configuration field, and that can be imported using .. % (3) in a data field. which pertains to the way that the elec or grad gets known. This is common to more functions and the documentation of all those functions should be made consistent. I suspect that the following functions are the ones that need to be checked manzana> grep -l cfg.elecfile *.m ft_dipolefitting.m ft_dipolesimulation.m ft_electroderealign.m ft_headmodelplot.m ft_layoutplot.m ft_megplanar.m ft_megrealign.m ft_neighbourplot.m ft_prepare_layout.m ft_prepare_leadfield.m ft_prepare_neighbours.m ft_scalpcurrentdensity.m ft_sensorrealign.m ft_sourceanalysis.m

Boris Reuderink - 2011-11-17 10:46:35 +0100

Changed the status of bugs without a specific owner to UNCONFIRMED. I'll try to replicate these bugs (potentially involving the submitter), and change confirmed bugs to NEW. Boris

Arjen Stolk - 2011-11-23 13:22:15 +0100

this bug is related to the documentation. There is another bug (Jorn), that is related to the functioanility. The functionality referred to, is a 'get_sens' function

Jörn M. Horschig - 2012-01-25 12:44:31 +0100

116 $ svn ci -m "bugfix-#1078 #1090- implemented consistent ways to retrieve sens definitions, see ft_fetch_sens" Sending compat/ft_headmodelplot.m Sending compat/ft_prepare_bemmodel.m Sending ft_dipolefitting.m Sending ft_dipolesimulation.m Sending ft_electroderealign.m Sending ft_headmodelplot.m Sending ft_megplanar.m Sending ft_megrealign.m Sending ft_neighbourplot.m Sending ft_prepare_bemmodel.m Sending ft_prepare_headmodel.m Sending ft_prepare_leadfield.m Sending ft_prepare_neighbours.m Sending ft_scalpcurrentdensity.m Sending ft_sensorrealign.m Sending ft_sourceanalysis.m Sending private/prepare_headmodel.m Sending test/test_ft_megplanar.m Sending utilities/ft_fetch_sens.m Transmitting file data ................... Committed revision 5174.

Jörn M. Horschig - 2012-08-23 14:02:01 +0200

bug closing time (