OmniIsaacGymEnvs icon indicating copy to clipboard operation
OmniIsaacGymEnvs copied to clipboard

Need comments to understand magic numbers

Open Pipe-Runner opened this issue 1 year ago • 2 comments

I understand this is not an issue, but using cryptic code and magic numbers without documentation or comments makes it very hard to modify the tasks. I maybe over stepping there since perhaps I am the one who is unable to figure the code out. So feel free to point me in the right direction if that happens to be the case.

In Franka Cabinet, in init_data, what exactly is this magic number array and how am I supposed to find it for a different scenario? https://github.com/NVIDIA-Omniverse/OmniIsaacGymEnvs/blob/8cf773ab6cac0c8e0d55f46d6d7d258e781c6458/omniisaacgymenvs/tasks/franka_cabinet.py#L228 Obviously the first 3 are xyz and the last 4 are wzyz, but how was this array found? How does it fit into the following:

global_drawer_rot, global_drawer_pos = tf_combine(
    drawer_rot, drawer_pos, drawer_local_grasp_rot, drawer_local_grasp_pos
)

Also, is there any documentation that explains the implementation?

Pipe-Runner avatar Nov 07 '23 15:11 Pipe-Runner

Okay, I may have just figured it out. Notice the parent of the cylinder and the transformations applied on the cylinder. image Those magic numbers are the local transform of the grasp position you would want the robot to have. Since this is a relative transform, every time observation is computed, you combine it with the transformation of the drawer itself so this pose keeps moving with the drawer, and the robot tries to reduce the distance between its grasp and this desired grasp position. If I can translate this video, I will probably help document the code with the maths.

This video explains it further, but it is in Korean.

Pipe-Runner avatar Nov 09 '23 00:11 Pipe-Runner

Hi there, you are correct on the explanation of the drawer_local_grasp_pose values. We will try to provide better documentation/commenting for the examples.

kellyguo11 avatar Nov 09 '23 15:11 kellyguo11