Alphabetical Index: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>WikiAdmin
(New page: :abline - Draws a line on the current axes with a given slope and intercept. :alignmat - Alignment of matrices and N-way arrays. :alignpeaks - Calibrates wavelength scale using...)
 
imported>WikiAdmin
No edit summary
Line 1: Line 1:
===A===
:[[abline]] - Draws a line on the current axes with a given slope and intercept.
:[[abline]] - Draws a line on the current axes with a given slope and intercept.
:[[alignmat]] - Alignment of matrices and N-way arrays.
:[[alignmat]] - Alignment of matrices and N-way arrays.
Line 12: Line 13:
:[[autoimport]] - Automatically reads specified file. Handles all standard filetypes.
:[[autoimport]] - Automatically reads specified file. Handles all standard filetypes.
   
   
===B===
:[[b3spline]] - Univariate spline fit and prediction.
:[[b3spline]] - Univariate spline fit and prediction.
:[[baseline]] - Subtracts a polynomial baseline offset from spectra.
:[[baseline]] - Subtracts a polynomial baseline offset from spectra.
Line 21: Line 22:
:[[builddbstr]] - Builds a database connection string.
:[[builddbstr]] - Builds a database connection string.
   
   
===C===
:[[calibsel]] - Statistical procedure for variable selection.
:[[calibsel]] - Statistical procedure for variable selection.
:[[caltransfer]] - Create or apply calibration and instrument transfer models.
:[[caltransfer]] - Create or apply calibration and instrument transfer models.
Line 49: Line 50:
:[[crossval]] - Cross-validation for decomposition and linear regression.
:[[crossval]] - Cross-validation for decomposition and linear regression.
   
   
===D===
:[[datahat]] - Calculates the model estimate and residuals of the data.
:[[datahat]] - Calculates the model estimate and residuals of the data.
:[[datasetdemo]] - Demonstrates use of the dataset object.
:[[datasetdemo]] - Demonstrates use of the dataset object.
Line 62: Line 63:
:[[durbin_watson]] - Criterion for measure of continuity.
:[[durbin_watson]] - Criterion for measure of continuity.
   
   
===E===
:[[editds]] - Editor for DataSet Objects.
:[[editds]] - Editor for DataSet Objects.
:[[ellps]] - Plots an ellipse on an existing figure.
:[[ellps]] - Plots an ellipse on an existing figure.
Line 79: Line 80:
:[[exportfigure]] - Automatically export figures to an external program.
:[[exportfigure]] - Automatically export figures to an external program.
   
   
===F===
:[[factdes]] - Full factorial design of experiments.
:[[factdes]] - Full factorial design of experiments.
:[[fastnnls]] - Fast non-negative least squares.
:[[fastnnls]] - Fast non-negative least squares.
Line 92: Line 93:
:[[fullsearch]] - Exhaustive Search Algorithm for small problems.
:[[fullsearch]] - Exhaustive Search Algorithm for small problems.
   
   
===G===
:[[gaselctr]] - Genetic algorithm for variable selection with PLS.
:[[gaselctr]] - Genetic algorithm for variable selection with PLS.
:[[genalg]] - Genetic Algorithm for Variable Selection.
:[[genalg]] - Genetic Algorithm for Variable Selection.
Line 106: Line 107:
:[[gselect]] - Selects objects in a figure (various selection styles).
:[[gselect]] - Selects objects in a figure (various selection styles).
   
   
===H===
:[[helppls]] - Context related help on the PLS_Toolbox.
:[[helppls]] - Context related help on the PLS_Toolbox.
:[[hline]] - Adds horizontal lines to figure at specified locations.
:[[hline]] - Adds horizontal lines to figure at specified locations.
   
   
===I===
:[[infobox]] - Display a string in an information box.
:[[infobox]] - Display a string in an information box.
:[[ipls]] - Interval PLS variable selection.
:[[ipls]] - Interval PLS variable selection.
   
   
===J===
:[[jmlimit]] - Confidence limits for Q residuals via Jackson-Mudholkar.
:[[jmlimit]] - Confidence limits for Q residuals via Jackson-Mudholkar.
   
   
===K===
:[[knn]] - K-nearest neighbor classifier.
:[[knn]] - K-nearest neighbor classifier.
   
   
===L===
:[[lamsel]] - Determines indices of wavelength axes in specified ranges.
:[[lamsel]] - Determines indices of wavelength axes in specified ranges.
:[[lddlgpls]] - Dialog to load variable from workspace or MAT file.
:[[lddlgpls]] - Dialog to load variable from workspace or MAT file.
Line 130: Line 131:
:[[lwrpred]] - Predictions based on locally weighted regression models.
:[[lwrpred]] - Predictions based on locally weighted regression models.
   
   
===M===
:[[matchvars]] - Align variables of a dataset to allow prediction with a model.
:[[matchvars]] - Align variables of a dataset to allow prediction with a model.
:[[manrotate]] - Graphical interface to manually rotate model loadings.
:[[manrotate]] - Graphical interface to manually rotate model loadings.
Line 153: Line 154:
:[[mtfreadr]] - Read AdventaCT Multi-Trace Format (MTF) files.
:[[mtfreadr]] - Read AdventaCT Multi-Trace Format (MTF) files.
   
   
===N===
:[[nassign]] - Generic subscript assignment indexing for n-way arrays.
:[[nassign]] - Generic subscript assignment indexing for n-way arrays.
:[[ncrossval]] - Cross-validation for multilinear PLS (N-PLS).
:[[ncrossval]] - Cross-validation for multilinear PLS (N-PLS).
Line 162: Line 163:
:[[npreprocess]] - Preprocessing of multi-way arrays.
:[[npreprocess]] - Preprocessing of multi-way arrays.
   
   
===O===
:[[oscapp]] - Applies OSC model to new data.
:[[oscapp]] - Applies OSC model to new data.
:[[osccalc]] - Calculates orthogonal signal correction (OSC).
:[[osccalc]] - Calculates orthogonal signal correction (OSC).
:[[outerm]] - Computes outer product of any number of vectors.
:[[outerm]] - Computes outer product of any number of vectors.
   
   
===P===
:[[parafac]] - Parallel factor analysis for n-way arrays.
:[[parafac]] - Parallel factor analysis for n-way arrays.
:[[parafac2]] - Parallel factor analysis for unevenly sized n-way arrays.
:[[parafac2]] - Parallel factor analysis for unevenly sized n-way arrays.
Line 202: Line 203:
:[[purityengine]] - calculates purity values of columns of data set.
:[[purityengine]] - calculates purity values of columns of data set.
   
   
===Q===
:[[querydb]] - Executes a query on a database defined by connection string.
:[[querydb]] - Executes a query on a database defined by connection string.
   
   
===R===
:[[readme]] - Release notes for Version 4.1 of PLS_Toolbox.
:[[readme]] - Release notes for Version 4.1 of PLS_Toolbox.
:[[regcon]] - Converts regression model to y = ax + b form.
:[[regcon]] - Converts regression model to y = ax + b form.
Line 220: Line 221:
:[[rwb]] - Red white and blue color map.
:[[rwb]] - Red white and blue color map.
   
   
===S===
:[[savgol]] - Savitzky-Golay smoothing and differentiation.
:[[savgol]] - Savitzky-Golay smoothing and differentiation.
:[[savgolcv]] - Cross-validation for Savitzky-Golay smoothing and differentiation.
:[[savgolcv]] - Cross-validation for Savitzky-Golay smoothing and differentiation.
Line 244: Line 245:
:[[svdlgpls]] - Dialog to save variable to workspace or MAT file.
:[[svdlgpls]] - Dialog to save variable to workspace or MAT file.
   
   
===T===
:[[tld]] - Trilinear decomposition.
:[[tld]] - Trilinear decomposition.
:[[trendtool]] - Univariate trend analysis tool.
:[[trendtool]] - Univariate trend analysis tool.
Line 252: Line 253:
:[[tucker]] - Analysis for n-way arrays.
:[[tucker]] - Analysis for n-way arrays.
   
   
===U===
:[[unfoldm]] - Rearranges (unfolds) an augmented matrix to row vectors.
:[[unfoldm]] - Rearranges (unfolds) an augmented matrix to row vectors.
:[[unfoldmw]] - Unfolds multiway arrays along specified order.
:[[unfoldmw]] - Unfolds multiway arrays along specified order.
:[[updatemod]] - Update model structure to be compatible with the current version.
:[[updatemod]] - Update model structure to be compatible with the current version.
   
   
===V===
:[[varcap]] - Variance captured for each variable in PCA model.
:[[varcap]] - Variance captured for each variable in PCA model.
:[[varcapy]] - Calculate percent y-block variance captured by a PLS regression model.
:[[varcapy]] - Calculate percent y-block variance captured by a PLS regression model.
Line 264: Line 265:
:[[vline]] - Adds vertical lines to figure at specified locations.
:[[vline]] - Adds vertical lines to figure at specified locations.
   
   
===W===
:[[wlsbaseline]] - Weighted least squares baseline function.
:[[wlsbaseline]] - Weighted least squares baseline function.
:[[writecsv]] - Export a DataSet object to a comma-separated values (CSV) file.
:[[writecsv]] - Export a DataSet object to a comma-separated values (CSV) file.
Line 270: Line 271:
:[[wtfa]] - Window target factor analysis.
:[[wtfa]] - Window target factor analysis.
   
   
===X===
:[[xclgetdata]] - Extracts matrix from an Excel spreadsheet.
:[[xclgetdata]] - Extracts matrix from an Excel spreadsheet.
:[[xclputdata]] - Write matrix to an Excel spreadsheet.
:[[xclputdata]] - Write matrix to an Excel spreadsheet.
Line 277: Line 278:
:[[xyreadr]]  - Reads one or more ASCII XY or XY... files into a DataSet object.
:[[xyreadr]]  - Reads one or more ASCII XY or XY... files into a DataSet object.
   
   
===Y===
:[[yscale]] - Rescales the y-axis limits on each subplot in a figure.
:[[yscale]] - Rescales the y-axis limits on each subplot in a figure.
   
   
===Z===
:[[zline]] - Adds vertical lines to 3D figure at specified locations.
:[[zline]] - Adds vertical lines to 3D figure at specified locations.

Revision as of 18:02, 14 August 2008

A

abline - Draws a line on the current axes with a given slope and intercept.
alignmat - Alignment of matrices and N-way arrays.
alignpeaks - Calibrates wavelength scale using standard peaks.
alignspectra - Calibrates wavelength scale using standard spectrum.
als - Alternating Least Squares computational engine.
analysis - Graphical user interface for data analysis.
anova1w - One-way analysis of variance.
anova2w - Two-way analysis of variance.
areadr - Reads ascii data and strips header.
auto - Autoscales matrix to mean zero unit variance.
autocor - Auto-correlation function for time series data.
autoimport - Automatically reads specified file. Handles all standard filetypes.

B

b3spline - Univariate spline fit and prediction.
baseline - Subtracts a polynomial baseline offset from spectra.
baselinew - Baseline using windowed polynomial filter.
besttime - Returns a string describing the time interval provided (in seconds).
batchdigester - Parse wafer or batch data into MPCA or Summary PCA form.
browse - PLS_Toolbox Toolbar and Workspace browser.
builddbstr - Builds a database connection string.

C

calibsel - Statistical procedure for variable selection.
caltransfer - Create or apply calibration and instrument transfer models.
cellne - Compares two cells for inequality in size and/or values.
chilimit - Chi-squared confidence limits from sum-of-squares residuals.
choosecomp - Automatic selection of components for various model types.
choosencomp - GUI to select number of components from SSQ table.
class2logical - Create a PLSDA logical block from class assignments.
cluster - KNN and K-means cluster analysis with dendrograms.
cls - Classical Least Squares regression for multivariate Y.
coadd - Reduce resolution through combination of adjacent variables or samples.
coda_dw - Calculates values for the Durbin_Watson criterion of columns of data set.
coda_dw_interactive - Interactive version of CODA_DW.
comparelcms_sim_interactive - Interactive interface for COMPARELCMS.
comparelcms_simengine - Calculational Engine for comparelcms.
comparevars - Compares two variables of any type and returns differences.
compressmodel - Remove references to unused variables from a model.
copydsfields - Copies informational fields between datasets and/or models.
corcondia - Evaluates consistency of PARAFAC model.
coreanal - Analysis of the core array of a Tucker model.
corecalc - Calculate the Tucker3 core given the data array and loadings.
corrmap - Correlation map with variable grouping.
corrspec - Resolves correlation spectroscopy maps.
cr - Continuum Regression for multivariate y.
crcvrnd - Cross-validation for continuum regression.
crosscor - Cross-correlation function for time series data.
crossval - Cross-validation for decomposition and linear regression.

D

datahat - Calculates the model estimate and residuals of the data.
datasetdemo - Demonstrates use of the dataset object.
delsamps - Deletes samples (rows) or variables (columns) from data matrices.
demos - Demo list for the PLS_Toolbox.
deresolv - Changes high resolution spectra to low resolution.
discrimprob - Discriminate probabilities for continuous predicted values.
dispmat - Calculates the dispersion matrix of two spectral data sets.
distslct - Selects samples on outside of data space.
doptimal - Selects samples based on D-Optimal criteria.
dp - Draws a diagonal line on an existing figure.
durbin_watson - Criterion for measure of continuity.

E

editds - Editor for DataSet Objects.
ellps - Plots an ellipse on an existing figure.
encode - Translates a variable into matlab-executable code.
erdlgpls - Error dialog.
estimatefactors - Estimate number of significant factors in multivariate data.
evolvfa - Evolving factor analysis (forward and reverse).
evridebug - Checks the PLS_Toolbox installation for problems.
evriinstall - Install Eigenvector Research Product.
evrirelease - Returns Eigenvector product release number.
evriuninstall - Uninstall an Eigenvector Research toolbox.
evriupdate - Check Eigenvector.com for available PLS_Toolbox updates.
ewfa - Evolving window factor analysis.
excludemissing - Automatically exclude too-much missing data in a matrix.
explode - Extracts variables from a structure array to the workspace.
exportfigure - Automatically export figures to an external program.

F

factdes - Full factorial design of experiments.
fastnnls - Fast non-negative least squares.
ffacdes1 - Fractional factorial design of experiments.
figbrowser - Browser with icons of all Matlab figures.
figmerit - Analytical figures of merit for multivariate calibration.
findindx - Finds the index of the array element closest to value r.
fir2ss - Transform FIR model into equivalent state space model.
frpcr - Full-ratio PCR calibration and prediction.
frpcrengine - Engine for full-ratio PCR regression.
ftest - F test and inverse F test statistic.
fullsearch - Exhaustive Search Algorithm for small problems.

G

gaselctr - Genetic algorithm for variable selection with PLS.
genalg - Genetic Algorithm for Variable Selection.
genalgplot - Plot GA results using selected variable plot, color-coded by RMSECV.
getdatasource - Extract summary dataset info.
getmlversion - Returns current Matlab version as an integer.
getpidata - Uses the current PI connection to construct a DSO from 'taglist'.
getplspref - Get overriding options (preferences) for PLS_Toolbox functions.
glsw - Generalized least-squares weighting/preprocessing.
gram - Generalized rank annihilation method.
gscale - Group/block scaling for a single or multiple blocks.
gscaler - Applies group/block scaling to submatrices of a single matrix.
gselect - Selects objects in a figure (various selection styles).

H

helppls - Context related help on the PLS_Toolbox.
hline - Adds horizontal lines to figure at specified locations.

I

infobox - Display a string in an information box.
ipls - Interval PLS variable selection.

J

jmlimit - Confidence limits for Q residuals via Jackson-Mudholkar.

K

knn - K-nearest neighbor classifier.

L

lamsel - Determines indices of wavelength axes in specified ranges.
lddlgpls - Dialog to load variable from workspace or MAT file.
leverag - Calculate sample leverages.
linmodeldemo - Demo of the CROSSVAL, MODLRDER, PCR, PLS, PREPROCESS and SSQTABLE functions.
logdecay - Mean centers and variance scales a matrix using the log decay of the variable axis.
loopfilereadr - An example function for reading files in a loop from a directory.
lsq2top - Fits a polynomial to the top/(bottom) of data.
lwrpred - Predictions based on locally weighted regression models.

M

matchvars - Align variables of a dataset to allow prediction with a model.
manrotate - Graphical interface to manually rotate model loadings.
mcr - Multivariate curve resolution with constraints.
mdcheck - Missing Data Checker and infiller.
med2top - Fits a constant to top/(bottom) of data.
medcn - Median center scales matrix to median zero.
mlpca - Maximum likelihood principal components analysis.
mlr - Multiple Linear Regression for multivariate Y.
mlrengine - Multiple Linear Regression computational engine.
mncn - Scale matrix to mean zero.
modelcache - Stores and retrieves models in the model cache.
modelselector - Create or apply a model selector model.
modelstruct - Constructs an empty model structure.
modelviewer - Visualization tool for multi-way models.
modlpred - Predictions using standard model structures.
modlrder - Displays model info for standard model structures.
moveobj - Interactively reposition graphics objects.
mpca - Multi-way (unfold) principal components analysis.
mplot - Automatic creation of subplots and plotting.
mscorr - Multiplicative scatter/signal correction (MSC).
mtfreadr - Read AdventaCT Multi-Trace Format (MTF) files.

N

nassign - Generic subscript assignment indexing for n-way arrays.
ncrossval - Cross-validation for multilinear PLS (N-PLS).
nindex - Generic subscript indexing for n-way arrays.
nippls - NIPALS Partial Least Squares computational engine.
normaliz - Normalize rows of matrix.
npls - Multilinear-PLS (N-PLS) for true multi-way regression.
npreprocess - Preprocessing of multi-way arrays.

O

oscapp - Applies OSC model to new data.
osccalc - Calculates orthogonal signal correction (OSC).
outerm - Computes outer product of any number of vectors.

P

parafac - Parallel factor analysis for n-way arrays.
parafac2 - Parallel factor analysis for unevenly sized n-way arrays.
parsemixed - Parse numerical and text data into a DataSet Object.
pca - Principal components analysis.
pcaengine - Principal Components Analysis computational engine.
pcapro - Projects new data on old principal components model.
pcolormap - Pseudocolor plot with labels and colorbar.
pcr - Principal components regression for multivariate Y.
pcrengine - Principal Component Regression computational engine.
percentile - Finds percentile point (similar to MEDIAN).
ploteigen - Builds dataset object of eigenvalues/RMSECV information.
plotgui - Interactive data viewer.
plotloads - Extract and display loadings information from a model structure.
plotscores - Extract and display score information from a model.
pls - Partial least squares regression for multivariate Y.
plsda - Partial least squares discriminant analysis.
plsdaroc - Calculate and display ROC curves for PLSDA model.
plsdthres - Bayesian threshold determination for PLS Discriminate Analysis.
plslogo - Generates PLS_Toolbox CR surface logo.
plsnipal - NIPALS algorithm for one PLS latent variable.
plspulsm - Identifies FIR dynamics models for MISO systems.
plsrsgcv - Generate PLS models for MSPC with cross-validation.
plsrsgn - Generates a matrix of PLS models for MSPC.
plsver - Displays version information.
plttern - Plots a 2D ternary diagram.
pltternf - Plots a 3D ternary diagram with frequency of occurrence.
polyinterp - Polynomial interpolation, smoothing, and differentiation.
polypls - PLS regression with polynomial inner-relation.
preprocess - Selection and application of standard preprocessing structures.
preprouser - User-defined preprocessing methods.
projdemo - Demo of the MLR, PCR, and PLS regression vectors.
purity - Self-modeling mixture analysis method based on purity of variables or spectra.
purityengine - calculates purity values of columns of data set.

Q

querydb - Executes a query on a database defined by connection string.

R

readme - Release notes for Version 4.1 of PLS_Toolbox.
regcon - Converts regression model to y = ax + b form.
registerspec - Shift spectra based on expected peak locations.
replace - Replaces variables based on PCA or PLS models.
rescale - Scales data back to original scaling.
residuallimit - Estimates confidence limits for sum squared residuals.
reversebytes - Flips order of bytes in a word.
reviewmodel - Examines a standard model structure for typical problems.
ridge - Ridge regression by Hoerl-Kennard-Baldwin.
ridgecv - Ridge regression by cross validation.
rinverse - Calculate pseudo inverse for PLS, PCR and RR models.
rmse - Calculate Root Mean Square Error.
rwb - Red white and blue color map.

S

savgol - Savitzky-Golay smoothing and differentiation.
savgolcv - Cross-validation for Savitzky-Golay smoothing and differentiation.
scale - Scales data using specified means and std. devs.
setpath - Modifies and saves current directory to the MATLAB search path.
setplspref - Set overriding options (preferences) for PLS_Toolbox functions.
shuffle - Randomly re-orders matrix and multiple blocks rows.
simca - Soft Independent Method of Class Analogy.
simpls - Partial Least Squares computational engine using SIMPLS algorithm.
snv - Standard normal variate scaling.
spcreadr - Reads a Galactic SPC file.
specedit - GUI for selecting spectral regions on a plot.
ssqtable - Displays variance captured table for model.
statdemo - Elementary stats, t test, F test and AVOVA.
stddemo - Demo of the STDSSLCT, STDGEN, and OSCCALC functions.
stdfir - Standardization based on FIR modelling.
stdgen - Piecewise and direct standardization transform generator.
stdize - Applies transform from STDGEN to new spectra.
stdsslct - Selects data subsets (often for use in standardization).
string_x - Add backslash before troublesome TeX characters.
subgroupcl - Displays a confidence ellipse for points in a two-dimensional plot.
super_reduce - Eliminates highly correlated variables.
svdlgpls - Dialog to save variable to workspace or MAT file.

T

tld - Trilinear decomposition.
trendtool - Univariate trend analysis tool.
tsqlim - Confidence limits for Hotelling's T^2.
tsqmtx - Calculates matrix for T^2 contributions for PCA.
ttestp - Evaluates t-distribution and its inverse.
tucker - Analysis for n-way arrays.

U

unfoldm - Rearranges (unfolds) an augmented matrix to row vectors.
unfoldmw - Unfolds multiway arrays along specified order.
updatemod - Update model structure to be compatible with the current version.

V

varcap - Variance captured for each variable in PCA model.
varcapy - Calculate percent y-block variance captured by a PLS regression model.
varimax - Orthogonal rotation of loadings.
vip - Calculate Variable Importance in Projection from regression model.
vline - Adds vertical lines to figure at specified locations.

W

wlsbaseline - Weighted least squares baseline function.
writecsv - Export a DataSet object to a comma-separated values (CSV) file.
wrtpulse - Create input/output matrices for dynamic model identification.
wtfa - Window target factor analysis.

X

xclgetdata - Extracts matrix from an Excel spreadsheet.
xclputdata - Write matrix to an Excel spreadsheet.
xclreadr - Reads an ASCII or .XLS file in as a DataSet Object.
xlsreadr - Reads .XLS files from MS Excel and other spreadsheets.
xyreadr - Reads one or more ASCII XY or XY... files into a DataSet object.

Y

yscale - Rescales the y-axis limits on each subplot in a figure.

Z

zline - Adds vertical lines to 3D figure at specified locations.