Package com.irurueta.geometry.estimators
Class MSACMetricTransformation3DRobustEstimator
java.lang.Object
com.irurueta.geometry.estimators.MetricTransformation3DRobustEstimator
com.irurueta.geometry.estimators.MSACMetricTransformation3DRobustEstimator
public class MSACMetricTransformation3DRobustEstimator
extends MetricTransformation3DRobustEstimator
Finds the best metric 3D transformation for provided collections of
matched 3D points using MSAC algorithm.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final doubleConstant defining default threshold to determine whether points are inliers or not.static final doubleMinimum value that can be set as threshold.private doubleThreshold to determine whether points are inliers or not when testing possible estimation solutions.Fields inherited from class com.irurueta.geometry.estimators.MetricTransformation3DRobustEstimator
confidence, DEFAULT_CONFIDENCE, DEFAULT_KEEP_COVARIANCE, DEFAULT_MAX_ITERATIONS, DEFAULT_PROGRESS_DELTA, DEFAULT_REFINE_RESULT, DEFAULT_ROBUST_METHOD, inliersData, inputPoints, listener, locked, MAX_CONFIDENCE, MAX_PROGRESS_DELTA, maxIterations, MIN_CONFIDENCE, MIN_ITERATIONS, MIN_PROGRESS_DELTA, MINIMUM_SIZE, outputPoints, progressDelta, refineResult, WEAK_MINIMUM_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.MSACMetricTransformation3DRobustEstimator(boolean weakMinimumSizeAllowed) Constructor.Constructor.MSACMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, boolean weakMinimumSizeAllowed) Constructor.MSACMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, List<Point3D> inputPoints, List<Point3D> outputPoints) Constructor with listener and lists of points to be used to estimate a metric 3D transformation.MSACMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, List<Point3D> inputPoints, List<Point3D> outputPoints, boolean weakMinimumSizeAllowed) Constructor with listener and lists of points to be used to estimate a metric 3D transformation.MSACMetricTransformation3DRobustEstimator(List<Point3D> inputPoints, List<Point3D> outputPoints) Constructor with lists of points to be used to estimate a metric 3D transformation.MSACMetricTransformation3DRobustEstimator(List<Point3D> inputPoints, List<Point3D> outputPoints, boolean weakMinimumSizeAllowed) Constructor with lists of points to be used to estimate a metric 3D transformation. -
Method Summary
Modifier and TypeMethodDescriptionestimate()Estimates a metric 3D transformation using a robust estimator and the best set of matched 3D point correspondences found using the robust estimator.com.irurueta.numerical.robust.RobustEstimatorMethodReturns method being used for robust estimation.protected doubleGets standard deviation used for Levenberg-Marquardt fitting during refinement.doubleReturns threshold to determine whether points are inliers or not when testing possible estimation solutions.voidsetThreshold(double threshold) Sets threshold to determine whether points are inliers or not when testing possible estimation solutions.Methods inherited from class com.irurueta.geometry.estimators.MetricTransformation3DRobustEstimator
attemptRefine, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, getConfidence, getCovariance, getInliersData, getInputPoints, getListener, getMaxIterations, getMinimumPoints, getOutputPoints, getProgressDelta, getQualityScores, isCovarianceKept, isListenerAvailable, isLocked, isReady, isResultRefined, isWeakMinimumSizeAllowed, setConfidence, setCovarianceKept, setListener, setMaxIterations, setPoints, setProgressDelta, setQualityScores, setResultRefined, setWeakMinimumSizeAllowed
-
Field Details
-
DEFAULT_THRESHOLD
public static final double DEFAULT_THRESHOLDConstant defining default threshold to determine whether points are inliers or not. By default, 1.0 is considered a good value for cases where measures are done on pixels, since typically the minimum resolution is 1 pixel.- See Also:
-
MIN_THRESHOLD
public static final double MIN_THRESHOLDMinimum value that can be set as threshold. Threshold must be strictly greater than 0.0.- See Also:
-
threshold
private double thresholdThreshold to determine whether points 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 matched pair of points.
-
-
Constructor Details
-
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator()Constructor. -
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator(List<Point3D> inputPoints, List<Point3D> outputPoints) Constructor with lists of points to be used to estimate a metric 3D transformation. Points in the list located at the same position are considered to be matched. Hence, both lists must have the same size, and their size must be greater or equal than MINIMUM_SIZE.- Parameters:
inputPoints- list of input points ot be used to estimate a metric 3D transformation.outputPoints- list of output points to be used to estimate a metric 3D transformation.- Throws:
IllegalArgumentException- if provided lists of points don't have the same size or their size is smaller than MINIMUM_SIZE.
-
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener) Constructor.- Parameters:
listener- listener to be notified of events such as when estimation starts, ends or its progress significantly changes.
-
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, List<Point3D> inputPoints, List<Point3D> outputPoints) Constructor with listener and lists of points to be used to estimate a metric 3D transformation. Points in the list located at the same position are considered to be matched. Hence, both lists must have the same size, and their size must be greater or equal than MINIMUM_SIZE.- Parameters:
listener- listener to be notified of events such as when estimation starts, ends or its progress significantly changes.inputPoints- list of input points to be used to estimate a metric 3D transformation.outputPoints- list of output points to be used to estimate a metric 3D transformation.- Throws:
IllegalArgumentException- if provided lists of points don't have the same size or their size is smaller than MINIMUM_SIZE.
-
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator(boolean weakMinimumSizeAllowed) Constructor.- Parameters:
weakMinimumSizeAllowed- true allows 3 points, false requires 4.
-
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator(List<Point3D> inputPoints, List<Point3D> outputPoints, boolean weakMinimumSizeAllowed) Constructor with lists of points to be used to estimate a metric 3D transformation. Points in the list located at the same position are considered to be matched. Hence, both lists must have the same size, and their size must be greater or equal than MINIMUM_SIZE.- Parameters:
inputPoints- list of input points ot be used to estimate a metric 3D transformation.outputPoints- list of output points to be used to estimate a metric 3D transformation.weakMinimumSizeAllowed- true allows 3 points, false requires 4.- Throws:
IllegalArgumentException- if provided lists of points don't have the same size or their size is smaller than MINIMUM_SIZE.
-
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, boolean weakMinimumSizeAllowed) Constructor.- Parameters:
listener- listener to be notified of events such as when estimation starts, ends or its progress significantly changes.weakMinimumSizeAllowed- true allows 3 points, false requires 4.
-
MSACMetricTransformation3DRobustEstimator
public MSACMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, List<Point3D> inputPoints, List<Point3D> outputPoints, boolean weakMinimumSizeAllowed) Constructor with listener and lists of points to be used to estimate a metric 3D transformation. Points in the list located at the same position are considered to be matched. Hence, both lists must have the same size, and their size must be greater or equal than MINIMUM_SIZE.- Parameters:
listener- listener to be notified of events such as when estimation starts, ends or its progress significantly changes.inputPoints- list of input points to be used to estimate a metric 3D transformation.outputPoints- list of output points to be used to estimate a metric 3D transformation.weakMinimumSizeAllowed- true allows 3 points, false requires 4.- Throws:
IllegalArgumentException- if provided lists of points don't have the same size or their size is smaller than MINIMUM_SIZE.
-
-
Method Details
-
getThreshold
public double getThreshold()Returns threshold to determine whether points are inliers or not when testing possible estimation solutions. The threshold refers to the amount of error (i.e. Euclidean distance) a possible solution has on a matched pair of points.- Returns:
- threshold to determine whether points are inliers or not when testing possible estimation solutions.
-
setThreshold
Sets threshold to determine whether points are inliers or not when testing possible estimation solutions. The threshold refers to the amount of error (i.e. Euclidean distance) a possible solution has on a matched pair of points.- Parameters:
threshold- threshold to determine whether points are inliers or not.- Throws:
IllegalArgumentException- if provided value is equal or less than zero.LockedException- if robust estimator is locked because an estimation is already in progress.
-
estimate
public MetricTransformation3D estimate() throws LockedException, NotReadyException, com.irurueta.numerical.robust.RobustEstimatorExceptionEstimates a metric 3D transformation using a robust estimator and the best set of matched 3D point correspondences found using the robust estimator.- Specified by:
estimatein classMetricTransformation3DRobustEstimator- Returns:
- a metric 3D transformation.
- 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 classMetricTransformation3DRobustEstimator- 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:
getRefinementStandardDeviationin classMetricTransformation3DRobustEstimator- Returns:
- standard deviation used for refinement.
-