Package com.irurueta.geometry.estimators

Class PROSACPoint2DRobustEstimator

java.lang.Object

com.irurueta.geometry.estimators.Point2DRobustEstimator

com.irurueta.geometry.estimators.PROSACPoint2DRobustEstimator

public class PROSACPoint2DRobustEstimator
extends Point2DRobustEstimator

Finds the best 2D point for provided collection of 2D lines using PROSAC algorithm.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	computeAndKeepInliers	Indicates whether inliers must be computed and kept.
private boolean	computeAndKeepResiduals	Indicates whether residuals must be computed and kept.
static final boolean	DEFAULT_COMPUTE_AND_KEEP_INLIERS	Indicates that by default inliers will only be computed but not kept.
static final boolean	DEFAULT_COMPUTE_AND_KEEP_RESIDUALS	Indicates that by default residuals will only be computed but not kept.
static final double	DEFAULT_THRESHOLD	Constant defining default threshold to determine whether points are inliers or not.
static final double	MIN_THRESHOLD	Minimum value that can be set as threshold.
private double[]	qualityScores	Quality scores corresponding to each provided point.
private double	threshold	Threshold to determine whether lines are inliers or not when testing possible estimation solutions.

Fields inherited from class com.irurueta.geometry.estimators.Point2DRobustEstimator

confidence, DEFAULT_CONFIDENCE, DEFAULT_KEEP_COVARIANCE, DEFAULT_MAX_ITERATIONS, DEFAULT_PROGRESS_DELTA, DEFAULT_REFINE_RESULT, DEFAULT_ROBUST_METHOD, inliersData, lines, listener, locked, MAX_CONFIDENCE, MAX_PROGRESS_DELTA, maxIterations, MIN_CONFIDENCE, MIN_ITERATIONS, MIN_PROGRESS_DELTA, MINIMUM_SIZE, progressDelta, refineResult

Constructor Summary

Constructors

Constructor	Description
PROSACPoint2DRobustEstimator()	Constructor.
PROSACPoint2DRobustEstimator(double[] qualityScores)	Constructor.
PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener)	Constructor.
PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener, double[] qualityScores)	Constructor.
PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener, List<Line2D> lines)	Constructor.
PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener, List<Line2D> lines, double[] qualityScores)	Constructor.
PROSACPoint2DRobustEstimator(List<Line2D> lines)	Constructor with lines.
PROSACPoint2DRobustEstimator(List<Line2D> lines, double[] qualityScores)	Constructor with lines.

Method Summary

Modifier and Type	Method	Description
Point2D	estimate()	Estimates a 2D point using a robust estimator and the best set of 2D lines that intersect into the estimated 2D point.
com.irurueta.numerical.robust.RobustEstimatorMethod	getMethod()	Returns method being used for robust estimation.
double[]	getQualityScores()	Returns quality scores corresponding to each provided line.
protected double	getRefinementStandardDeviation()	Gets standard deviation used for Levenberg-Marquardt fitting during refinement.
double	getThreshold()	Returns threshold to determine whether lines are inliers or not when testing possible estimation solutions.
private void	internalSetQualityScores(double[] qualityScores)	Sets quality scores corresponding to each provided line.
boolean	isComputeAndKeepInliersEnabled()	Indicates whether inliers must be computed and kept.
boolean	isComputeAndKeepResidualsEnabled()	Indicates whether residuals must be computed and kept.
boolean	isReady()	Indicates if estimator is ready to start the 2D point estimation.
void	setComputeAndKeepInliersEnabled(boolean computeAndKeepInliers)	Specifies whether inliers must be computed and kept.
void	setComputeAndKeepResidualsEnabled(boolean computeAndKeepResiduals)	Specifies whether residuals must be computed and kept.
void	setQualityScores(double[] qualityScores)	Sets quality scores corresponding to each provided line.
void	setThreshold(double threshold)	Sets threshold to determine whether lines are inliers or not when testing possible estimation solutions.

Methods inherited from class com.irurueta.geometry.estimators.Point2DRobustEstimator

attemptRefine, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, getConfidence, getCovariance, getInliersData, getLines, getListener, getMaxIterations, getProgressDelta, getRefinementCoordinatesType, isCovarianceKept, isListenerAvailable, isLocked, isResultRefined, residual, setConfidence, setCovarianceKept, setLines, setListener, setMaxIterations, setProgressDelta, setRefinementCoordinatesType, setResultRefined

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_THRESHOLD

public static final double DEFAULT_THRESHOLD

Constant defining default threshold to determine whether points are inliers or not. Because typical resolution for points is 1 pixel, then default threshold is defined as 1.

See Also:

• Constant Field Values

MIN_THRESHOLD

public static final double MIN_THRESHOLD

Minimum value that can be set as threshold. Threshold must be strictly greater than 0.0.

See Also:

• Constant Field Values

DEFAULT_COMPUTE_AND_KEEP_INLIERS

public static final boolean DEFAULT_COMPUTE_AND_KEEP_INLIERS

Indicates that by default inliers will only be computed but not kept.

See Also:

• Constant Field Values

DEFAULT_COMPUTE_AND_KEEP_RESIDUALS

public static final boolean DEFAULT_COMPUTE_AND_KEEP_RESIDUALS

Indicates that by default residuals will only be computed but not kept.

See Also:

• Constant Field Values

threshold

private double threshold

Threshold to determine whether lines are inliers or not when testing possible estimation solutions. The threshold refers to the amount of error (i.e. distance) a possible solution has on a sampled line.

qualityScores

private double[] qualityScores

Quality scores corresponding to each provided point. The larger the score value the better the quality of the sample

computeAndKeepInliers

private boolean computeAndKeepInliers

Indicates whether inliers must be computed and kept.

computeAndKeepResiduals

private boolean computeAndKeepResiduals

Indicates whether residuals must be computed and kept.

Constructor Details

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator()

Constructor.

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator(List<Line2D> lines)

Constructor with lines.

Parameters:

lines - 2D lines to estimate a 2D point.

Throws:

IllegalArgumentException - if provided list of lines don't have a size greater or equal than MINIMUM_SIZE.

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener)

Constructor.

Parameters:

listener - listener to be notified of events such as when estimation starts, ends or its progress significantly changes.

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener,
 List<Line2D> lines)

Constructor.

Parameters:

listener - listener to be notified of events such as when estimation starts, ends or its progress significantly changes.

lines - 2D lines to estimate a 2D point.

Throws:

IllegalArgumentException - if provided list of lines don't have a size greater or equal than MINIMUM_SIZE.

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator(double[] qualityScores)

Constructor.

Parameters:

qualityScores - quality scores corresponding to each provided line.

Throws:

IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE (i.e. 2 lines).

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator(List<Line2D> lines,
 double[] qualityScores)

Constructor with lines.

Parameters:

lines - 2D lines to estimate a 2D point.

qualityScores - quality scores corresponding to each provided line.

Throws:

IllegalArgumentException - if provided list of lines don't have the same size as the list of provided quality scores, or it their size is not greater or equal than MINIMUM_SIZE.

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener,
 double[] qualityScores)

Constructor.

Parameters:

listener - listener to be notified of events such as when estimation starts, ends or its progress significantly changes.

qualityScores - quality scores corresponding to each provided line.

Throws:

IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE (i.e. 2 lines).

PROSACPoint2DRobustEstimator

public PROSACPoint2DRobustEstimator(Point2DRobustEstimatorListener listener,
 List<Line2D> lines,
 double[] qualityScores)

Constructor.

Parameters:

listener - listener to be notified of events such as when estimation starts, ends or its progress significantly changes.

lines - 2D lines to estimate a 2D point.

qualityScores - quality scores corresponding to each provided line.

Throws:

IllegalArgumentException - if provided list of lines don't have the same size as the list of provided quality scores, or it their size is not greater or equal than MINIMUM_SIZE.

Method Details

getThreshold

public double getThreshold()

Returns threshold to determine whether lines are inliers or not when testing possible estimation solutions. The threshold refers to the amount of error a possible solution has on a given line.

Returns:

threshold to determine whether lines are inliers or not when testing possible estimation solutions.

setThreshold

public void setThreshold(double threshold)
                  throws LockedException

Sets threshold to determine whether lines are inliers or not when testing possible estimation solutions. The threshold refers to the amount of error a possible solution has on a given line.

Parameters:

threshold - threshold to be set.

Throws:

IllegalArgumentException - if provided value is equal or less than zero.

LockedException - if robust estimator is locked because an estimation is already in progress.

getQualityScores

public double[] getQualityScores()

Returns quality scores corresponding to each provided line. The larger the score value the better the quality of the sampled line.

Overrides:

getQualityScores in class Point2DRobustEstimator

Returns:

quality scores corresponding to each line.

setQualityScores

public void setQualityScores(double[] qualityScores)
                      throws LockedException

Sets quality scores corresponding to each provided line. The larger the score value the better the quality of the sampled line.

Overrides:

setQualityScores in class Point2DRobustEstimator

Parameters:

qualityScores - quality scores corresponding to each line.

Throws:

LockedException - if robust estimator is locked because an estimation is already in progress.

IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE (i.e. 2 samples).

isReady

public boolean isReady()

Indicates if estimator is ready to start the 2D point estimation. This is true when input data (i.e. 2D lines and quality scores) are provided and a minimum of MINIMUM_SIZE points are available.

Overrides:

isReady in class Point2DRobustEstimator

Returns:

true if estimator is ready, false otherwise.

isComputeAndKeepInliersEnabled

public boolean isComputeAndKeepInliersEnabled()

Indicates whether inliers must be computed and kept.

Returns:

true if inliers must be computed and kept, false if inliers only need to be computed but not kept.

setComputeAndKeepInliersEnabled

public void setComputeAndKeepInliersEnabled(boolean computeAndKeepInliers)
                                     throws LockedException

Specifies whether inliers must be computed and kept.

Parameters:

computeAndKeepInliers - true if inliers must be computed and kept, false if inliers only need to be computed but not kept.

Throws:

LockedException - if estimator is locked.

isComputeAndKeepResidualsEnabled

public boolean isComputeAndKeepResidualsEnabled()

Indicates whether residuals must be computed and kept.

Returns:

true if residuals must be computed and kept, false if residuals only need to be computed but not kept.

setComputeAndKeepResidualsEnabled

public void setComputeAndKeepResidualsEnabled(boolean computeAndKeepResiduals)
                                       throws LockedException

Specifies whether residuals must be computed and kept.

Parameters:

computeAndKeepResiduals - true if residuals must be computed and kept, false if residuals only need to be computed but not kept.

Throws:

LockedException - if estimator is locked.

estimate

public Point2D estimate()
                 throws LockedException,
NotReadyException,
com.irurueta.numerical.robust.RobustEstimatorException

Estimates a 2D point using a robust estimator and the best set of 2D lines that intersect into the estimated 2D point.

Specified by:

estimate in class Point2DRobustEstimator

Returns:

a 2D point.

Throws:

LockedException - if robust estimator is locked because an estimation is already in progress.

NotReadyException - if provided input data is not enough to start the estimation.

com.irurueta.numerical.robust.RobustEstimatorException - if estimation fails for any reason (i.e. numerical instability, no solution available, etc).

getMethod

public com.irurueta.numerical.robust.RobustEstimatorMethod getMethod()

Returns method being used for robust estimation.

Specified by:

getMethod in class Point2DRobustEstimator

Returns:

method being used for robust estimation.

getRefinementStandardDeviation

protected double getRefinementStandardDeviation()

Gets standard deviation used for Levenberg-Marquardt fitting during refinement. Returned value gives an indication of how much variance each residual has. Typically, this value is related to the threshold used on each robust estimation, since residuals of found inliers are within the range of such threshold.

Specified by:

getRefinementStandardDeviation in class Point2DRobustEstimator

Returns:

standard deviation used for refinement.

internalSetQualityScores

private void internalSetQualityScores(double[] qualityScores)

Sets quality scores corresponding to each provided line. This method is used internally and does not check whether instance is locked or not.

Parameters:

qualityScores - quality scores to be set.

Throws:

IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE.