Fixes camera MDP term name and reprojection docstrings #1130
+202
−144
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mayankm96
requested review from
Dhoeller19,
jsmith-bdai,
jtigue-bdai and
kellyguo11
as code owners
glvov-bdai
reviewed
Oct 3, 2024
| @@ -988,12 +988,7 @@ def transform_points( | |||
|
|
|||
| @torch.jit.script | |||
| def unproject_depth(depth: torch.Tensor, intrinsics: torch.Tensor) -> torch.Tensor: | |||
There was a problem hiding this comment.
Although it mentions in the doc string that depth here should be orthogonal maybe good to also mention it in the method name like unproject_orthogonal_depth as I feel like the doc string comment could be missed
There was a problem hiding this comment.
I added a parameter to the function which user can set as True/False for orthogonal/perspective depth image respectively. This is probably less breaking.
jtigue-bdai
approved these changes
Oct 3, 2024
Mayankm96
commented
Oct 4, 2024
Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
… into fix/docs-camera-funcs
iamdrfly
pushed a commit
to iamdrfly/IsaacLab
that referenced
this pull request
Nov 21, 2024
# Description For all observation-related terms, we follow the noun name for the function. However, the camera one was called `grab_images`. This MR renames it to `image` to make it consistent with the others. Also the docstring for the math-utils were messed up. According to Google's docstyle, the first line should be a short summary and a detailed summary should move to the next paragraph. This MR fixes that as well. Lastly, the name of the function `convert_perspective_depth_to_orthoginal_depth` has too much redundancy. The MR renames it to `orthogonalize_perpsective_depth`. All these are breaking changes with no backwards compatibility (since they were added post-last release anyway). ## Type of change - Breaking change (fix or feature that would cause existing functionality to not work as expected) - This change requires a documentation update ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
For all observation-related terms, we follow the noun name for the function. However, the camera one was called
grab_images. This MR renames it toimageto make it consistent with the others.Also the docstring for the math-utils were messed up. According to Google's docstyle, the first line should be a short summary and a detailed summary should move to the next paragraph. This MR fixes that as well.
Lastly, the name of the function
convert_perspective_depth_to_orthoginal_depthhas too much redundancy. The MR renames it toorthogonalize_perpsective_depth.All these are breaking changes with no backwards compatibility (since they were added post-last release anyway).
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there