% pop_eventstat() - Computes and plots statistical characteristics of an EEG event,
%                   including the data histogram, a fitted normal distribution,
%                   a normal ditribution fitted on trimmed data, a boxplot, and
%                   the QQ-plot. The estimates value are printed in a panel and
%                   can be read as output. NaNs are omitted. See signalstat().
%
% Usage:
%   >>  OUTEEG = pop_eventstat( EEG ); % pops up
%   >>  [M,SD,sk,k,med,zlow,zhi,tM,tSD,tndx,ksh] = pop_eventstat( EEG, eventfield, type );
%   >>  [M,SD,sk,k,med,zlow,zhi,tM,tSD,tndx,ksh] = pop_eventstat( EEG, eventfield, type, percent );
%
% Inputs:
%   EEG        - input EEG dataset
%   eventfield - event field to process (i.e. latency)
%   type       - name of the event type(s) to process. Can be a single element or
%                a cell array. Default is all types.
%   latrange   - [min max] event latency range within data epochs in milliseconds.
%                Default is whole epoch.
%   percent    - percentage for trimmed data statistics. Default is 5%. (see signalstat())
%    
% Outputs:
%   OUTEEG  - output dataset
%
% Author: Arnaud Delorme & Luca Finelli, CNL / Salk Institute - SCCN, 15 August 2002
%
% See also: signalstat(), eeg_getepochevent(), eeglab()

% Copyright (C) 2002 Arnaud Delorme & Luca Finelli, Salk/SCCN, La Jolla, CA
%
% 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_eventstat.m,v $
% Revision 1.12  2006/05/13 13:36:16  arno
% allow to process event types with space
%
% Revision 1.11  2004/06/03 18:39:38  arno
% debug to process all events
%
% Revision 1.10  2004/06/03 18:29:47  arno
% debug label
%
% Revision 1.9  2004/06/03 18:28:28  arno
% debug for empty field
%
% Revision 1.8  2004/04/28 15:59:15  arno
% fixing command line call
%
% Revision 1.7  2003/12/06 02:09:03  arno
% same
%
% Revision 1.6  2003/12/06 02:08:39  arno
% header
%
% Revision 1.5  2003/11/18 16:28:25  scott
% Enter ... -> ...
%
% Revision 1.4  2002/11/12 16:35:51  arno
% add error message
%
% Revision 1.3  2002/08/23 22:16:37  luca
% NaNs are omitted, changed message
%
% Revision 1.2  2002/08/19 23:54:15  arno
% adding latency range
%
% Revision 1.1  2002/08/15 16:30:01  arno
% Initial revision
%
% Revision 1.8  2002/08/12 20:42:47  luca
% added Log tag, changed popup title, added title for table
%

function varargout = pop_eventstat( EEG, eventfield, type, latrange, percent );

% the command output is a hidden output that does not have to
% be described in the header

com = ''; % this initialization ensure that the function will return something
          % if the user press the cancel button            
varargout{1} = '';

% display help if not enough arguments
% ------------------------------------
if nargin < 1
	help pop_eventstat;
	return;
end;	
popup=0;
if nargin < 2
	popup = 1;
end;
if nargin < 3
	percent=5;
end;

% pop up window
% -------------
if nargin < 2
	promptstr    = { 'Event field to process:' ...
					 strvcat('Event type(s) ([]=all):', ...
							 'Select "Edit > Event values" to see type values') ...
					strvcat('Event latency range (ms)', ...
							'Default is whole epoch or data') ...
					'Percent for trimmed statistics:' };
	inistr       = { 'latency' '' '' '5' };
	result       = inputdlg2( promptstr, 'Plot event statistics -- pop_eventstat()', 1,  inistr, 'signalstat');
	if length( result ) == 0 return; end;
	eventfield   = deblank(result{1}); % the brackets allow to process matlab arrays
    if strcmpi(result{2}(1),'''')
         type = eval( [ '{' result{2} '}' ] );
    else type = parsetxt( result{2});
    end;
	latrange     = eval( [ '[' result{3} ']' ] );
	percent      = eval( [ '[' result{4} ']' ] );
else
    if nargin < 3
        type = [];
    end;
    if nargin < 4
        latrange = [];
    end;
    if nargin < 5
        percent = 5;
    end;
end;

% call function signalstat() either on raw data or ICA data
% ---------------------------------------------------------
[ typevals alltypevals ] = eeg_getepochevent(EEG, type, latrange, eventfield);
% concatenate alltypevals
% -----------------------
typevals = [];
for index = 1:length(alltypevals)
    typevals = [ typevals alltypevals{index} ];
end;   
if isempty(typevals)
    error('No such events found. See Edit > Event values to confirm event type.');
end;
dlabel='Event values';
if isempty(type)
    dlabel2=['All event statistics for ''' eventfield ''' info'];
else
    dlabel2=['Event ' vararg2str(type) ' statistics for ''' eventfield ''' info'];
end; 

% outputs
% -------
outstr = '';
if ~popup
    for io = 1:nargout, outstr = [outstr 'varargout{' int2str(io) '},' ]; end;
    if ~isempty(outstr), outstr = [ '[' outstr(1:end-1) '] =' ]; end;
end;

% return the string command
% -------------------------
fprintf('pop_eventstat: extracting events...\n');
varargout{1} = sprintf('pop_eventstat( %s, %s );', inputname(1), vararg2str({eventfield type latrange percent}));
com          = sprintf('%s signalstat( typevals, 1, dlabel, percent, dlabel2 ); %s', outstr);

eval(com)	
try, icadefs; set(gcf, 'color', BACKCOLOR); catch, end;

return;