% pop_loadeeg() - load a Neuroscan .EEG file (via a pop-up window if no
%                  arguments). Calls loadeeg().
%
% Usage:
%   >> EEG = pop_loadeeg; % pop-up data entry window
%   >> EEG = pop_loadeeg( filename, filepath, range_chan, range_trials, ...
%                  range_typeeeg, range_response, format); % no pop-up window
%
% Graphic interface:
%   "Data precision in bits..." - [edit box] data binary format length
%                in bits. Command line equivalent: 'format'
%   "Trial range subset" - [edit box] integer array. 
%                Command line equivalent: 'range_trials'
%   "Type range subset" - [edit box] integer array. 
%                Command line equivalent: 'range_typeeeg'
%   "Electrode subset" - [edit box] integer array. 
%                Command line equivalent: 'range_chan'
%   "Response range subset" - [edit box] integer array. 
%                Command line equivalent: 'range_response'
%
% Inputs:
%   filename       - ['string'] file name
%   filepath       - ['string'] file path
%   range_chan     - [integer array] Import only selected electrodes
%                    Ex: 3,4:10; {Default: [] -> import all}
%   range_trials   - [integer array] Import only selected trials
%                    { Default: [] -> import all}
%   range_typeeeg  - [integer array] Import only trials of selected type
%                    {Default: [] -> import all}
%   range_response - [integer array] Import only trials with selected 
%                    response values {Default: [] -> import all}
%   format         - ['short'|'int32'] data binary format (Neuroscan 4.3
%                    saves data as 'int32'; earlier versions save data as
%                    'short'. Default is 'short'.
% Outputs:
%   EEG            - eeglab() data structure
%
% Author: Arnaud Delorme, CNL / Salk Institute, 2001
%
% See also: loadeeg(), eeglab()

%123456789012345678901234567890123456789012345678901234567890123456789012

% Copyright (C) 2001 Arnaud Delorme, Salk Institute, arno@salk.edu
%
% 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_loadeeg.m,v $
% Revision 1.19  2005/10/24 23:33:53  arno
% fix filename
%
% Revision 1.18  2004/09/16 18:21:13  hilit
% corrected a typo with the filepath delimiter
%
% Revision 1.17  2004/03/17 22:30:03  arno
% debug filepath...
%
% Revision 1.16  2003/12/17 23:19:52  arno
% importing channel labels
%
% Revision 1.15  2003/11/18 16:26:53  scott
% same
%
% Revision 1.14  2003/11/18 16:25:55  scott
% Enter ... -> ...
%
% Revision 1.13  2003/05/22 15:43:52  arno
% header update
%
% Revision 1.12  2003/05/14 16:55:49  arno
% adding format to history
%
% Revision 1.11  2003/05/14 16:54:52  arno
% allowing to read 32-bits data files
%
% Revision 1.10  2003/04/10 18:06:18  arno
% default argument
%
% Revision 1.9  2003/04/10 18:02:57  arno
% change default file name
%
% Revision 1.8  2003/04/10 18:01:51  arno
% file filter
%
% Revision 1.7  2003/03/12 00:42:20  arno
% removing namechan field
%
% Revision 1.6  2003/02/23 08:33:04  scott
% header edits -sm
%
% Revision 1.5  2003/02/21 17:31:45  arno
% update header for GUI
%
% Revision 1.4  2003/01/14 00:30:23  arno
% handling the case where all rts are 0
%
% Revision 1.3  2002/08/12 02:38:13  arno
% [6~[6~inputdlg2
%
% Revision 1.2  2002/05/02 19:39:43  arno
% updating function for new event structure
% ,
%
% Revision 1.1  2002/04/05 17:32:13  jorn
% Initial revision
%

% 01-25-02 reformated help & license -ad 

% uses calls to eeg_emptyset and loadeeg

% popup loadeeg file
% ------------------
function [EEG, command] = pop_loadeeg(filename, filepath, range_chan, range_sweeps, range_typeeeg, range_response, datformat); 

EEG = [];
command = '';

if nargin < 1

	% ask user
	[filename, filepath] = uigetfile('*.eeg;*.EEG', 'Choose an EEG file -- pop_loadeeg()'); 
	if filename == 0 return; end;

	% popup window parameters
	% -----------------------
	promptstr    = { 'Data precision in bits (16 or 32 for Neuroscan v4.3):', ...
                     'Trial range subset:', ...
					 'Type range subset:', ...
					 'Electrodes subset:', ...
					 'Response range subset:'};
	inistr       = { '16' '' '' '' '' };
	pop_title    = sprintf('Load an EEG dataset');
	result       = inputdlg2( promptstr, pop_title, 1,  inistr, 'pop_loadeeg');
	if size( result,1 ) == 0 return; end;

	% decode parameters
	% -----------------
    precision = eval(result{1});
    if precision == 16, datformat = 'short'; else datformat = 'int32'; end;
	range_sweeps    = eval( [ '[' result{2} ']' ] );
	range_typeeeg   = eval( [ '[' result{3}  ']' ] );
	range_chan      = eval( [ '[' result{4}  ']' ] );
	range_response  = eval( [ '[' result{5}  ']' ] );
else
    if exist('filepath') ~= 1
        filepath = '';
    end;
end;

if exist('datformat') ~= 1, datformat = 'short'; end;
if exist('range_chan') ~= 1   | isempty(range_chan)      , range_chan     = 'all'; end;
if exist('range_sweeps') ~= 1 | isempty(range_sweeps)    , range_sweeps     = 'all'; end;
if exist('range_typeeg') ~= 1 | isempty(range_typeeeg)   , range_typeeeg     = 'all'; end;
if exist('range_response') ~= 1 | isempty(range_response), range_response     = 'all'; end;

% load datas
% ----------
EEG = eeg_emptyset;
if ~isempty(filepath)
    if filepath(end) ~= '/' & filepath(end) ~= '\' & filepath(end) ~= ':'
        error('The file path last character must be a delimiter');
    end;
    fullFileName = sprintf('%s%s', filepath, filename);
else
    fullFileName = filename;
end;    
[EEG.data, accept, eegtype, rt, eegresp, namechan, EEG.pnts, EEG.trials, EEG.srate, EEG.xmin, EEG.xmax] = ...
    loadeeg( fullFileName, range_chan, range_sweeps, range_typeeeg, 'all', 'all', range_response, datformat);

EEG.comments        = [ 'Original file: ' fullFileName ];
EEG.setname 		= 'Neuroscan EEG data';
EEG.nbchan          = size(EEG.data,1);
EEG.chanlocs        = struct('labels', cellstr(char(namechan)));
EEG = eeg_checkset(EEG);
if any(rt)
    EEG = pop_importepoch( EEG, [rt(:)*1000 eegtype(:) accept(:) eegresp(:)], { 'RT' 'type' 'accept' 'response'}, {'RT'}, 1E-3, 0, 1);
else
    EEG = pop_importepoch( EEG, [eegtype(:) accept(:) eegresp(:)], { 'type' 'accept' 'response'}, { }, 1E-3, 0, 1);
end;    
command = sprintf('EEG = pop_loadeeg(''%s'', ''%s'', %s);', filename, filepath, ...
			vararg2str({range_chan range_sweeps range_typeeeg range_response datformat }));

return;