Click or drag to resize

WorksheetAnalysis Methods

The WorksheetAnalysis type exposes the following members.

Methods
 NameDescription
Public methodCalculateAdditionalColumn Calculates and stores a single additional result column.
Public methodCalculateAdditionalColumns Calculates and stores all requested additional result columns.
Public methodCalculateAndStorePredictionScores(DataTable, Int32) Calculates and stores prediction scores for all dependent variables.
Public methodCalculateAndStorePredictionScores(DataTable, Int32, Int32) Calculates and stores prediction scores for a single dependent variable.
Public methodCalculateCrossPredictedAndResidual Calculates and optionally stores cross-predicted values and residuals.
Public methodCalculateCrossPredictedY Calculates cross-predicted y-values for the provided spectra.
Public methodCalculateCrossPRESS Calculate the cross PRESS values and stores the results in the provided table.
Public methodCalculatePredictedAndResidual Calculates and optionally stores predicted values and residuals.
Public methodCalculatePredictedY For a given set of spectra, predicts the y-values and stores them in the matrix predictedY
Public methodCalculatePredictionScores Calculates the prediction scores. In case of a single y-variable, the prediction score is a vector of the same length than a spectrum. Multiplying the prediction score (dot product) with a spectrum, it yields the predicted y-value (of cause mean-centered).
Public methodCalculatePreprocessedSpectra Fills a provided table (should be empty) with the preprocessed spectra. The spectra are saved as columns (independently on their former orientation in the original worksheet).
Public methodCalculateXLeverage Calculates the leverage of the spectral data.
Public methodCalculateXResidual Calculates spectral residuals for the specified y-component and factor count.
Public methodCalculateYPredicted Calculated the predicted y for the component given by whichY and for the given number of factors.
Public methodCalculateYResidual Calculates the y-residuals (concentration etc.).
Public methodCreateNewRegressionObject Creates a regression object appropriate for the current analysis.
Public methodEnsureMatchingXOfX Compares the two arrays and throws an InvalidOperationException if the data not match.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExecuteAnalysis(AltaxoDocument, DataTableMatrixProxyWithMultipleColumnHeaderColumns, DimensionReductionAndRegressionOptions, DataTable) Makes a PLS (a partial least squares) analysis of the table or the selected columns / rows and stores the results in a newly created table. Here, the spectra are stored in the data columns of the proxy, the target variables are located in the ColumnHeaderColumns of the proxy.
Public methodExecuteAnalysis(IMatrixDouble, IMatrixDouble, DimensionReductionAndRegressionOptions, DataTable, IReadOnlyListDouble) Execute an analysis and stores the result in the provided table.
Public methodExecuteAnalysis(AltaxoDocument, DataTable, IAscendingIntegerCollection, IAscendingIntegerCollection, IAscendingIntegerCollection, Boolean, DimensionReductionAndRegressionOptions) Makes a PLS (a partial least squares) analysis of the table or the selected columns / rows and stores the results in a newly created table.
Public methodExecuteAnalysis(AltaxoDocument, DataTableMatrixProxyWithMultipleColumnHeaderColumns, MatrixDouble, MatrixDouble, Double, DimensionReductionAndRegressionOptions, DataTable, DimensionReductionAndRegressionResult) Makes a PLS (a partial least squares) analysis of the table or the selected columns / rows and stores the results in a newly created table.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetCalibrationModel Returns an instance of the calibration model specific for the multivariate analysis.
Public methodStatic memberGetCrossPRESSValue_ColumnName Gets the cross-PRESS column name.
Public methodStatic memberGetCrossProduct_ColumnName Gets the cross-product column name.
Public methodStatic memberGetCrossProduct_ColumnName(Int32) Gets the cross-product column name for the specified constituent.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodStatic memberGetMeasurementLabel_ColumnName Gets the measurement label column name.
Public methodStatic memberGetNumberOfFactors_ColumnGroup Gets the column group used for the factor count column.
Public methodStatic memberGetNumberOfFactors_ColumnName Gets the column name used for the factor count column.
Public methodStatic memberGetOriginalY Using the information in the plsMemo, gets the matrix of original Y (concentration) data.
Public methodStatic memberGetPredictionScore_ColumnGroup Gets the column group used for prediction scores.
Public methodStatic memberGetPredictionScore_ColumnName Gets the prediction score column name for the specified constituent and factor.
Public methodStatic memberGetPRESSValue_ColumnName Gets the PRESS column name.
Public methodStatic memberGetRawSpectra Fills a matrix with the selected data of a table.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodStatic memberGetXCrossResidual_ColumnGroup Gets the column group used for cross spectral residuals.
Public methodStatic memberGetXCrossResidual_ColumnName Gets the column name of a X-Crossvalidated spectral Residual column
Public methodStatic memberGetXLeverage_ColumnGroup Gets the column group used for leverage values.
Public methodStatic memberGetXLeverage_ColumnName(Int32) Gets the column name of a X-Leverage column
Public methodStatic memberGetXLeverage_ColumnName(Int32, Int32) Gets the column name of a X-Leverage column
Public methodStatic memberGetXLoad_ColumnName(Int32) Gets the x-load column name for the specified factor.
Public methodStatic memberGetXLoad_ColumnName(Int32, Int32) Gets the x-load column name for the specified constituent and factor.
Public methodStatic memberGetXMean_ColumnName Gets the column name used for the mean of x-values.
Public methodStatic memberGetXOfSpectra Returns the corresponding x-values of the spectra (In fact only the first spectra is used to determine which x-column is used).
Public methodStatic memberGetXOfX_ColumnName Gets the column name used for x-axis values of spectra.
Public methodStatic memberGetXResidual_ColumnGroup Gets the column group used for spectral residuals.
Public methodStatic memberGetXResidual_ColumnName Gets the column name of a X-Residual column
Public methodStatic memberGetXScale_ColumnName Gets the column name used for the scale of x-values.
Public methodStatic memberGetXScore_ColumnName Gets the x-score column name for the specified factor.
Public methodStatic memberGetXWeight_ColumnName(Int32) Gets the x-weight column name for the specified factor.
Public methodStatic memberGetXWeight_ColumnName(Int32, Int32) Gets the x-weight column name for the specified constituent and factor.
Public methodStatic memberGetXYMatricesOfSpectralColumns Gets the spectral and target variable matrices (both unpreprocessed) for analysis.
Public methodStatic memberGetYCrossPredicted_ColumnGroup Gets the column group used for cross-predicted y-values.
Public methodStatic memberGetYCrossPredicted_ColumnName Gets the column name of a Y-Cross-Predicted column
Public methodStatic memberGetYCrossResidual_ColumnGroup Gets the column group used for cross residual y-values.
Public methodStatic memberGetYCrossResidual_ColumnName Gets the column name of a Y-Cross-Residual column
Public methodStatic memberGetYLoad_ColumnName(Int32) Gets the y-load column name for the specified factor.
Public methodStatic memberGetYLoad_ColumnName(Int32, Int32) Gets the y-load column name for the specified constituent and factor.
Public methodStatic memberGetYMean_ColumnName Gets the column name used for the mean of y-values.
Public methodStatic memberGetYOriginal_ColumnName Gets the column name of a Y-Original column
Public methodStatic memberGetYPredicted_ColumnGroup Gets the column group used for predicted y-values.
Public methodStatic memberGetYPredicted_ColumnName Gets the column name of a Y-Predicted column
Public methodStatic memberGetYResidual_ColumnGroup Gets the column group used for y residuals.
Public methodStatic memberGetYResidual_ColumnName Gets the column name of a Y-Residual column
Public methodStatic memberGetYScale_ColumnName Gets the column name used for the scale of y-values.
Protected methodStatic memberIsDimensionReductionAndRegressionModel Determines whether the specified table uses a dimension-reduction-and-regression data source.
Public methodStatic memberMapSpectralX This maps the indices of a master x column to the indices of a column to map.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodStatic memberNotFound Throws an exception indicating that a required column was not found.
Public methodPredictValues(DataTableMatrixProxyWithMultipleColumnHeaderColumns, Int32, DataTable, DataTable) This predicts the selected columns/rows against a user choosen calibration model. The orientation of spectra is given by the parameter spectrumIsRow.
Public methodPredictValues(DataTable, IAscendingIntegerCollection, IAscendingIntegerCollection, Int32, DataTable, DataTable) This predicts the selected columns/rows against a user choosen calibration model. The orientation of spectra is given by the parameter spectrumIsRow.
Public methodStatic memberRemoveNonNumericCells For given selected columns and selected rows, the procedure removes all nonnumeric cells. Furthermore, if either selectedColumns or selectedRows is empty, the collection is filled by the really used rows/columns.
Protected methodStatic memberSaveAuxiliaryDataToTable Saves auxiliary data that is associated with samples.
Protected methodStoreCalculatedColumn Stores the information that a given column was calculated inside the DataSource object of the table.
Public methodStoreCalibrationModelInTable Stores the calibrationSet into the data table table.
Public methodStoreFRatioData Stores F-ratio and F-probability data derived from PRESS values.
Public methodStoreNumberOfFactors Stores the number-of-factors column in the destination table.
Public methodStoreOriginalY Stores the original y-values in the destination table.
Public methodStorePreprocessedData Stores preprocessing information and dependent-variable scaling in the table.
Public methodStorePRESSData Stores PRESS data in the destination table.
Public methodStoreXOfX Stores the x-axis values for the spectra in the destination table.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also