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

volume_loader configuration file documentation updates #302

Closed
tbirdso opened this issue May 3, 2024 · 0 comments · Fixed by #304
Closed

volume_loader configuration file documentation updates #302

tbirdso opened this issue May 3, 2024 · 0 comments · Fixed by #304
Assignees

Comments

@tbirdso
Copy link
Contributor

tbirdso commented May 3, 2024

Overview

We've received a request for additional documentation and clarity around how configuration files can be formed for the XR Volume Rendering application.

Detailed Summary

HoloHub does not currently offer clear documentation for how to create or update a configuration file for volume rendering. JSON config files are used by both the volume_rendering and volume_rendering_xr applications. Config files are ingested by the volume_loader operator.

It would be good to understand how users can write new files setting:

  • camera parameters
  • Volume transfer functions
  • Lighting
  • Other rendering settings

Projects to consider:

  • ClaraViz: underlying volume rendering project
  • volume_renderer: wraps ClaraViz as a Holoscan operator
  • volume_loader: Loads JSON config file
  • volume_rendering / volume_rendering_xr applications: Provide custom config files (either in git tracking or data download at build time) for volume rendering

Additional Notes

Related to NVIDIA/clara-viz#47 requesting additional documentation on settings available in the underlying ClaraViz project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants