JavaScript Predictor Object - Revision history

imported>Jeremy: /* Example */

2015-07-16T23:46:38Z

Example

← Older revision		Revision as of 15:46, 16 July 2015
Line 95:		Line 95:

	The following VERY SIMPLE example creates a predictor object, sets the folder location, selects a model, then applies it. All output is done via the evri.debugmsg method in utilities.js:		The following VERY SIMPLE example creates a predictor object, sets the folder location, selects a model, then applies it. All output is done via the evri.debugmsg method in utilities.js:
			<pre>
	~~{{{~~
	<html>		<html>
	<head>		<head>
Line 145:		Line 144:
	</html>		</html>

	~~}}}~~		</pre>

imported>Jeremy at 23:45, 16 July 2015

2015-07-16T23:45:20Z

← Older revision		Revision as of 15:45, 16 July 2015
Line 91:		Line 91:

	\|}		\|}

			== Example ==

			The following VERY SIMPLE example creates a predictor object, sets the folder location, selects a model, then applies it. All output is done via the evri.debugmsg method in utilities.js:

			{{{
			<html>
			<head>
			<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
			<title>JavaScript Predictor Example</title>

			<link rel="stylesheet" href="default.css" type="text/css">
			<script type="text/javascript" src="js/jquery-1.7.1.min.js"></script>
			<script type="text/javascript" src="js/jquery.cookie.js"></script>
			<script type="text/javascript" src="js/prettyprint.js"></script>

			<script type="text/javascript" src="login/js/utilities.js"></script>
			<script type="text/javascript" src="js/solopredobj.js"></script>

			</head>
			<body>
			<div id="information"></div>
			<script type="text/javascript">
			evri.debug = true;
			var obj = new Predictor();
			evri.debugmsg("Ready...");

			//define callback for when model list updates
			obj.updateModelListCallback = function (item) {
			evri.debugmsg(item.modelList);
			evri.debugmsg("Model List");

			obj.selectedModels = obj.modelList[0]; //choose first model
			obj.applyModels();

			};

			//define callback for when models are applied
			obj.applyModelsCallback = function (item) {
			evri.debugmsg(item)
			evri.debugmsg("Got Results");

			//now we have results, do a data-drill to grab data for item #0
			item.dataDrill('d',[0],function(results) { evri.debugmsg(results) });

			};

			//choose model folder (which also does an updateModelList call)
			obj.modelsFolder = "C:/Models/";

			</script>
			</body>
			</html>

			}}}

imported>Jeremy at 23:36, 16 July 2015

2015-07-16T23:36:43Z

imported>Jeremy: /* Contributions */

2015-07-16T23:35:41Z

Contributions

← Older revision		Revision as of 15:35, 16 July 2015
Line 79:		Line 79:
	{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"		{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
	\|-		\|-
	\| <tt>.dataDrill(mode,items,resultCallback)</tt> \|\| Makes a request to retrieve the contributions or data for one or more data points. The inputs include:		\|valign="top" \| <tt>.dataDrill(mode,items,resultCallback)</tt> \|\| Makes a request to retrieve the contributions or data for one or more data points. The inputs include:
	* mode = a single character string indicating what kind of contributions to retreive: 'd' = data, 't' = t contributions, 'q' = q contributions		* mode = a single character string indicating what kind of contributions to retreive: 'd' = data, 't' = t contributions, 'q' = q contributions
	* items = an array of one or more sample numbers for which the contributions should be returned. Zero-indexed relative to the results returned in the rows of the <tt>data</tt> property.		* items = an array of one or more sample numbers for which the contributions should be returned. Zero-indexed relative to the results returned in the rows of the <tt>data</tt> property.
Line 85:		Line 85:

	The results will be an object with the fields:		The results will be an object with the fields:
	* '''~~data~~''' : an array of arrays with the requested data. The top level array contains one array for each requested index in "items".		* '''result''' : an array of arrays with the requested data. The top level array contains one array for each requested index in "items".
	* '''error''' : a string ~~representing~~ any errors that occurred during the call. Often, if error is non-empty, the '''result''' property will be empty.		* '''error''' : a string representation any errors that occurred during the call. Often, if error is non-empty, the '''result''' property will be empty.
			* '''date''' : a string representation of the date and time the sever completed the request.


	\|}		\|}

imported>Jeremy at 23:32, 16 July 2015

2015-07-16T23:32:48Z

@@ Line 53: / Line 53: @@
 These properties are read-only and provide results from the most recent completed <tt>applyModels</tt> call:
 {| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
@@ Line 68: / Line 67: @@
 {| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
 |-
-|        <tt>.applyModels</tt>      || Checks the server for new data in the indicated DataCache and applies any models listed in <tt>selectedModels</tt> to the data. When model application is done, the <tt>data</tt>, <tt>lastApplyUpdate</tt>, and <tt>lastApplyError</tt>.
+|        <tt>.applyModels</tt>      || Checks the server for new data in the indicated DataCache and applies any models listed in <tt>selectedModels</tt> to the data. When model application is done, the <tt>data</tt>, <tt>lastApplyUpdate</tt>, and <tt>lastApplyError</tt> properties are populated, and then the <tt>applyModelsCallback</tt> function is called.
 |}

imported>Jeremy: /* Applying Models to Data */

2015-07-16T22:00:13Z

Applying Models to Data

← Older revision		Revision as of 14:00, 16 July 2015
Line 33:		Line 33:
	\| <tt>.updateModelList</tt> \|\| Contacts the server and requests the current list of models (.MAT and .TXT files) in the specified <tt>modelFolder</tt>. When the server responds, the results are stored in the <tt>modelList</tt> and <tt>modelListError</tt> properties and finally a call is made to the function specified in <tt>updateModelListCallback</tt>. If any errors occurred, the modelList will be empty.		\| <tt>.updateModelList</tt> \|\| Contacts the server and requests the current list of models (.MAT and .TXT files) in the specified <tt>modelFolder</tt>. When the server responds, the results are stored in the <tt>modelList</tt> and <tt>modelListError</tt> properties and finally a call is made to the function specified in <tt>updateModelListCallback</tt>. If any errors occurred, the modelList will be empty.
	\|}		\|}


	== Applying Models to Data ==		== Applying Models to Data ==

	The following properties and methods relate to applying models to data and ~~retreiving~~ those results.		The following properties and methods relate to applying models to data and retrieving those results. They all relate to the singular method <tt>applyModels</tt>.

			=== Properties ===

	~~=== Properties ===~~		These properties control the behavior of the <tt>applyModels</tt> method:

	{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"		{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
Line 46:		Line 48:
	\|-		\|-
	\| <tt>.datacacheblock</tt> \|\| Identifies which [[DataCache object]] block should be connected to the predictor as the source of data to which the models should be applied. Generally, this will be always be = 1, but some advanced applications might make use of additional DataCache blocks.		\| <tt>.datacacheblock</tt> \|\| Identifies which [[DataCache object]] block should be connected to the predictor as the source of data to which the models should be applied. Generally, this will be always be = 1, but some advanced applications might make use of additional DataCache blocks.
			\|-
			\| <tt>.applyModelsCallback</tt> \|\| Provides a function that will be executed once the <tt>applyModels</tt> call has been completed. The supplied function should expect a single input consisting of the Predictor object itself.
			\|}

			These properties are read-only and provide results from the most recent completed <tt>applyModels</tt> call:


			{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
			\|-
			\| <tt>.data</tt> \|\| '''[READ ONLY]''' The DataSet object-encoded contents that define the results of applying the model(s) to the specified data cache.
			\|-
			\| <tt>.lastApplyUpdate</tt> \|\| '''[READ ONLY]''' The JavaScript timestamp of when the last call to <tt>applyModels</tt> was completed.
			\|-
			\| <tt>.lastApplyError</tt> \|\| '''[READ ONLY]''' The text of any errors that occurred during the last call to <tt>applyModels</tt>. If no errors occurred in the last call, this property will be an empty string. Errors may be server-related errors (can not communicate) or model errors (e.g. data size does not match that expected by model)
			\|}

			=== Methods ===

			{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
			\|-
			\| <tt>.applyModels</tt> \|\| Checks the server for new data in the indicated DataCache and applies any models listed in <tt>selectedModels</tt> to the data. When model application is done, the <tt>data</tt>, <tt>lastApplyUpdate</tt>, and <tt>lastApplyError</tt>.
	\|}		\|}

imported>Jeremy: Created page with "== Introduction == The JavaScript Predictor Object is freely available to developers who wish to create JavaScript applications that interface with Solo_Predictor as does the..."

2015-07-16T21:48:23Z

Created page with "== Introduction == The JavaScript Predictor Object is freely available to developers who wish to create JavaScript applications that interface with Solo_Predictor as does the..."

New page

== Introduction ==

The JavaScript Predictor Object is freely available to developers who wish to create JavaScript applications that interface with Solo_Predictor as does the [[Solo Predictor Field Monitor]].

The object provides basic methods to get a list of available models (from a specific folder on the server), then apply those models to data stored in a [[DataCache object]] in Solo_Predictor. Finally, it also provides access to raw data, and Q or Hotelling's T-squared contributions (if the underlying model type provides contributions).

== Available Models ==

These properties and methods relate to the models that are available to Solo_Predictor and which of those should be applied to data when it is imported.

=== Properties ===

{| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
|-
| <tt>.modelFolder</tt> || Sets or retrieves the folder (on the server, that is the computer running Solo_Predictor) which should be searched for models to apply. When updated, the <tt>modelList</tt> property (see below) is automatically updated.
|-
| <tt>.modelList</tt> || '''[READ ONLY]''' An array of strings which define all valid files located in the modelFolder on the server. The contents of this list will be automatically updated when the <tt>modelFolder</tt> property is updated or when the <tt>updateModelList</tt> method is called.
|-
| <tt>.modelListError</tt> || '''[READ ONLY]''' The error (if any) returned after the last <tt>updateModelList</tt> call. If no error occurred, this property will be empty.
|-
| <tt>.updateModelListCallback</tt> || A function that should be executed when <tt>updateModelList</tt> is executed. The function should expect a single input consisting of the Predictor object itself. For example:[BR]
obj.updateModelListCallback = function (myobj) {
if (myobj.modelListError) throw new Error(myobj.modelListError);
//Do something with myobj.modelList here...
}
|}

=== Methods ===

{| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
|-
| <tt>.updateModelList</tt> || Contacts the server and requests the current list of models (.MAT and .TXT files) in the specified <tt>modelFolder</tt>. When the server responds, the results are stored in the <tt>modelList</tt> and <tt>modelListError</tt> properties and finally a call is made to the function specified in <tt>updateModelListCallback</tt>. If any errors occurred, the modelList will be empty.
|}

== Applying Models to Data ==

The following properties and methods relate to applying models to data and retreiving those results.

=== Properties ===

{| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
|-
| <tt>.selectedModels</tt> || An array of strings which indicate the names of models which should be applied. The model names can be taken from the <tt>modelList</tt> property defined above. If this array is empty, no models will be applied. If more than one model is listed, all models will be applied and Solo_Predictor will attempt to join all the results into a single results matrix. Changing the <tt>selectedModels</tt> list will generally cause the most recent results to be cleared.
|-
| <tt>.datacacheblock</tt> || Identifies which [[DataCache object]] block should be connected to the predictor as the source of data to which the models should be applied. Generally, this will be always be = 1, but some advanced applications might make use of additional DataCache blocks.
|}

← Older revision		Revision as of 15:36, 16 July 2015
Line 13:		Line 13:
	{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"		{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
	\|-		\|-
	\| <tt>.modelFolder</tt> \|\| Sets or retrieves the folder (on the server, that is the computer running Solo_Predictor) which should be searched for models to apply. When updated, the <tt>modelList</tt> property (see below) is automatically updated.		\|valign="top" \| <tt>.modelFolder</tt> \|\| Sets or retrieves the folder (on the server, that is the computer running Solo_Predictor) which should be searched for models to apply. When updated, the <tt>modelList</tt> property (see below) is automatically updated.
	\|-		\|-
	\| <tt>.modelList</tt> \|\| '''[READ ONLY]''' An array of strings which define all valid files located in the modelFolder on the server. The contents of this list will be automatically updated when the <tt>modelFolder</tt> property is updated or when the <tt>updateModelList</tt> method is called.		\|valign="top" \| <tt>.modelList</tt> \|\| '''[READ ONLY]''' An array of strings which define all valid files located in the modelFolder on the server. The contents of this list will be automatically updated when the <tt>modelFolder</tt> property is updated or when the <tt>updateModelList</tt> method is called.
	\|-		\|-
	\| <tt>.modelListError</tt> \|\| '''[READ ONLY]''' The error (if any) returned after the last <tt>updateModelList</tt> call. If no error occurred, this property will be empty.		\|valign="top" \| <tt>.modelListError</tt> \|\| '''[READ ONLY]''' The error (if any) returned after the last <tt>updateModelList</tt> call. If no error occurred, this property will be empty.
	\|-		\|-
	\| <tt>.updateModelListCallback</tt> \|\| A function that should be executed when <tt>updateModelList</tt> is executed. The function should expect a single input consisting of the Predictor object itself. For example:[BR]		\|valign="top" \| <tt>.updateModelListCallback</tt> \|\| A function that should be executed when <tt>updateModelList</tt> is executed. The function should expect a single input consisting of the Predictor object itself. For example:[BR]
	obj.updateModelListCallback = function (myobj) {		obj.updateModelListCallback = function (myobj) {
	if (myobj.modelListError) throw new Error(myobj.modelListError);		if (myobj.modelListError) throw new Error(myobj.modelListError);
Line 31:		Line 31:
	{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"		{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
	\|-		\|-
	\| <tt>.updateModelList</tt> \|\| Contacts the server and requests the current list of models (.MAT and .TXT files) in the specified <tt>modelFolder</tt>. When the server responds, the results are stored in the <tt>modelList</tt> and <tt>modelListError</tt> properties and finally a call is made to the function specified in <tt>updateModelListCallback</tt>. If any errors occurred, the modelList will be empty.		\|valign="top" \| <tt>.updateModelList</tt> \|\| Contacts the server and requests the current list of models (.MAT and .TXT files) in the specified <tt>modelFolder</tt>. When the server responds, the results are stored in the <tt>modelList</tt> and <tt>modelListError</tt> properties and finally a call is made to the function specified in <tt>updateModelListCallback</tt>. If any errors occurred, the modelList will be empty.
	\|}		\|}

Line 45:		Line 45:
	{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"		{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
	\|-		\|-
	\| <tt>.selectedModels</tt> \|\| An array of strings which indicate the names of models which should be applied. The model names can be taken from the <tt>modelList</tt> property defined above. If this array is empty, no models will be applied. If more than one model is listed, all models will be applied and Solo_Predictor will attempt to join all the results into a single results matrix. Changing the <tt>selectedModels</tt> list will generally cause the most recent results to be cleared.		\|valign="top" \| <tt>.selectedModels</tt> \|\| An array of strings which indicate the names of models which should be applied. The model names can be taken from the <tt>modelList</tt> property defined above. If this array is empty, no models will be applied. If more than one model is listed, all models will be applied and Solo_Predictor will attempt to join all the results into a single results matrix. Changing the <tt>selectedModels</tt> list will generally cause the most recent results to be cleared.
	\|-		\|-
	\| <tt>.datacacheblock</tt> \|\| Identifies which [[DataCache object]] block should be connected to the predictor as the source of data to which the models should be applied. Generally, this will be always be = 1, but some advanced applications might make use of additional DataCache blocks.		\|valign="top" \| <tt>.datacacheblock</tt> \|\| Identifies which [[DataCache object]] block should be connected to the predictor as the source of data to which the models should be applied. Generally, this will be always be = 1, but some advanced applications might make use of additional DataCache blocks.
	\|-		\|-
	\| <tt>.applyModelsCallback</tt> \|\| Provides a function that will be executed once the <tt>applyModels</tt> call has been completed. The supplied function should expect a single input consisting of the Predictor object itself.		\|valign="top" \| <tt>.applyModelsCallback</tt> \|\| Provides a function that will be executed once the <tt>applyModels</tt> call has been completed. The supplied function should expect a single input consisting of the Predictor object itself.
	\|}		\|}

Line 56:		Line 56:
	{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"		{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
	\|-		\|-
	\| <tt>.data</tt> \|\| '''[READ ONLY]''' The DataSet object-encoded contents that define the results of applying the model(s) to the specified data cache.		\|valign="top" \| <tt>.data</tt> \|\| '''[READ ONLY]''' The DataSet object-encoded contents that define the results of applying the model(s) to the specified data cache.
	\|-		\|-
	\| <tt>.lastApplyUpdate</tt> \|\| '''[READ ONLY]''' The JavaScript timestamp of when the last call to <tt>applyModels</tt> was completed.		\|valign="top" \| <tt>.lastApplyUpdate</tt> \|\| '''[READ ONLY]''' The JavaScript timestamp of when the last call to <tt>applyModels</tt> was completed.
	\|-		\|-
	\| <tt>.lastApplyError</tt> \|\| '''[READ ONLY]''' The text of any errors that occurred during the last call to <tt>applyModels</tt>. If no errors occurred in the last call, this property will be an empty string. Errors may be server-related errors (can not communicate) or model errors (e.g. data size does not match that expected by model)		\|valign="top" \| <tt>.lastApplyError</tt> \|\| '''[READ ONLY]''' The text of any errors that occurred during the last call to <tt>applyModels</tt>. If no errors occurred in the last call, this property will be an empty string. Errors may be server-related errors (can not communicate) or model errors (e.g. data size does not match that expected by model)
	\|}		\|}

Line 67:		Line 67:
	{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"		{\| border="1" cellspacing="0" cellpadding="5" style="margin-left:3em"
	\|-		\|-
	\| <tt>.applyModels</tt> \|\| Checks the server for new data in the indicated DataCache and applies any models listed in <tt>selectedModels</tt> to the data. When model application is done, the <tt>data</tt>, <tt>lastApplyUpdate</tt>, and <tt>lastApplyError</tt> properties are populated, and then the <tt>applyModelsCallback</tt> function is called.		\|valign="top" \| <tt>.applyModels</tt> \|\| Checks the server for new data in the indicated DataCache and applies any models listed in <tt>selectedModels</tt> to the data. When model application is done, the <tt>data</tt>, <tt>lastApplyUpdate</tt>, and <tt>lastApplyError</tt> properties are populated, and then the <tt>applyModelsCallback</tt> function is called.

	'''Note:''' If no new data has appeared in the DataCache since the last <tt>applyModels</tt> call and the list of selected models hasn't changed, then the <tt>lastApplyUpdate</tt> timestamp is updated but ''no call will be made to the <tt>applyModelsCallback</tt> function''. That is, update calls which did not change the data or error properties will not trigger a call to <tt>applyModelsCallback</tt>. Internally this is known as a "nochange" response from Solo_Predictor and is intended to reduce load on the server and client when no new data or results are available.		'''Note:''' If no new data has appeared in the DataCache since the last <tt>applyModels</tt> call and the list of selected models hasn't changed, then the <tt>lastApplyUpdate</tt> timestamp is updated but ''no call will be made to the <tt>applyModelsCallback</tt> function''. That is, update calls which did not change the data or error properties will not trigger a call to <tt>applyModelsCallback</tt>. Internally this is known as a "nochange" response from Solo_Predictor and is intended to reduce load on the server and client when no new data or results are available.