org.openimaj.math.model.fit.residuals

Interface ResidualCalculator<I,D,M extends Model<I,D>>

Type Parameters:

I - type of independent data

D - type of dependent data

M - type of model

All Known Implementing Classes:

AbstractResidualCalculator, AlgebraicResidual2d, DistanceComparatorResidual, FundamentalModel.EpipolarResidual, FundamentalModel.Fundamental8PtResidual, FundamentalModel.SampsonGeometricResidual, SingleImageTransferResidual2d, SymmetricTransferResidual2d, TransformedSITR2d

public interface ResidualCalculator<I,D,M extends Model<I,D>>

Interface describing the computation of an error (the residuals) of a set of (independent and dependent) data points with respect to a model.

Author:

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

Method Summary

Modifier and Type	Method and Description
double	computeResidual(IndependentPair<I,D> data) Compute the residual for a single point
void	computeResiduals(List<? extends IndependentPair<I,D>> data, double[] residuals) Compute the residual for a set of data points
void	setModel(M model) Set the current model being evaluated.

Method Detail

setModel

void setModel(M model)

Set the current model being evaluated. This should be called every time the model has changed internally, as the ResidualCalculator might pre-cache variables based on the model for error computation.

Parameters:

model - the model

computeResidual

double computeResidual(IndependentPair<I,D> data)

Compute the residual for a single point

Parameters:

data - the data

Returns:

the error

computeResiduals

void computeResiduals(List<? extends IndependentPair<I,D>> data,
                      double[] residuals)

Compute the residual for a set of data points

Parameters:

data - the data

residuals - the array to write the residuals into