Update opencsp/common/lib/cv/OpticalFlow.py

Co-authored-by: Ben Bean <[email protected]>
sandialabs · Dec 11, 2024 · 5997497 · 5997497
1 parent 93ca78b
commit 5997497
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/opencsp/common/lib/cv/OpticalFlow.py b/opencsp/common/lib/cv/OpticalFlow.py
@@ -265,10 +265,10 @@ def dense(self) -> tuple[np.ndarray, np.ndarray]:
 
         Returns
         -------
-        tuple[np.ndarray, np.ndarray]
-            A tuple containing:
-            - np.ndarray: The magnitude of the flow per pixel.
-            - np.ndarray: The direction of the flow per pixel (radians, 0 to the right, positive counter-clockwise).
+        self.mag: np.ndarray
+            The magnitude of the flow per pixel (units are in pixels).
+        self.ang: np.ndarray
+            The direction of the flow per pixel (units are in radians, 0 to the right, positive counter-clockwise).
 
         Notes
         -----