Skip to content

Commit

Permalink
Improve hand-eye transform documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SatjaSivcev committed Aug 2, 2024
1 parent 5a093a2 commit 158ed5e
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions modules/zivid/_calibration/hand_eye.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,12 @@ def __str__(self):


class HandEyeOutput:
"""Class representing the result of a hand-eye calibration process."""
"""Class representing the result of a hand-eye calibration process.
For eye-in-hand, the computed pose represents camera pose in robot end-effector frame.
For eye-to-hand, the computed pose represents camera pose in robot base frame.
"""

def __init__(self, impl):
"""Initialize HandEyeOutput wrapper.
Expand Down Expand Up @@ -146,6 +151,8 @@ def transform(self):
Returns:
A 4x4 array representing a hand-eye transform
eye-in-hand: camera pose in robot end-effector frame
eye-to-hand: camera pose in robot base frame
"""
return self.__impl.transform()

Expand All @@ -171,7 +178,7 @@ def calibrate_eye_in_hand(calibration_inputs):
calibration_inputs: List of HandEyeInput
Returns:
A HandEyeOutput instance containing the eye-in-hand transform
A HandEyeOutput instance containing the eye-in-hand transform (camera pose in robot end-effector frame)
"""
return HandEyeOutput(
_zivid.calibration.calibrate_eye_in_hand(
Expand All @@ -190,7 +197,7 @@ def calibrate_eye_to_hand(calibration_inputs):
calibration_inputs: List of HandEyeInput
Returns:
A HandEyeOutput instance containing the eye-to-hand transform
A HandEyeOutput instance containing the eye-to-hand transform (camera pose in robot base frame)
"""
return HandEyeOutput(
_zivid.calibration.calibrate_eye_to_hand(
Expand Down

0 comments on commit 158ed5e

Please sign in to comment.