Package com.irurueta.geometry.estimators

Class PROMedSMetricTransformation3DRobustEstimator

java.lang.Object
com.irurueta.geometry.estimators.MetricTransformation3DRobustEstimator
com.irurueta.geometry.estimators.PROMedSMetricTransformation3DRobustEstimator
public class PROMedSMetricTransformation3DRobustEstimator extends MetricTransformation3DRobustEstimator
Finds the best metric 3D transformation for provided collections of matched 3D point using PROMedS algorithm.

  • Field Details

    • DEFAULT_STOP_THRESHOLD

      public static final double DEFAULT_STOP_THRESHOLD
      Default 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_THRESHOLD
      Minimum allowed stop threshold value.
      See Also:

    • stopThreshold

      private double stopThreshold
      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.

    • qualityScores

      private double[] qualityScores
      Quality scores corresponding to each pair of matched points. The larger the score value the better the quality of the matching.

  • Constructor Details

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator()
      Constructor.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(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 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.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener)
      Constructor.
      Parameters:
      listener - listener to be notified of events such as when estimation starts, ends or its progress significantly changes.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(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 stars, 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.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(double[] qualityScores)
      Constructor.
      Parameters:
      qualityScores - quality scores corresponding to each pair of matched points.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE (i.e. 3 samples).

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(List<Point3D> inputPoints, List<Point3D> outputPoints, double[] qualityScores)
      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 to be used to estimate a metric 3D transformation.
      outputPoints - list of output points to be used to estimate a metric 3D transformation.
      qualityScores - quality scores corresponding to each pair of matched points.
      Throws:
      IllegalArgumentException - if provided lists of points and array of quality scores don't have the same size or their size is smaller than MINIMUM_SIZE.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener 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 pair of matched points.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE (i.e. 3 samples).

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, List<Point3D> inputPoints, List<Point3D> outputPoints, double[] qualityScores)
      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 stars, 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.
      qualityScores - quality scores corresponding to each pair of matched points.
      Throws:
      IllegalArgumentException - if provided lists of points don't have the same size or their size is smaller than MINIMUM_SIZE.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(boolean weakMinimumSizeAllowed)
      Constructor.
      Parameters:
      weakMinimumSizeAllowed - true allows 3 points, false requires 4.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(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 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.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(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.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(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 stars, 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.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(double[] qualityScores, boolean weakMinimumSizeAllowed)
      Constructor.
      Parameters:
      qualityScores - quality scores corresponding to each pair of matched points.
      weakMinimumSizeAllowed - true allows 3 points, false requires 4.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE (i.e. 3 samples).

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(List<Point3D> inputPoints, List<Point3D> outputPoints, double[] qualityScores, 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 to be used to estimate a metric 3D transformation.
      outputPoints - list of output points to be used to estimate a metric 3D transformation.
      qualityScores - quality scores corresponding to each pair of matched points.
      weakMinimumSizeAllowed - true allows 3 points, false requires 4.
      Throws:
      IllegalArgumentException - if provided lists of points and array of quality scores don't have the same size or their size is smaller than MINIMUM_SIZE.

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, double[] qualityScores, boolean weakMinimumSizeAllowed)
      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 pair of matched points.
      weakMinimumSizeAllowed - true allows 3 points, false requires 4.
      Throws:
      IllegalArgumentException - if provided quality scores length is smaller than MINIMUM_SIZE (i.e. 3 samples).

    • PROMedSMetricTransformation3DRobustEstimator

      public PROMedSMetricTransformation3DRobustEstimator(MetricTransformation3DRobustEstimatorListener listener, List<Point3D> inputPoints, List<Point3D> outputPoints, double[] qualityScores, 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 stars, 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.
      qualityScores - quality scores corresponding to each pair of matched points.
      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

    • 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. As in LMedS, the stop threshold can be used to prevent the PROMedS 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

      public void setStopThreshold(double stopThreshold) throws LockedException
      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. As in LMedS, the stop threshold can be used to prevent the PROMedS 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.

    • getQualityScores

      public double[] getQualityScores()
      Returns quality scores corresponding to each pair of matched points. The larger the score value the better the quality of the matching.
      Overrides:
      getQualityScores in class MetricTransformation3DRobustEstimator
      Returns:
      quality scores corresponding to each pair of matched points.

    • setQualityScores

      public void setQualityScores(double[] qualityScores) throws LockedException
      Sets quality scores corresponding to each pair of matched points. The larger the score value the better the quality of the matching.
      Overrides:
      setQualityScores in class MetricTransformation3DRobustEstimator
      Parameters:
      qualityScores - quality scores corresponding to each pair of matched points.
      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. 3 samples).

    • isReady

      public boolean isReady()
      Indicates if estimator is ready to start the metric 3D transformation estimation. This is true when input data (i.e. lists of matched points and quality scores) are provided and a minimum of MINIMUM_SIZE points are available.
      Overrides:
      isReady in class MetricTransformation3DRobustEstimator
      Returns:
      true if estimator is ready, false otherwise.

    • estimate

      public MetricTransformation3D estimate() throws LockedException, NotReadyException, com.irurueta.numerical.robust.RobustEstimatorException
      Estimates a metric 3D transformation using a robust estimator and the best set of matched 3D point correspondences found using the robust estimator.
      Specified by:
      estimate in class MetricTransformation3DRobustEstimator
      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:
      getMethod in class MetricTransformation3DRobustEstimator
      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 MetricTransformation3DRobustEstimator
      Returns:
      standard deviation used for refinement.

    • internalSetQualityScores

      private void internalSetQualityScores(double[] qualityScores)
      Sets quality scores corresponding to each pair of matched points. 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.