Tsqlim: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Scott
imported>Donal
No edit summary
Line 21: Line 21:


where <math>K</math> is the number of PCs, <math>M</math> is the number of samples and <math>{{F}_{K,M-K,\alpha }}</math> is the F distribution with <math>K</math> degrees of freedom in the numberator and <math>M-K</math> degrees of freedom in the denominator, and probability point <math>\alpha</math>.
where <math>K</math> is the number of PCs, <math>M</math> is the number of samples and <math>{{F}_{K,M-K,\alpha }}</math> is the F distribution with <math>K</math> degrees of freedom in the numberator and <math>M-K</math> degrees of freedom in the denominator, and probability point <math>\alpha</math>.
====Inputs====
* '''m''' = the number of samples.
* '''pc''' = the number of PCs.
* '''cl''' = the confidence limit (cl) where 0 < cl < 1.
Optionally, (m) and (pc) can be omitted and a standard model structure (model) can be passed along with the confidence limit (cl).
====Optional Inputs====
* '''flag''' = [ {1} | 2 ] governs how the function is called. 1 = calculates the T^2 at the CL (default), 2 = calculates the CL from an input T^2 (tsq) (This is similar to how FTEST is used) When flag=2,
====Outputs====
* '''tsqcl''' = the confidence limit. (See optional input flag for the inverse calculation.)
===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}.


===Examples===
===Examples===

Revision as of 11:15, 6 March 2013

Purpose

Calculates PCA confidence limits for Hotelling's T2.

Synopsis

tsqcl = tsqlim(m,pc,cl)
tsqcl = tsqlim(model,cl)

Description

Inputs can be in one of two forms:

(a) the number of samples m, the number of principal components used pc, and the fractional confidence limit, cl (0 < cl < 1) which can be a scalar or a vector (to calculate multiple confidence limits simultaneously).

or (b) a standard model structure, model, and the fractional confidence limit, cl (0 < cl < 1).

The output tsqcl is the confidence limit based on an F distribution as shown below. See Jackson (1991).

    

where is the number of PCs, is the number of samples and is the F distribution with degrees of freedom in the numberator and degrees of freedom in the denominator, and probability point .

Inputs

  • m = the number of samples.
  • pc = the number of PCs.
  • cl = the confidence limit (cl) where 0 < cl < 1.

Optionally, (m) and (pc) can be omitted and a standard model structure (model) can be passed along with the confidence limit (cl).

Optional Inputs

  • flag = [ {1} | 2 ] governs how the function is called. 1 = calculates the T^2 at the CL (default), 2 = calculates the CL from an input T^2 (tsq) (This is similar to how FTEST is used) When flag=2,

Outputs

  • tsqcl = the confidence limit. (See optional input flag for the inverse calculation.)

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}.


Examples

tsqcl = tsqlim(15,2,0.95)
model = pca(data,pc); tsqcl = tsqlim(model,0.95)

See Also

analysis, chilimit, pca, pcr, pls, subgroupcl