Back to the main page.
Bug 1096 - the documentation in ft_singleplotTFR for the directionality option should be revised
| Status | CLOSED FIXED |
| Reported | 2011-11-01 12:38:00 +0100 |
| Modified | 2011-11-09 16:43:53 +0100 |
| Product: | FieldTrip |
| Component: | documentation |
| Version: | unspecified |
| Hardware: | PC |
| Operating System: | Mac OS |
| Importance: | P1 normal |
| Assigned to: | Jan-Mathijs Schoffelen |
| URL: | |
| Tags: | |
| Depends on: | |
| Blocks: | |
| See also: |
Robert Oostenveld - 2011-11-01 12:38:10 +0100
It now reads % cfg.directionality = '', 'inflow' or 'outflow' specifies for % connectivity measures whether the inflow into a % node, or the outflow from a node is plotted. The % behavior of this option depends on the input % data. If the input data is of dimord % 'chan_chan_XXX', the value of directionality % determines whether, given the reference % channel(s), the columns (inflow), or rows % (outflow) are selected for plotting. In this % situation the default is 'inflow'. Note that for % undirected measures, inflow and outflow should % give the same output. When the input data is of % dimord 'chancmb_XXX', the value % of directionality determines whether the rows in % data.labelcmb are selected. With 'inflow' the % rows are selected if the refchannel(s) occur in % the right column, with 'outflow' the rows are % selected if the refchannel(s) occur in the left % column of the labelcmb-field. Default in this % case is '', which means that all rows are % selected in which the refchannel(s) occur. This % is to robustly support linearly indexed % undirected connectivity metrics. In the situation % where undirected connectivity measures are % linearly indexed, specifying 'inflow' or % 'outflow' can result in unexpected behavior. which makes it very difficult to parse. I suggest giving a short reference-manual style description, which is elaborated upon in a subsequent separate section of the help