Package com.irurueta.geometry.estimators
Class LMedSLine2DRobustEstimator
java.lang.Object
com.irurueta.geometry.estimators.Line2DRobustEstimator
com.irurueta.geometry.estimators.LMedSLine2DRobustEstimator
Finds the best 2D line for provided collection of 2D points using LMedS
algorithm.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final doubleDefault value to be used for stop threshold.static final doubleMinimum allowed stop threshold value.private doubleThreshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough.Fields inherited from class com.irurueta.geometry.estimators.Line2DRobustEstimator
confidence, DEFAULT_CONFIDENCE, DEFAULT_MAX_ITERATIONS, DEFAULT_PROGRESS_DELTA, DEFAULT_ROBUST_METHOD, listener, locked, MAX_CONFIDENCE, MAX_PROGRESS_DELTA, maxIterations, MIN_CONFIDENCE, MIN_ITERATIONS, MIN_PROGRESS_DELTA, MINIMUM_SIZE, points, progressDelta -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.Constructor.LMedSLine2DRobustEstimator(Line2DRobustEstimatorListener listener, List<Point2D> points) Constructor.LMedSLine2DRobustEstimator(List<Point2D> points) Constructor with points. -
Method Summary
Modifier and TypeMethodDescriptionestimate()Estimates a 2D line using a robust estimator and the best set of 2D points that pass through the estimated 2D line (i.e. belong to its locus).com.irurueta.numerical.robust.RobustEstimatorMethodReturns method being used for robust estimation.doubleReturns threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough.voidsetStopThreshold(double stopThreshold) Sets threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough.Methods inherited from class com.irurueta.geometry.estimators.Line2DRobustEstimator
create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, getConfidence, getListener, getMaxIterations, getPoints, getProgressDelta, getQualityScores, isListenerAvailable, isLocked, isReady, residual, setConfidence, setListener, setMaxIterations, setPoints, setProgressDelta, setQualityScores
-
Field Details
-
DEFAULT_STOP_THRESHOLD
public static final double DEFAULT_STOP_THRESHOLDDefault value to be used for stop threshold. Stop threshold can be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm iterating too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results.- See Also:
-
MIN_STOP_THRESHOLD
public static final double MIN_STOP_THRESHOLDMinimum allowed stop threshold value.- See Also:
-
stopThreshold
private double stopThresholdThreshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm iterating too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results.
-
-
Constructor Details
-
LMedSLine2DRobustEstimator
public LMedSLine2DRobustEstimator()Constructor. -
LMedSLine2DRobustEstimator
Constructor with points.- Parameters:
points- 2D points to estimate a 2D line.- Throws:
IllegalArgumentException- if provided list of points doesn't have a size greater or equal than MINIMUM_SIZE.
-
LMedSLine2DRobustEstimator
Constructor.- Parameters:
listener- listener to be notified of events such as when estimation starts, ends or its progress significantly changes.
-
LMedSLine2DRobustEstimator
Constructor.- Parameters:
listener- listener to be notified of events such as when estimation starts, ends or its progress significantly changes.points- 2D points to estimate a 2D line.- Throws:
IllegalArgumentException- if provided list of points doesn't have a size greater or equal than MINIMUM_SIZE.
-
-
Method Details
-
getStopThreshold
public double getStopThreshold()Returns threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm iterating too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results.- Returns:
- stop threshold to stop the algorithm prematurely when a certain accuracy has been reached.
-
setStopThreshold
Sets threshold to be used to keep the algorithm iterating in case that best estimated threshold using median of residuals is not small enough. Once a solution is found that generates a threshold below this value, the algorithm will stop. The stop threshold can be used to prevent the LMedS algorithm iterating too many times in cases where samples have a very similar accuracy. For instance, in cases where proportion of outliers is very small (close to 0%), and samples are very accurate (i.e. 1e-6), the algorithm would iterate for a long time trying to find the best solution when indeed there is no need to do that if a reasonable threshold has already been reached. Because of this behaviour the stop threshold can be set to a value much lower than the one typically used in RANSAC, and yet the algorithm could still produce even smaller thresholds in estimated results.- Parameters:
stopThreshold- stop threshold to stop the algorithm prematurely when a certain accuracy has been reached.- Throws:
IllegalArgumentException- if provided value is zero or negative.LockedException- if robust estimator is locked because an estimation is already in progress.
-
estimate
public Line2D estimate() throws LockedException, NotReadyException, com.irurueta.numerical.robust.RobustEstimatorExceptionEstimates a 2D line using a robust estimator and the best set of 2D points that pass through the estimated 2D line (i.e. belong to its locus).- Specified by:
estimatein classLine2DRobustEstimator- Returns:
- a 2D line.
- 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:
getMethodin classLine2DRobustEstimator- Returns:
- method being used for robust estimation.
-