[Master Index] [Index for Toolbox]

# ginput2

## (Toolbox/ginput2.m in BrainStorm 2.0 (Alpha))

### Function Synopsis

    [out1,out2,out3] = ginput2(arg1)

### Help Text

    GINPUT2 - Graphical input from mouse.
     function [out1,out2,out3] = ginput2(arg1)
       [X,Y] = GINPUT2(N) gets N points from the current axes and returns
       the X- and Y-coordinates in length N vectors X and Y.  The cursor
       can be positioned using a mouse (or by using the Arrow Keys on some
       systems).  Data points are entered by pressing a mouse button
       or any key on the keyboard except carriage return, which terminates
       the input before N points are entered.

       [X,Y] = GINPUT2 gathers an unlimited number of points until the
       return key is pressed.

       [X,Y,BUTTON] = GINPUT2(N) returns a third result, BUTTON, that
       contains a vector of integers specifying which mouse button was
       used (1,2,3 from left) or ASCII numbers if a key on the keyboard
       was used.

### Cross-Reference Information

This function is called by

    mritool_cb                         C:\BrainStorm_2001\Toolbox\mritool_cb.m

### Listing of function C:\BrainStorm_2001\Toolbox\ginput2.m

    function [out1,out2,out3] = ginput2(arg1)
    %GINPUT2 - Graphical input from mouse.
    % function [out1,out2,out3] = ginput2(arg1)
    %   [X,Y] = GINPUT2(N) gets N points from the current axes and returns
    %   the X- and Y-coordinates in length N vectors X and Y.  The cursor
    %   can be positioned using a mouse (or by using the Arrow Keys on some
    %   systems).  Data points are entered by pressing a mouse button
    %   or any key on the keyboard except carriage return, which terminates
    %   the input before N points are entered.
    %
    %   [X,Y] = GINPUT2 gathers an unlimited number of points until the
    %   return key is pressed.
    %
    %   [X,Y,BUTTON] = GINPUT2(N) returns a third result, BUTTON, that
    %   contains a vector of integers specifying which mouse button was
    %   used (1,2,3 from left) or ASCII numbers if a key on the keyboard
    %   was used.

    %<autobegin> ---------------------- 26-May-2004 11:30:20 -----------------------
    % --------- Automatically Generated Comments Block Using AUTO_COMMENTS ---------
    %
    % CATEGORY: Utility - General
    %
    % Subfunctions in this file, in order of occurrence in file:
    %   key = wfbp
    %
    % At Check-in: $Author: Mosher $  $Revision: 12 $  $Date: 5/26/04 9:59a $
    %
    % This software is part of BrainStorm Toolbox Version 2.0 (Alpha) 24-May-2004
    %
    % Principal Investigators and Developers:
    % ** Richard M. Leahy, PhD, Signal & Image Processing Institute,
    %    University of Southern California, Los Angeles, CA
    % ** John C. Mosher, PhD, Biophysics Group,
    %    Los Alamos National Laboratory, Los Alamos, NM
    % ** Sylvain Baillet, PhD, Cognitive Neuroscience & Brain Imaging Laboratory,
    %    CNRS, Hopital de la Salpetriere, Paris, France
    %
    % See BrainStorm website at http://neuroimage.usc.edu for further information.
    %
    % Copyright (c) 2004 BrainStorm by the University of Southern California
    % This software distributed  under the terms of the GNU General Public License
    % as published by the Free Software Foundation. Further details on the GPL
    % license can be found at http://www.gnu.org/copyleft/gpl.html .
    %
    % FOR RESEARCH PURPOSES ONLY. THE SOFTWARE IS PROVIDED "AS IS," AND THE
    % UNIVERSITY OF SOUTHERN CALIFORNIA AND ITS COLLABORATORS DO NOT MAKE ANY
    % WARRANTY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
    % MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, NOR DO THEY ASSUME ANY
    % LIABILITY OR RESPONSIBILITY FOR THE USE OF THIS SOFTWARE.
    %<autoend> ------------------------ 26-May-2004 11:30:20 -----------------------

    %   Copyright (c) 1984-98 by The MathWorks, Inc.
    %   $Revision: 12 $  $Date: 5/26/04 9:59a $

    %   Brainstorm Toolbox - Sylvain Baillet

    out1 = []; out2 = []; out3 = []; y = [];
    c = computer;
    if ~strcmp(c(1:2),'PC') & ~strcmp(c(1:2),'MA')
       tp = get(0,'TerminalProtocol');
    else
       tp = 'micro';
    end

    if ~strcmp(tp,'none') & ~strcmp(tp,'x') & ~strcmp(tp,'micro'),
       if nargout == 1,
          if nargin == 1,
             eval('out1 = trmginput(arg1);');
          else
             eval('out1 = trmginput;');
          end
       elseif nargout == 2 | nargout == 0,
          if nargin == 1,
             eval('[out1,out2] = trmginput(arg1);');
          else
             eval('[out1,out2] = trmginput;');
          end
          if  nargout == 0
             out1 = [ out1 out2 ];
          end
       elseif nargout == 3,
          if nargin == 1,
             eval('[out1,out2,out3] = trmginput(arg1);');
          else
             eval('[out1,out2,out3] = trmginput;');
          end
       end
    else

       fig = gcf;
       figure(gcf);

       if nargin == 0
          how_many = -1;
          b = [];
       else
          how_many = arg1;
          b = [];
          if  isstr(how_many) ...
                | size(how_many,1) ~= 1 | size(how_many,2) ~= 1 ...
                | ~(fix(how_many) == how_many) ...
                | how_many < 0
             error('Requires a positive integer.')
          end
          if how_many == 0
             ptr_fig = 0;
             while(ptr_fig ~= fig)
                ptr_fig = get(0,'PointerWindow');
             end
             scrn_pt = get(0,'PointerLocation');
             loc = get(fig,'Position');
             pt = [scrn_pt(1) - loc(1), scrn_pt(2) - loc(2)];
             out1 = pt(1); y = pt(2);
          elseif how_many < 0
             error('Argument must be a positive integer.')
          end
       end

       % Remove figure button functions
       state = uisuspend(fig);
       pointer = get(gcf,'pointer');
    %   set(gcf,'pointer','fullcrosshair');

       set(gcf,'pointer','arrow');
       fig_units = get(fig,'units');
       char = 0;

       while how_many ~= 0
          % Use no-side effect WAITFORBUTTONPRESS
          waserr = 0;
          eval('keydown = wfbp;', 'waserr = 1;');
          if(waserr == 1)
             if(ishandle(fig))
                set(fig,'pointer',pointer,'units',fig_units);
                error('Interrupted');
             else
                error('Interrupted by figure deletion');
             end
          end

          ptr_fig = get(0,'CurrentFigure');
          if(ptr_fig == fig)
             if keydown
                char = get(fig, 'CurrentCharacter');
                button = abs(get(fig, 'CurrentCharacter'));
                scrn_pt = get(0, 'PointerLocation');
                set(fig,'units','pixels')
                loc = get(fig, 'Position');
                pt = [scrn_pt(1) - loc(1), scrn_pt(2) - loc(2)];
                set(fig,'CurrentPoint',pt);
             else
                button = get(fig, 'SelectionType');
                if strcmp(button,'open')
                   button = b(length(b));
                elseif strcmp(button,'normal')
                   button = 1;
                elseif strcmp(button,'extend')
                   button = 2;
                elseif strcmp(button,'alt')
                   button = 3;
                else
                   error('Invalid mouse selection.')
                end
             end
             pt = get(gca, 'CurrentPoint');

             how_many = how_many - 1;

             if(char == 13) % & how_many ~= 0)
                % if the return key was pressed, char will == 13,
                % and that's our signal to break out of here whether
                % or not we have collected all the requested data
                % points.
                % If this was an early breakout, don't include
                % the <Return> key info in the return arrays.
                % We will no longer count it if it's the last input.
                break;
             end

             out1 = [out1;pt(1,1)];
             y = [y;pt(1,2)];
             b = [b;button];
          end
       end

       uirestore(state);
       set(fig,'units',fig_units);

       if nargout > 1
          out2 = y;
          if nargout > 2
             out3 = b;
          end
       else
          out1 = [out1 y];
       end

    end

    %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
    function key = wfbp
    %WFBP   Replacement for WAITFORBUTTONPRESS that has no side effects.

    fig = gcf;

    % Now wait for that buttonpress, and check for error conditions
    waserr = 0;
    eval(['if nargout==0,', ...
          '   waitforbuttonpress,', ...
          'else,', ...
          '   keydown = waitforbuttonpress;',...
          'end' ], 'waserr = 1;');

    if(waserr == 1)
       error('Interrupted');
    end

    if nargout>0, key = keydown; end
    %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Produced by color_mat2html, a customized BrainStorm 2.0 (Alpha) version of mat2html on Tue Nov 2 16:17:59 2004
Cross-Directory links are: ON