org.openimaj.math.model

Interface EstimatableModel<I,D>

Type Parameters:

I - type of independent data

D - type of dependent data

All Superinterfaces:

Cloneable, Model<I,D>

All Known Subinterfaces:

ImageClassificationModel<T>

All Known Implementing Classes:

AffineTransformModel, AffineTransformModel3d, FundamentalModel, GaussianVectorNaiveBayesModel, HistogramPatchModel, HistogramPixelModel, HomographyModel, LeastSquaresLinearModel, LinearRegression, MBFPatchClassificationModel, MBFPixelClassificationModel, NullModel, OrthotopePixelModel, PatchClassificationModel, PixelClassificationModel, RigidTransformModel3d, SimplePerceptron, SingleGaussianPixelModel, UnivariateGaussianNaiveBayesModel

public interface EstimatableModel<I,D>
extends Model<I,D>, Cloneable

An extension to a Model that allows the model to be estimated from a series of observations of both the independent and dependent variables.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
EstimatableModel<I,D>	clone() Clone the model
boolean	estimate(List<? extends IndependentPair<I,D>> data) Estimates the model from the observations in the list of data.
int	numItemsToEstimate()

Methods inherited from interface org.openimaj.math.model.Model

predict

Method Detail

estimate

boolean estimate(List<? extends IndependentPair<I,D>> data)

Estimates the model from the observations in the list of data. The data must contain at least numItemsToEstimate() pairs of dependent and independent data. It may contain more, in which case the estimate method may choose to make use of this data for validation, or obtaining a better model by a least squares method for example.

Parameters:

data - Data with which to estimate the model

Returns:

true if a successful estimate was made, false otherwise

See Also:

numItemsToEstimate()

numItemsToEstimate

int numItemsToEstimate()

Returns:

The minimum number of observations required to estimate the model.

clone

EstimatableModel<I,D> clone()

Clone the model

Returns:

a cloned copy