added minz viewer description to readme#15148
Conversation
There was a problem hiding this comment.
Pull request overview
Adds documentation to the enhanced-depth-range example README explaining how to enable and use the Min-Z Improvement post-processing filter in RealSense Viewer.
Changes:
- Added a Table of Contents entry for the new RealSense Viewer Min-Z filter section
- Documented build/runtime prerequisites and stream configuration needed for the Min-Z toggle to be available in the Viewer
| When the viewer is built with `-DBUILD_WITH_MINZ=ON` and the | ||
| `librealsense2-enhanced-depth` package is installed, a Min-Z Improvement toggle appears in the Post-Processing panel for depth sensors. Enable Depth, IR Left, and IR Right streams at 640×480 or higher, then switch | ||
| the toggle on — the filter runs automatically before decimation on every frameset. The toggle is greyed out if the library is not found at runtime, CUDA is unavailable, or the required streams are not | ||
| active. |
Nir-Az
left a comment
Nir-Az
left a comment
There was a problem hiding this comment.
Automated Code Review by rs-agentic bot
This PR changes two files:
examples/enhanced-depth-range/README.md— adds a MinZ viewer section ✅unit-tests/requirements.txt— downgradesbrainstem(unrelated to the PR description)⚠️
Please see inline comments below for details.
|
|
||
| # Acroname hub (not used on Jetson/aarch64) | ||
| brainstem==2.12.4; platform_machine != "aarch64" | ||
| brainstem==2.11.1; platform_machine != "aarch64" |
There was a problem hiding this comment.
This PR is described as "added minz viewer description to readme", yet it also downgrades brainstem from 2.12.4 → 2.11.1. This is a hidden, unrelated change that:
- Has no explanation — no comment, no PR description mention.
- Is a regression — downgrading a dependency loses bug-fixes and improvements shipped in
2.12.4. - Could break CI on machines where Acroname hub tests rely on a
2.12.x-only API.
Please either:
- Revert this line if it was accidental (e.g. a merge/lock-file conflict), or
- Open a separate PR for the version change with a clear rationale.
|
|
||
| - [What's Included](#whats-included) | ||
| - [Installation](#installation) | ||
| - [RealSense Viewer — Min-Z Post-Processing Filter](#realsense-viewer--min-z-post-processing-filter) |
There was a problem hiding this comment.
💡 [rs-agentic bot] Enhancement — TOC anchor may be fragile with the em dash
GitHub's anchor generator strips most Unicode punctuation. The em dash — in RealSense Viewer — Min-Z Post-Processing Filter is removed during anchor generation, producing realsense-viewer--min-z-post-processing-filter (double hyphen). This happens to match the TOC link today on GitHub, but behaviour differs across other Markdown renderers (GitLab, MkDocs, Pandoc).
Consider using a plain colon or hyphen to make the anchor portable and predictable:
## RealSense Viewer: Min-Z Post-Processing FilterMatching TOC entry:
- [RealSense Viewer: Min-Z Post-Processing Filter](#realsense-viewer-min-z-post-processing-filter)|
|
||
| When the viewer is built with `-DBUILD_WITH_MINZ=ON` and the | ||
| `librealsense2-enhanced-depth` package is installed, a Min-Z Improvement toggle appears in the Post-Processing panel for depth sensors. Enable Depth, IR Left, and IR Right streams at 640×480 or higher, then switch | ||
| the toggle on — the filter runs automatically before decimation on every frameset. The toggle is greyed out if the library is not found at runtime, CUDA is unavailable, or the required streams are not |
There was a problem hiding this comment.
🐛 [rs-agentic bot] Readability — inconsistent mid-sentence line wrapping
The paragraph has awkward mid-sentence hard-wraps inconsistent with the rest of the document style. For example, switch is orphaned at the end of a line while its continuation the toggle on begins the next:
...at 640×480 or higher, then switch
the toggle on — the filter runs...
Suggest reflowing to break at sentence boundaries:
When the viewer is built with `-DBUILD_WITH_MINZ=ON` and the
`librealsense2-enhanced-depth` package is installed, a **Min-Z Improvement** toggle
appears in the Post-Processing panel for depth sensors.
Enable Depth, IR Left, and IR Right streams at 640×480 or higher, then switch the
toggle on — the filter runs automatically before decimation on every frameset.
The toggle is greyed out if the library is not found at runtime, CUDA is
unavailable, or the required streams are not active.| When the viewer is built with `-DBUILD_WITH_MINZ=ON` and the | ||
| `librealsense2-enhanced-depth` package is installed, a Min-Z Improvement toggle appears in the Post-Processing panel for depth sensors. Enable Depth, IR Left, and IR Right streams at 640×480 or higher, then switch | ||
| the toggle on — the filter runs automatically before decimation on every frameset. The toggle is greyed out if the library is not found at runtime, CUDA is unavailable, or the required streams are not | ||
| active. |
There was a problem hiding this comment.
💡 [rs-agentic bot] Enhancement — clarify CUDA platform dependency
The text states the toggle is greyed out when "CUDA is unavailable". This implies CUDA is a hard runtime requirement. However, the project supports platforms where CUDA may not exist at all (macOS, Raspberry Pi, Android, CPU-only Linux).
Please clarify:
- If the filter has no CPU fallback, add a note such as: "(no CPU fallback — a CUDA-capable GPU is required)".
- If a CPU fallback exists, remove CUDA from the greyed-out conditions and update this sentence.
Without this clarification, users on non-CUDA hardware may not understand why the toggle is permanently disabled for them.
… minz viewer description to readme to 2.58.2
added minz viewer description to readme of Min-Z Improvement library.