Facemorph.Stats
Interface StatisticalModel

All Superinterfaces:
IniHandler
All Known Subinterfaces:
DataReducer, Regressor
All Known Implementing Classes:
BinaryLogisticRegression, DifferenceOfAverages, ICA, ImagePLS, ImageRegressor, NumericRegressor, OvercompleteSPLS, PCAReducer, PLSReducer, sPLSSVD, sPLSSVD_DWH, WaveletPLS, WaveletRGBPLS, WeightedPLS, WeightedPLS2

public interface StatisticalModel
extends IniHandler

A base class for statistical models


Method Summary
 BigMat apply(BigMat in)
          Apply the statistical model on the input data supplied in Matrix form
 int getInputDimensions()
           
 void getModelInformation(ModelInformation mi)
          Queries the statistical model about its abilities.
 void getModelInformation(ModelResults result)
          Query the (previously built) model for information about the model's components
 int getOutputDimensions()
           
 java.lang.StringBuffer outputStatistics()
           
 boolean outputStatistics(java.io.File statsFile)
           
 void setDependentData(BigMat data)
          The dependent part of the regression
 void setDependentData(double[] data)
          The dependent part of the regression
 void setIndependentData(BigMat data)
          The independent part of the regression
 boolean train(boolean stats)
          Perform multi-linear regression using the Ordinary Least Squares method.
 
Methods inherited from interface Facemorph.DataBase.IniHandler
read, write
 

Method Detail

train

boolean train(boolean stats)
Perform multi-linear regression using the Ordinary Least Squares method. Solves y = XB + e using b = inv(X'X)X'y

Parameters:
stats - calculate values for statistical analysis
Returns:
true if the regression succeeds.

apply

BigMat apply(BigMat in)
Apply the statistical model on the input data supplied in Matrix form

Parameters:
in - matrix containing values for modeling
Returns:
values computed by the model.

setIndependentData

void setIndependentData(BigMat data)
The independent part of the regression

Parameters:
ind - regression variables

setDependentData

void setDependentData(BigMat data)
The dependent part of the regression

Parameters:
ind - regression variables

setDependentData

void setDependentData(double[] data)
The dependent part of the regression

Parameters:
ind - regression variables

getInputDimensions

int getInputDimensions()

getOutputDimensions

int getOutputDimensions()

outputStatistics

boolean outputStatistics(java.io.File statsFile)

outputStatistics

java.lang.StringBuffer outputStatistics()

getModelInformation

void getModelInformation(ModelInformation mi)
Queries the statistical model about its abilities.


getModelInformation

void getModelInformation(ModelResults result)
Query the (previously built) model for information about the model's components

Parameters:
result - ModelResults object to fill with appropriate information