Doeinteractions: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Scott
(Created page with " ===Purpose=== Creates product combinations of columns of a DOE matrix. ===Synopsis=== :[xint,column_ID] = doeinteractions(x, column_ID) ===Description=== Creates produ...")
 
imported>Scott
No edit summary
Line 1: Line 1:
===Purpose===
===Purpose===


Line 20: Line 19:
====Inputs====
====Inputs====
* '''x''' = the raw DOE matrix (x) and  
* '''x''' = the raw DOE matrix (x) and  
* '''column_ID''' = type of interactions to include in the final DOE as either:
* '''column_ID''' = type of interactions to include in the final DOE as either:
%              (A) a scalar numerical value indicating the highest number
:(A) a scalar numerical value indicating the highest number of interacting factors to include (A value of 1 (one) indicates no interactions)
%                  of interacting factors to include (A value of 1 (one)
:Example: <tt>[2]</tt>
%                  indicates no interactions)
:(B) a cell array of numerical vectors indicating which column(s) should be combined an in what way(s) to create the interaction terms.
%                  Example: [2]
: Example:  <tt>{ [1] [2] [3] [1 3] }</tt>
%              (B) a cell array of numerical vectors indicating which  
:Scalar cell entries will copy the specified column(s) directly from (x) into (xint). Vector cell entries will multiply the corresponding columns together to create the output column.
%                  column(s) should be combined an in what way(s) to
%                  create the interaction terms.
%                  Example:  { [1] [2] [3] [1 3] }
%                  Scalar cell entries will copy the specified column(s)
%                  directly from (x) into (xint). Vector cell entries will
%                  multiply the corresponding columns together to create
%                  the output column.
 
 
 
====Optional Inputs====
* '''second''' = optional second input is this.
 


====Outputs====
====Outputs====
* '''firstout''' = first output is this.
* '''xint''' = selected columns and column products from x based on column_ID.
 
* '''column_ID''' = cell array of interactions identical to the input (if a cell array was given as input) or created as needed for the given scalar interaction level (if scalar provided as input column_ID).
 
===Options===
 
 
options =  a structure array with the following fields:
 
 
* '''plots''': [ {'none'} | 'final' ] governs plotting of results, and
* '''order''': positive integer for polynomial order {default = 1}.
 
 
===Example===
===Example===
if the following <tt>column_ID</tt> value is used then <tt>xint</tt> will contain the first three columns of x (unmodified), followed by two additional columns which are the product of columns 1 and 2 and the product of columns 2 and 3, respectively.


 
<pre>column_ID = {[1] [2] [3] [1 2] [2 3]}</pre>
<pre>
>>This is an example
Error: does not exist
</pre>
 


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


 
[[anova_doe]], [[factdes]], [[ffacdes1]]
[[baselinew]], [[deresolv]]
 
%DOEINTERACTIONS Calculates interaction terms of a raw DOE matrix.
% Creates product combinations of columns of a DOE matrix.
% INPUTS:
%  x        = the raw DOE matrix (x) and
%  column_ID = type of interactions to include in the final DOE as either:
%              (A) a scalar numerical value indicating the highest number
%                  of interacting factors to include (A value of 1 (one)
%                  indicates no interactions)
%                  Example: [2]
%              (B) a cell array of numerical vectors indicating which
%                  column(s) should be combined an in what way(s) to
%                  create the interaction terms.
%                  Example:  { [1] [2] [3] [1 3] }
%                  Scalar cell entries will copy the specified column(s)
%                  directly from (x) into (xint). Vector cell entries will
%                  multiply the corresponding columns together to create
%                  the output column.
% OUTPUTS:
%  xint      = selected columns and column products from x based on
%              column_ID.
%  column_ID = cell array of interactions identical to the input (if a
%              cell array was given as input) or created as needed for the
%              given scalar interaction level (if scalar provided as input
%              column_ID)
%
% EXAMPLE:
%    if column_ID = {[1] [2] [3] [1 2] [2 3]}
%  then xint will contain the first three columns of x (unmodified),
%  followed by two additional columns which are the product of columns 1
%  and 2 and the product of columns 2 and 3, respectively.
%
%I/O: [xint,column_ID] = doeinteractions(x, column_ID)
%
%See also: ANOVA_DOE, FACTDES, FFACDES1

Revision as of 11:34, 12 September 2011

Purpose

Creates product combinations of columns of a DOE matrix.


Synopsis

[xint,column_ID] = doeinteractions(x, column_ID)


Description

Creates product combinations of columns of a DOE matrix.


Inputs

  • x = the raw DOE matrix (x) and
  • column_ID = type of interactions to include in the final DOE as either:
(A) a scalar numerical value indicating the highest number of interacting factors to include (A value of 1 (one) indicates no interactions)
Example: [2]
(B) a cell array of numerical vectors indicating which column(s) should be combined an in what way(s) to create the interaction terms.
Example: { [1] [2] [3] [1 3] }
Scalar cell entries will copy the specified column(s) directly from (x) into (xint). Vector cell entries will multiply the corresponding columns together to create the output column.

Outputs

  • xint = selected columns and column products from x based on column_ID.
  • column_ID = cell array of interactions identical to the input (if a cell array was given as input) or created as needed for the given scalar interaction level (if scalar provided as input column_ID).

Example

if the following column_ID value is used then xint will contain the first three columns of x (unmodified), followed by two additional columns which are the product of columns 1 and 2 and the product of columns 2 and 3, respectively. 

column_ID = {[1] [2] [3] [1 2] [2 3]}

See Also

anova_doe, factdes, ffacdes1

Retrieved from "https://www.wiki.eigenvector.com/index.php?title=Doeinteractions&oldid=7688"