Differences

This shows you the differences between two versions of the page.

Link to this comparison view

reference:ft_singleplottfr [2018/08/23 14:43] (current)
Line 1: Line 1:
 +=====  FT_SINGLEPLOTTFR =====
 +
 +Note that this reference documentation is identical to the help that is displayed in MATLAB when you type "help ft_singleplotTFR"​.
 +
 +<​html><​pre>​
 +  <a href=/​reference/​ft_singleplotTFR><​font color=green>​FT_SINGLEPLOTTFR</​font></​a>​ plots the time-frequency representation of power of a
 +  single channel or the average over multiple channels.
 + 
 +  Use as
 +    ft_singleplotTFR(cfg,​data)
 + 
 +  The input freq structure should be a a time-frequency representation of
 +  power or coherence that was computed using the <a href=/​reference/​ft_freqanalysis><​font color=green>​FT_FREQANALYSIS</​font></​a>​ function.
 + 
 +  The configuration can have the following parameters:
 +    cfg.parameter ​     = field to be plotted on z-axis, e.g. '​powspcrtrm'​ (default depends on data.dimord)
 +    cfg.maskparameter ​ = field in the data to be used for masking of data, can be logical (e.g. significant data points) or numerical (e.g. t-values).
 +                         (not possible for mean over multiple channels, or when input contains multiple subjects
 +                         or trials)
 +    cfg.maskstyle ​     = style used to masking, '​opacity',​ '​saturation',​ or '​outline'​ (default = '​opacity'​)
 +                         '​outline'​ can only be used with a logical cfg.maskparameter
 +                         use '​saturation'​ or '​outline'​ when saving to vector-format (like *.eps) to avoid all sorts of image-problems
 +    cfg.maskalpha ​     = alpha value between 0 (transparent) and 1 (opaque) used for masking areas dictated by cfg.maskparameter (default = 1)
 +                         (will be ignored in case of numeric cfg.maskparameter or if cfg.maskstyle = '​outline'​) ​  
 +    cfg.masknans ​      = '​yes'​ or '​no'​ (default = '​yes'​)
 +    cfg.xlim ​          = '​maxmin'​ or [xmin xmax] (default = '​maxmin'​)
 +    cfg.ylim ​          = '​maxmin'​ or [ymin ymax] (default = '​maxmin'​)
 +    cfg.zlim ​          = plotting limits for color dimension, '​maxmin',​ '​maxabs',​ '​zeromax',​ '​minzero',​ or [zmin zmax] (default = '​maxmin'​)
 +    cfg.baseline ​      = '​yes',​ '​no'​ or [time1 time2] (default = '​no'​),​ see <a href=/​reference/​ft_freqbaseline><​font color=green>​FT_FREQBASELINE</​font></​a>​
 +    cfg.baselinetype ​  = '​absolute',​ '​relative',​ '​relchange'​ or '​db'​ (default = '​absolute'​)
 +    cfg.trials ​        = '​all'​ or a selection given as a 1xN vector (default = '​all'​)
 +    cfg.channel ​       = Nx1 cell-array with selection of channels (default = '​all'​),​
 +                         see <a href=/​reference/​ft_channelselection><​font color=green>​FT_CHANNELSELECTION</​font></​a>​ for details
 +    cfg.title ​         = string, title of plot
 +    cfg.refchannel ​    = name of reference channel for visualising connectivity,​ can be '​gui'​
 +    cfg.fontsize ​      = font size of title (default = 8)
 +    cfg.hotkeys ​       = enables hotkeys (leftarrow/​rightarrow/​uparrow/​downarrow/​pageup/​pagedown/​m) for dynamic zoom and translation (ctrl+) of the axes and color limits
 +    cfg.colormap ​      = any sized colormap, see COLORMAP
 +    cfg.colorbar ​      = '​yes',​ '​no'​ (default = '​yes'​)
 +    cfg.interactive ​   = Interactive plot '​yes'​ or '​no'​ (default = '​yes'​)
 +                         In a interactive plot you can select areas and produce a new
 +                         ​interactive plot when a selected area is clicked. Multiple areas
 +                         can be selected by holding down the SHIFT key.
 +    cfg.renderer ​      = '​painters',​ '​zbuffer',​ ' opengl'​ or '​none'​ (default = [])
 +    cfg.directionality = '',​ '​inflow'​ or '​outflow'​ specifies for
 +                        connectivity measures whether the inflow into a
 +                        node, or the outflow from a node is plotted. The
 +                        (default) behavior of this option depends on the dimor
 +                        of the input data (see below).
 + 
 +  For the plotting of directional connectivity data the cfg.directionality
 +  option determines what is plotted. The default value and the supported
 +  functionality depend on the dimord of 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. If 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.
 + 
 +  See also <a href=/​reference/​ft_singleplotER><​font color=green>​FT_SINGLEPLOTER</​font></​a>,​ <a href=/​reference/​ft_multiplotER><​font color=green>​FT_MULTIPLOTER</​font></​a>,​ <a href=/​reference/​ft_multiplotTFR><​font color=green>​FT_MULTIPLOTTFR</​font></​a>,​ <a href=/​reference/​ft_topoplotER><​font color=green>​FT_TOPOPLOTER</​font></​a>,​ <a href=/​reference/​ft_topoplotTFR><​font color=green>​FT_TOPOPLOTTFR</​font></​a>​
 +</​pre></​html>​