Explode: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Bob
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===Purpose===
===Purpose===


Line 6: Line 5:
===Synopsis===
===Synopsis===


:explode(sdat,mod,txt,out)
:explode(struct,''txt'',''options'')


===Description===
===Description===


EXPLODE writes the fields of the input structure sdat to variables in the workspace with the same variable names as the field names. If sdat is a standard model structure, only selected information is written to the workspace.
EXPLODE writes the fields of the input structure <tt>struct</tt> to variables in the workspace with the same variable names as the field names. If <tt>struct</tt> is a standard model structure, only selected information is written to the workspace.


Optional string input ''txt'' appends a string to the variable output names.
Optional string input ''txt'' appends a string to the variable output names.
Line 17: Line 16:


''options'' =  a structure array with the following fields:
''options'' =  a structure array with the following fields:
 
* '''model''': [ 'no' | {'yes'} ] interpret <tt>struct</tt> as a PLS_Toolbox model if possible, and
* '''model''': [ 'no' | {'yes'} ] interpret sdat as model if possible, and
 
* '''display''': [ 'off' | {'on'} ]} display model information.
* '''display''': [ 'off' | {'on'} ]} display model information.
The default options can be retreived using: options = explode('options');.


===Examples===
===Examples===
Line 28: Line 23:
For the structure array x
For the structure array x


<pre>
>> x.field1 = 2;
>> x.field1 = 2;
>> x.field2 = 3;
>> x.field2 = 3;
>> explode(x)
>> explode(x)


Line 41: Line 35:


   field1      1x1                        8  double array
   field1      1x1                        8  double array
   field2      1x1                        8  double array
   field2      1x1                        8  double array
   x            1x1                      264  struct array
   x            1x1                      264  struct array


the variables field1 and field2 have been written to the base workspace.
the variables field1 and field2 have been written to the base workspace.
</pre>


===See Also===
===See Also===


[[analysis]], [[modelstruct]]
[[analysis]], [[modelstruct]], [[modlpred]], [[mpca]], [[npls]], [[parafac]], [[pca]]

Latest revision as of 09:59, 9 October 2008

Purpose

Extracts variables from a structure array.

Synopsis

explode(struct,txt,options)

Description

EXPLODE writes the fields of the input structure struct to variables in the workspace with the same variable names as the field names. If struct is a standard model structure, only selected information is written to the workspace.

Optional string input txt appends a string to the variable output names.

Options

options = a structure array with the following fields:

  • model: [ 'no' | {'yes'} ] interpret struct as a PLS_Toolbox model if possible, and
  • display: [ 'off' | {'on'} ]} display model information.

Examples

For the structure array x

>> x.field1 = 2;
>> x.field2 = 3;
>> explode(x)

Input (sdat) is not a recognized model. Exploding as regular structure

>> whos

  Name         Size                   Bytes  Class

  field1       1x1                        8  double array
  field2       1x1                        8  double array
  x            1x1                      264  struct array

the variables field1 and field2 have been written to the base workspace.

See Also

analysis, modelstruct, modlpred, mpca, npls, parafac, pca