Browse EVRIGUI Object

From Eigenvector Research Documentation Wiki
Revision as of 13:21, 19 February 2010 by imported>Jeremy (Created page with '__TOC__ These are the methods defined for the Workspace Browser when accessed through an EVRIGUI object. The following methods are called by referring to th…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

These are the methods defined for the Workspace Browser when accessed through an EVRIGUI object. The following methods are called by referring to the given EVRIGUI object, followed by the method to be accessed. For example, given an EVRIGUI object in the workspace called "obj", the following call retrieves the list of currently displayed shortcuts in the workspace:

  list = obj.getShortcuts;

And this would open (i.e. start up) the shortcut labeled "Decompose (PCA)":

  obj.open('Decompose (PCA)');

The specific methods available are described in the sections below.


Loading and Retrieving Data and Models

Loading Data

These methods can be used to set (i.e. "load") the specified data. Note that all take a single parameter as input and this parameter must be a DataSet object. If the object is not a valid DataSet object, an error will be thrown.

.setXblock(dataset) Sets the Calibration X-block
.setXblockVal(dataset) Sets the Validation X-block
.setYblock(dataset) Sets the Calibration Y-block
.setYblockVal(dataset) Sets the Validation Y-block


Generic GUI Methods

These methods provide simple access to simple GUI actions such as controlling the visibility of the GUI and closing or creating the GUI

.close Forces the GUI to close
.create Used to create a new Workspace Browser - NOTE: This method is called automatically by the main EVRIGUI object and should not be called directly by the user (an error will always be thrown in that situation)


Complex Example

The following sequence of operations would create an Analysis GUI EVRIGUI object called "obj", load the data "data", set the analysis method to PCA, set the number of components at 5, calibrate a model, bring up a scores plot, and grab the model object:

  obj = evrigui('analysis');       % open a new Analysis GUI and create an attached EVRIGUI object
  obj.setXblock(data);             % load "data" into GUI
  obj.setMethod('pca');            % set PCA as analysis method
  obj.setComponents(5);            % set 5 PCs as number of components
  obj.calibrate;                   % calibrate the model
  obj.pressButton('plotscores');   % bring up a scores plot
  model = obj.getModel;            % retreive the model as a variable called "model"

Note that text following the % is comment text only. When passing commands like these into Solo, this text can be omitted.