Analysis EVRIGUI Object: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(New page: The following methods are defined for Analysis EVRIGUI objects: .apply .calibrate .clearAll .clearBothCal ....)
 
imported>Jeremy
No edit summary
Line 1: Line 1:
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":


The following methods are defined for Analysis EVRIGUI objects:
  obj.setXblock(data);


         .apply           
And this would retrieve the curently loaded Calibration X-block data:
         .calibrate       
 
         .clearAll         
  data = obj.getXblock;
         .clearBothCal     
 
         .clearBothVal     
The specific methods available are described in the sections below.
         .clearModel       
 
==Data Assignment and Retrieval Methods==
 
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
 
The "drop" method is a simplified data loading method. Any valid data or model 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       
         .clearXblock       
         .clearXblockVal   
         .clearXblockVal   
         .clearYblock       
         .clearYblock       
         .clearYblockVal   
         .clearYblockVal   
==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     
        .apply           
        .calibrate       
         .close             
         .close             
         .create           
         .create           
        .drop           
 
         .getButtons       
         .getButtons       
         .getComponents     
         .getComponents     
         .getModel         
         .getModel         
        .getModelId     
         .getObject         
         .getObject         
         .getOptions       
         .getOptions       
Line 25: Line 67:
         .getVisibility     
         .getVisibility     
         .getXPreprocessing
         .getXPreprocessing
        .getXblock       
        .getXblockId     
        .getXblockVal   
        .getXblockValId 
         .getYPreprocessing
         .getYPreprocessing
        .getYblock       
        .getYblockId     
        .getYblockVal   
        .getYblockValId 
         .pressButton       
         .pressButton       
         .setComponents     
         .setComponents     
Line 42: Line 76:
         .setVisibility     
         .setVisibility     
         .setXPreprocessing
         .setXPreprocessing
        .setXblock       
        .setXblockVal   
         .setYPreprocessing
         .setYPreprocessing
        .setYblock       
        .setYblockVal   
         .validmethods
         .validmethods

Revision as of 13:50, 17 March 2009

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.

Data Assignment and Retrieval Methods

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

The "drop" method is a simplified data loading method. Any valid data or model 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   


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       


        .apply            
        .calibrate        
        .close            
        .create           
        .getButtons       
        .getComponents    
        .getModel         
        .getObject        
        .getOptions       
        .getPrediction    
        .getPredictionId  
        .getVisibility    
        .getXPreprocessing
        .getYPreprocessing
        .pressButton      
        .setComponents    
        .setMethod        
        .setModel         
        .setOptions       
        .setPrediction    
        .setVisibility    
        .setXPreprocessing
        .setYPreprocessing
        .validmethods