Conload: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Neal
No edit summary
Line 1: Line 1:
===Purpose===
===Purpose===


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


:Bcon = conload(X,model,''options'')
:bcon = conload(x,model,''options'')


===Description===
===Description===
Line 16: Line 15:
====Inputs====
====Inputs====


* '''X''' = modeled data
x = modeled data


* '''model''' = standard model structure
model = standard model structure


* '''mode''' = loading mode to investigate (i.e. mode = 1 for samples if they are in the first mode)
mode = loading mode to investigate (i.e., mode = 1 for samples if they are in the first mode / rows)


====Outputs====
====Outputs====


Bcon = Congruence loadings
bcon = congruence loadings


===Options===
===Options===
''options'' is an options structure with the following fields:


* '''plots''' : [ 'none' | {'final'} ] Governs the creation of plot of the results.
: plots : [ 'none' | {'final'} ] Governs the creation of plot of the results.


* '''force''' : [ {'off'} | 'ellipse' | 'square' ] Forces a given type of limit on the plots (if plot is given).
: force : [ {'off'} | 'ellipse' | 'square' ] Forces a given type of limit on the plots (if plot is given).


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


[[npls]], [[parafac]], [[tucker]]
[[npls]], [[parafac]], [[tucker]]

Revision as of 14:44, 3 October 2008

Purpose

Congruence loadings for PARAFAC, TUCKER and NPLS.

Synopsis

bcon = conload(x,model,options)

Description

Determines congruence (earlier known as correlation) loadings for a specific mode of a model. Congruence loadings look at "non-average correlations", hence take differences in offset into account.

Note that due to non-orthogonal loadings in PARAFAC, individual correlations can add to more than 1. Therefore, such loadings are not drawn with ellipses but squares added. Use options.force = 'ellipse' or 'square' to force one or the other on the plot.

Inputs

x = modeled data

model = standard model structure

mode = loading mode to investigate (i.e., mode = 1 for samples if they are in the first mode / rows)

Outputs

bcon = congruence loadings

Options

options is an options structure with the following fields:

plots : [ 'none' | {'final'} ] Governs the creation of plot of the results.
force : [ {'off'} | 'ellipse' | 'square' ] Forces a given type of limit on the plots (if plot is given).

See Also

npls, parafac, tucker