org.openimaj.math.geometry.transforms

Class NullModel<T>

java.lang.Object

org.openimaj.math.geometry.transforms.NullModel<T>

Type Parameters:

T - The type of data

All Implemented Interfaces:

Cloneable, EstimatableModel<T,T>, Model<T,T>

public class NullModel<T>
extends Object
implements EstimatableModel<T,T>

A NullModel models a one-to-one mapping of data. For convenience the EstimatableModel interface is implemented, although estimating does absolutely nothing!

Author:

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

Constructor Summary

Constructors

Constructor and Description
NullModel()

Method Summary

Methods

Modifier and Type	Method and Description
NullModel<T>	clone() Clone the model
boolean	estimate(List<? extends IndependentPair<T,T>> data) Estimates the model from the observations in the list of data.
int	numItemsToEstimate()
T	predict(T data) Uses the model to predict dependent data from an independent value.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NullModel

public NullModel()

Method Detail

predict

public T predict(T data)

Description copied from interface: Model

Uses the model to predict dependent data from an independent value.

Specified by:

predict in interface Model<T,T>

Parameters:

data - the data (independent variable)

Returns:

Dependent variable(s) predicted from the independent ones.

clone

public NullModel<T> clone()

Description copied from interface: EstimatableModel

Clone the model

Specified by:

clone in interface EstimatableModel<T,T>

Overrides:

clone in class Object

Returns:

a cloned copy

estimate

public boolean estimate(List<? extends IndependentPair<T,T>> data)

Description copied from interface: EstimatableModel

Estimates the model from the observations in the list of data. The data must contain at least EstimatableModel.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.

Specified by:

estimate in interface EstimatableModel<T,T>

Parameters:

data - Data with which to estimate the model

Returns:

true if a successful estimate was made, false otherwise

See Also:

EstimatableModel.numItemsToEstimate()

numItemsToEstimate

public int numItemsToEstimate()

Specified by:

numItemsToEstimate in interface EstimatableModel<T,T>

Returns:

The minimum number of observations required to estimate the model.