org.openimaj.math.geometry.transforms

Class AffineTransformModel

java.lang.Object

org.openimaj.math.geometry.transforms.AffineTransformModel

All Implemented Interfaces:

Cloneable, MatrixTransformProvider, EstimatableModel<Point2d,Point2d>, Model<Point2d,Point2d>

public class AffineTransformModel
extends Object
implements EstimatableModel<Point2d,Point2d>, MatrixTransformProvider

Concrete implementation of a model of an Affine transform. Capable of least-squares estimate of model parameters using the SVD.

Author:

Jonathon Hare

Field Summary

Fields

Modifier and Type	Field and Description
protected Predicate<AffineTransformModel>	modelCheck
protected Jama.Matrix	transform

Constructor Summary

Constructors

Constructor and Description
AffineTransformModel() Create an AffineTransformModel
AffineTransformModel(Predicate<AffineTransformModel> mc) Create an AffineTransformModel.

Method Summary

Modifier and Type	Method and Description
AffineTransformModel	clone() Clone the model
boolean	estimate(List<? extends IndependentPair<Point2d,Point2d>> data) Estimates the model from the observations in the list of data.
Jama.Matrix	getTransform()
int	numItemsToEstimate()
Point2d	predict(Point2d p) Uses the model to predict dependent data from an independent value.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

modelCheck

protected Predicate<AffineTransformModel> modelCheck

transform

protected Jama.Matrix transform

Constructor Detail

AffineTransformModel

public AffineTransformModel()

Create an AffineTransformModel

AffineTransformModel

public AffineTransformModel(Predicate<AffineTransformModel> mc)

Create an AffineTransformModel. The given Predicate is used by the estimate(List) method to test whether the estimated affine transform is sensible.

Parameters:

mc - the test function for sensible affine transforms

Method Detail

clone

public AffineTransformModel clone()

Description copied from interface: EstimatableModel

Clone the model

Specified by:

clone in interface EstimatableModel<Point2d,Point2d>

Overrides:

clone in class Object

Returns:

a cloned copy

getTransform

public Jama.Matrix getTransform()

Specified by:

getTransform in interface MatrixTransformProvider

Returns:

the transform matrix represented by the object

estimate

public boolean estimate(List<? extends IndependentPair<Point2d,Point2d>> 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<Point2d,Point2d>

Parameters:

data - Data with which to estimate the model

Returns:

true if a successful estimate was made, false otherwise

See Also:

EstimatableModel.numItemsToEstimate()

predict

public Point2d predict(Point2d p)

Description copied from interface: Model

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

Specified by:

predict in interface Model<Point2d,Point2d>

Parameters:

p - the data (independent variable)

Returns:

Dependent variable(s) predicted from the independent ones.

numItemsToEstimate

public int numItemsToEstimate()

Specified by:

numItemsToEstimate in interface EstimatableModel<Point2d,Point2d>

Returns:

The minimum number of observations required to estimate the model.

toString

public String toString()

Overrides:

toString in class Object