Skip to content

Point root_height_below_minimum users to the terrain-aware termination - #8974

Open
blessedefe4real wants to merge 1 commit into
isaac-sim:mainfrom
blessedefe4real:docs/root-height-rough-terrain
Open

blessedefe4real wants to merge 1 commit into
isaac-sim:mainfrom
blessedefe4real:docs/root-height-rough-terrain

Conversation

@blessedefe4real

Copy link
Copy Markdown

Description

root_height_below_minimum compares the root height with a world-frame threshold, so it terminates robots standing normally on stairs or in pits (#3986). The terrain-aware alternative, pelvis_below_terrain_clearance, now exists in isaaclab.envs.mdp.terminations but was not referenced from it and had a one-line docstring.

This points users of root_height_below_minimum to pelvis_below_terrain_clearance and documents how the latter estimates the ground: the median of the height scanner's ray hits, which keeps a few rays that hit a nearby wall from shifting the estimate (the concern raised in the review of #3987), with missed rays counted as height zero.

Fixes #3986

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added a changelog fragment (.skip, docstring-only change)
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

root_height_below_minimum compares the root height against a world-frame
threshold, so it terminates robots that are standing normally on stairs or
in pits. The terrain-aware alternative, pelvis_below_terrain_clearance,
already exists but was not referenced from it and had a one-line
docstring.

Reference pelvis_below_terrain_clearance from the flat-terrain note and
document how it estimates the ground height from a ray-cast height
scanner, including why it uses the median of the ray hits and how missed
rays are treated.

Fixes isaac-sim#3986
@blessedefe4real
blessedefe4real requested a review from a team November 8, 2026 01:34
@github-actions github-actions Bot added the isaac-lab Related to Isaac Lab team label Nov 8, 2026
@greptile-apps

greptile-apps Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This documentation-only PR appears safe to merge.

Summary

This documentation-only change points users of root_height_below_minimum to pelvis_below_terrain_clearance for rough terrain.

  • Termination docs point rough-terrain users to scanner-based clearance.

No actionable issues found.

Reviews (1) · Last reviewed commit: "Point root_height_below_minimum users to..." · Reviewed by Greptile

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Isaac Lab Review Bot

All reviewed code categories look good.

  • PR description: Replace “Fixes #3986” with “Refs #3986”; the diff documents an alternative but does not change the reported world-frame termination behavior, and no performance evidence is needed.
  • Design and architecture: Architecture looks good.
  • Scope and over-engineering: No over-engineering issues.
  • API: API changes look good.
  • Compatibility and deprecation: No breaking changes identified.
  • Implementation: Implementation looks good.
  • Style consistency: Style consistency looks good.
  • Test quality: Test quality looks good.

No blocking issues. No inline findings.

Automated review; human maintainers own approval decisions.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

isaac-lab Related to Isaac Lab team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug Report] root_height_below_minimum is not supported for rough terrain

1 participant