pop_erpimage.m

含有多种ICA算法的eeglab工具箱

% pop_erpimage() - draw an ERP-image plot of a given EEG channel or independent
%                  component. Uses a pop-up window if less than three (or four 
%                  in one condition) input arguments are supplied. Calls erpimage(). 
%                  For futher details see >> help erpimage
% Usage:
%   >> pop_erpimage(EEG, typeplot);          % pop-up a data entry window
%   >> pop_erpimage(EEG, typeplot, lastcom); % pop-up a data entry window
%   >> pop_erpimage(EEG, typeplot, channel); % no pop-up window
%   >> pop_erpimage(EEG, typeplot, channel, projchan, title, ...
%                  smooth, decimate, sortingtype, sortingwin, ...
%                            sortingeventfield, renorm, options...);
% Graphic interface:
%   "Channel or Component" - [edit box] Enter channel number or component
%                 number to plot. erpimage() equivalent: 'channel' 
%   "Project to channel #" - [edit box] (for plotting independent components). 
%                 Allow reprojecting the component activity 
%                 to a given channel or group of channels. 
%                 erpimage() equivalent: 'projchan' 
%   "Smoothing" - [text box] Smoothing parameter in number of trials.
%                 erpimage() equivalent: 'smooth' 
%   "Downsampling" - [edit box] Decimate parameter. 
%                 erpimage() equivalent: 'decimate' 
%   "Time limits" - [edit box] Enter the time limits in milliseconds. 
%                 erpimage() equivalent: the 1st and 2nd parameters of the 'limit' array
%   "Figure title" - [edit box] Enter the figure title here.  If empty, a title
%                 is automatically generated. erpimage() equivalent: 'title' 
%   "Plot scalp map" - [checkbox] Setting this option plot a scalp map of the 
%                 channel location (or component topography) next to the 
%                 erpimage. erpimage() equivalent: 'topo' 
%   "plot ERP" - [checkbox] Setting this option plot the channel or component 
%                 ERP below the ERP image. erpimage() equivalent: 'erp' 
%   "Plot colorbar" - [checkbox] Plot the colorbar on the right of the erpimage. 
%                 erpimage() equivalent: 'cbar' 
%   "ERP limits" - [edit box] Set the minimum and maximum value for the ERP plot
%                 erpimage() equivalent: 3rd and 4th parameters of the 'limit' array 
%   "Color limits" - [edit box] Set the color limits for the ERP image. 
%                 erpimage() equivalent: 'caxis' 
%   "Epoch sorting field" - [button and edit box] Specify the event field which
%                 values will be used to sort the trials. For instance, if you
%                 select the 'latency' fields, trials will be sorted by the 
%                 latency of the selected events.
%                 erpimage() equivalent: 'sortingeventfield'
%   "Event type(s)" - [button and edit box] Specify which event subset to select,
%                 based on the event 'type' field values (to scan for event types, use 
%                 menu Edit > Events values and look at the values of the 'type'
%                 field). For instance, entering type 'rt' (if defined) and field 
%                 'latency' in option aboce will sort trials on reaction time latencies. 
%                 When several selected events are present in individual trials, 
%                 the first event values are used for sorting and a warning is issued. 
%                 erpimage() equivalent: 'sortingtype'
%   "Event time range" - [edit box] Specify which event subset to select based on 
%                 event latency values. As the option above, this further restrains 
%                 the selection of events. For example, entering [200 300] in this 
%                 box, 'rt' for the event type (above), and 'latency' for the 
%                 epoch sorting field will select trials with reaction-time latencies
%                 in between 200 and 300 ms. Trials with no such event will not be
%                 included in the ERP-image plot. erpimage() equivalent: 'sortingwin'  
%   "rescale" - [edit box] 'yes', 'no', or a Matlab formula. 
%                 erpimage() equivalent: 'renorm' 
%   "align" - [edit box] Set this to 'Inf' to re-align the individual trials 
%                 on the median latency of the selected events. Else, enter an epoch time 
%                 (in ms) to align the events to (Ex: 0). erpimage() equivalent: 'align' 
%   "Don't sort by value" - [checkbox] Check this box if you do not want to 
%                 sort the trials but do want to plot the selected event values. 
%                 erpimage() equivalent: 'nosort' 
%   "Don't plot value" - [checkbox] Check this box if you do not want to 
%                 plot the selected event values, but still want to sort 
%                 the data trials according to these values. 
%                 erpimage() eqivalent: 'noplot' 
%   "Sort by phase > Frequency" - [edit box] Specify the frequency or frequency 
%                 range for sorting trials by phase. erpimage() equivalent: 
%                 3rd and 4th inputs to 'phasesort' 
%   "Window center (ms)" - [edit box] erpimage() equivalent: 1st 'phasesort' input
%   "Percent low-amp. trials to ignore" - [edit box] erpimage() equivalent: 
%                 2nd 'phasesort' input 
%   "Wavelet cycle" - [text] Number of wavelet cycles used for spectral 
%                 decomposition at the specified latency. Cannot be edited.
%   "Inter-trial coherence options > Frequency" - [edit box] Frequency at which  
%                 to compute coherence. Constrained to be the same as the 
%                 "Sort by phase > Frequency" edit box. erpimage() equivalent: 'coher' 
%   "Signif. level" - [edit box] Coherence significance cutoff, as a proability
%                  (Ex: .05). erpimage() equivalent: 'signif' 
%   "Amplitude limit" - [edit box] Amplitude limits [min max] for the data power 
%                 plot at the selected frequency. erpimage() equivalent:
%                 5th and 6th inputs to 'limit' 
%   "Coher limits" - [edit box] Upper limit (<=1) for the coherence 
%                 plot. erpimage() equivalent: 7th and 8th inputs of 'limit' 
%   "Image amps" - [checkbox] Check this box for plotting the spectral amplitude
%                 image at the selected frequency (instead of plotting EEG potential). 
%                 erpimage() equivalent: 'plotamp'
%   "Plot spectrum" - [edit box] Plot the channel or component data spectrum in 
%                 the top right corner of the ERP image. erpimage() equivalent: 'spec' 
%   "Baseline ampl." - [edit box] Baseline amplitude for data power plot at the 
%                 selected frequency. erpimage() equivalent: 7th inputs of 'limit'
%   "Mark times" - [edit box] Time(s) in ms to plot vertical lines.
%                 erpimage() equivalent: 'vert' 
%   "More options" - [edit box] Enter 'key', 'value' sequences. Other erpimage()
%                 options not handled by this interface, including: 'erpstd' to 
%                 plot the ERP standard deviation; 'auxvar' to plot auxilary 
%                 variables; 'ampsort' to sort trials based on amplitude at 
%                 the selected frequency, etc.  For further information see  
%                 >> help erpimage() 
% Inputs:
%   EEG        - dataset structure
%   typeplot   - 1=channel, 0=component {default: 1}
%   lastcom    - string containing previous pop_erpimage command (from LASTCOM) 
%                or from the previous function call output.  The values from this 
%                function call are used as default in the graphic interface.
%
% Commandline options:
%   channel    - Index of channel or component(s) to plot {default: 1}
%   projchan   - Channel to back-project the selected component(s) to. 
%                If plotting channel activity, this argument is ignored. 
%                If [], the ICA component activation is plotted {default []}.
%   title      - ['string'] Plot title {default: []}
%   smooth     - Smoothing parameter (number of trials). {Default: 5} 
%                erpimage() equivalent: 'avewidth' 
%   decimate   - Decimate parameter (i.e. ratio of trials_in/trials_out).
%                erpaimge() equivalent: 'decimate' {Default: 0}
%   sortingtype - Sorting event type(s) ([int vector]; []=all). See Notes below.
%                Either a string or an integer.
%   sortingwin - Sorting event window [start, end] in seconds ([]=whole epoch)
%   sortingeventfield - Sorting field name. {default: none}. See Notes below.
%   options    - erpimage() options, separated by commas (Ex: 'erp', 'cbar'). 
%                {Default: none}. For further details see >> erpimage help   
%
% Outputs from pop-up: 
%   String containing the command used to evaluate this plotting function
%   (saved by eeglab() as LASTCOM). Enter it as the 'lastcom' input to restore
%   the previous parameters as defaults in a new pop_erpimage() pop-up window
%
% Outputs from commandline:
%   Same as erpimage(). Note: No outputs are returned when a window pops-up 
%   to ask for additional arguments
%   
% Notes:
%   1) A new figure is created only when the pop-up window is called, 
%      so you may call this command with >3 args to draw in sbplot() axes.
%   2) To sort epochs, first define the event field to be used with
%      the argument 'sortingeventfield' (for instance 'latency'). Then,
%      because there may be several events with different latencies in a
%      given epoch, it is possible to consider only a subsets of events
%      using the 'sortingtype' and 'sortingwin' arguments. The 
%      'sortingtype' argument selects events with definite types. The 
%      'sortingwin' argument helps to define a specific time window in the 
%      epoch to select events. For instance the epoch time range may be -1 
%      to 2 seconds but one may want to select events only in the range 0 
%      to 1 second. These three parameters are forwarded to the function
%      eeg_getepochevent(), whose help message contains more details.
%
% Author: Arnaud Delorme, CNL / Salk Institute, 2001
%
% See also: eeglab(), erpimage(), eeg_getepochevent()

%123456789012345678901234567890123456789012345678901234567890123456789012

% Copyright (C) 2001 Arnaud Delorme, Salk Institute, [e-mail]
%
% This program is free software; you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation; either version 2 of the License, or
% (at your option) any later version.
%
% This program is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with this program; if not, write to the Free Software
% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

% $Log: pop_erpimage.m,v $
% Revision 1.122  2004/06/16 22:24:33  arno
% no scalp map if only channel labels
%
% Revision 1.121  2004/06/16 22:21:20  arno
% debug for numercial types
%
% Revision 1.120  2004/05/15 00:33:25  arno
% same
%
% Revision 1.119  2004/05/15 00:30:12  arno
% putting back microvolt
%
% Revision 1.118  2004/03/02 21:55:00  arno
% recover version 1.114
%
% Revision 1.114  2003/05/10 19:06:21  arno
% debug last
%
% Revision 1.113  2003/05/10 19:02:42  arno
% debug last
%
% Revision 1.112  2003/05/10 19:01:13  arno
% num2str -> vararg2str
%
% Revision 1.111  2003/05/10 18:49:18  arno
% same
%
% Revision 1.110  2003/05/10 18:47:23  arno
% condense output string
%
% Revision 1.109  2003/04/24 21:53:56  arno
% debuging renorm default option
%
% Revision 1.108  2003/04/23 23:14:53  arno
% cycle
%
% Revision 1.107  2003/04/23 01:09:34  arno
% change text for default wavelet cycle
%
% Revision 1.106  2003/03/12 20:11:59  scott
% header edits .m
% -sm
%
% Revision 1.105  2003/03/12 19:21:37  arno
% same
%
% Revision 1.104  2003/03/12 19:15:00  arno
% debug renorm
%
% Revision 1.103  2003/03/12 19:12:06  arno
% debuging history for rescale
%
% Revision 1.102  2003/03/12 03:13:12  arno
% help msg
%
% Revision 1.101  2003/03/12 02:43:51  arno
% two help buttons
%
% Revision 1.100  2003/02/25 00:59:31  scott
% edit header -sm
%
% Revision 1.99  2003/02/24 16:09:57  arno
% resolving ???
%
% Revision 1.98  2003/02/23 09:06:15  scott
% header edits -sm
%
% Revision 1.97  2003/02/18 19:21:40  scott
% header edits -sm
%
% Revision 1.96  2003/02/17 02:25:28  arno
% reformating text for new functionality in help2html
%
% Revision 1.95  2003/02/17 01:52:32  arno
% updating header
%
% Revision 1.94  2003/02/17 00:59:51  arno
% adding GUI info
%
% Revision 1.93  2003/01/02 16:52:55  arno
% removing "ERP image" from title, plotting component scalp map
%
% Revision 1.92  2002/11/19 22:55:02  arno
% debug for component plotting
%
% Revision 1.91  2002/11/18 18:21:21  arno
% nicer aspect ratio
%
% Revision 1.90  2002/11/13 18:30:04  scott
% same
%
% Revision 1.89  2002/11/13 18:28:16  scott
% freq range text
%
% Revision 1.88  2002/11/13 18:25:43  scott
% freq range legends
%
% Revision 1.87  2002/11/13 18:23:45  scott
% coher freq -> coher freq range
%
% Revision 1.86  2002/10/29 23:41:53  arno
% fixing colorbar problem and help button
%
% Revision 1.85  2002/10/29 23:33:27  arno
% same
%
% Revision 1.84  2002/10/29 23:32:44  arno
% debugging channel name when no channel location file
%
% Revision 1.83  2002/10/16 16:24:37  arno
% debug command line call
%
% Revision 1.82  2002/10/15 16:56:44  scott
% debug
%
% Revision 1.81  2002/10/15 16:56:07  scott
% debug
%
% Revision 1.80  2002/10/15 16:52:31  scott
% debug
%
% Revision 1.79  2002/10/15 16:42:27  scott
% debug
%
% Revision 1.78  2002/10/15 16:39:36  scott
% default title with channel name
%
% Revision 1.77  2002/10/15 15:08:17  scott
% *** empty log message ***
%
% Revision 1.76  2002/10/15 14:48:55  scott
% removed erpimopt, added 'Color limits' help
%
% Revision 1.75  2002/10/10 14:56:56  scott
% [] -> default in help msgs where applicable
%
% Revision 1.74  2002/09/06 18:24:39  arno
% reparing history