Analysis EVRIGUI Object

These are the methods defined for Analysis GUI 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 sets the Calibration X-block data to a given DataSet object called "data":

  obj.setXblock(data);

And this would retrieve the curently loaded Calibration X-block data:

  data = obj.getXblock;

The specific methods available are described in the sections below.

Loading and Retrieving Data and Models

These methods can be used to retrieve the specified data as a DataSet object:

.getXblock	-returns Calibration X-block
.getXblockVal	-returns Validation X-block
.getYblock	-returns Calibration Y-block
.getYblockVal	-returns Validation Y-block

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

Models can be set (loaded) or retrieved using the following two methods:

        .setModel(model)
        .getModel

Similarly, predictions can be loaded or retrieved using these methods:

        .setPrediction(prediction)
        .getPrediction

The "drop" method is a simplified loading method. Any valid data, model or prediction can be "dropped" on a valid Analysis EVRIGUI object and the GUI will attempt to load the given data into the most logical location based on the GUI's current status. Since this may be ambiguious to the script or program accessing the EVRIGUI object where the data will be loaded, it is often recommended that an explict .set____ command (see above) be used in most cases.

        .drop(dataset)
        .drop(model)

Clearing of data, models, and predictions can be achieved using these methods. In all cases, if the given data or model is already cleared, no error occurrs.

        .clearAll         -clears all data, models, and predictions (return to initial startup state)
        .clearBothCal     -clears both X and Y Calibration Data
        .clearBothVal     -clears both X and Y Validation Data
        .clearModel       -clears current
        .clearXblock      
        .clearXblockVal   
        .clearYblock      
        .clearYblockVal   

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

        .getVisibility    
        .setVisibility    
        .close            
        .create           -Creates a new Analysis GUI. 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)

Advanced Methods

Shared Data Object Access

Within Matlab, these methods can be used to access a Shared Data object which gives direct, dynamic access to the data and model being used in the GUI. This allows an advanced user to view and/or modify the used data directly. The use of Shared Data objects is for advanced users only and is beyond the scope of this document. See the Shared Data object for more information on using Shared Data:

        .getXblockId     -returns Shared Data object to Calibration X-block
        .getXblockValId  -returns Shared Data object to Validation X-block 
        .getYblockId     -returns Shared Data object to Calibration Y-block
        .getYblockValId  -returns Shared Data object to Validation Y-block 
        .getModelId      -returns Shared Data object to Model
        .getPredictionId -returns Shared Data object to Predictions 

Generic Object Access

The generic .getObject method returns the object specified using a keyword string from Analysis GUI. This is the actual DataSet, model, or other object itself (not the shared data object) Valid keywords are internal and may be subject to chage. As a result this function is not recommended for most uses. Instead, the user is directed to the general .get____ commands described earlier in this document. This method does, however, provide access to objects which may not be accessible through the other .get____ methods.

        .getObject('object_keyword')  -returns specified object from GUI 

        .apply            
        .calibrate        

        .setMethod        

        .getComponents    
        .setComponents    

        .getButtons       
        .pressButton      

        .getXPreprocessing
        .getYPreprocessing
        .setXPreprocessing
        .setYPreprocessing

        .getOptions       
        .setOptions       

        .validmethods