Update javadocs

PhotonVision · Nov 22, 2023 · 6d27db0 · 6d27db0
1 parent b542dcd
commit 6d27db0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/photon-targeting/src/main/java/org/photonvision/targeting/PhotonTrackedTarget.java b/photon-targeting/src/main/java/org/photonvision/targeting/PhotonTrackedTarget.java
@@ -97,8 +97,9 @@ public int getFiducialId() {
     }
 
     /**
-     * Get the ratio of pose reprojection errors, called ambiguity. Numbers above 0.2 are likely to be
-     * ambiguous. -1 if invalid.
+     * Get the ratio of best:alternate pose reprojection errors, called ambiguity. This is betweeen 0
+     * and 1 (0 being no ambiguity, and 1 meaning both have the same reprojection error). Numbers
+     * above 0.2 are likely to be ambiguous. -1 if invalid.
      */
     public double getPoseAmbiguity() {
         return poseAmbiguity;

diff --git a/photon-targeting/src/main/native/include/photon/targeting/PhotonTrackedTarget.h b/photon-targeting/src/main/native/include/photon/targeting/PhotonTrackedTarget.h
@@ -112,8 +112,10 @@ class PhotonTrackedTarget {
   }
 
   /**
-   * Get the ratio of pose reprojection errors, called ambiguity. Numbers above
-   * 0.2 are likely to be ambiguous. -1 if invalid.
+   * Get the ratio of best:alternate pose reprojection errors, called ambiguity.
+   * This is betweeen 0 and 1 (0 being no ambiguity, and 1 meaning both have the
+   * same reprojection error). Numbers above 0.2 are likely to be ambiguous. -1
+   * if invalid.
    */
   double GetPoseAmbiguity() const { return poseAmbiguity; }