Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds option to change the clipping behavior for all Cameras and unifies the default #891

Merged
merged 44 commits into from
Dec 7, 2024

Conversation

pascal-roth
Copy link
Collaborator

@pascal-roth pascal-roth commented Aug 28, 2024

Description

This PR adds an option to define the clipping behavior for depth images generated by RayCasterCamera and Camera. In addition, it unifies the clipping behavior for the depth images of all camera implementations. Per default, all values exceeding the range are clipped to zero for both distance_to_image_plane and distance_to_camera depth images. Prev. RayCasterCamera clipped the values to the maximum value of the depth image, Camera did not clip them and had a different behavior for both types, and TiledCamera clipped the values to zero.

Needs PR #617 to be merged

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • 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
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@pascal-roth pascal-roth added bug Something isn't working enhancement New feature or request labels Aug 28, 2024
@pascal-roth pascal-roth self-assigned this Aug 28, 2024
Copy link
Collaborator

@jsmith-bdai jsmith-bdai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just prefer more explicit naming of the clipping param

@pascal-roth
Copy link
Collaborator Author

@Mayankm96 added test for all the other depth clipping formats, should be good to go now

@pascal-roth
Copy link
Collaborator Author

@Mayankm96 quick ping, can we get that merged?

@kellyguo11 kellyguo11 merged commit a8d2bca into main Dec 7, 2024
5 checks passed
@kellyguo11 kellyguo11 deleted the fix/cam-clipping branch December 7, 2024 02:38
kellyguo11 added a commit that referenced this pull request Dec 18, 2024
# Description

In #891, the
`depth_clipping_behavior` parameter was added with the default mode set
to `"zero"`. This introduced a breaking behavior in the depth cameras as
previously, values returned by the cameras were not clipped. This PR
sets the default behavior to `"none"`, which should bring us back to the
original camera behavior.

## Type of change

<!-- As you go through the list, delete the ones that are not
applicable. -->

- Bug fix (non-breaking change which fixes an issue)

## Checklist

- [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with
`./isaaclab.sh --format`
- [ ] 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
- [x] I have updated the changelog and the corresponding version in the
extension's `config/extension.toml` file
- [ ] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there

<!--
As you go through the checklist above, you can mark something as done by
putting an x character in it

For example,
- [x] I have done this task
- [ ] I have not done this task
-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dev team Issue or pull request created by the dev team enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants