# Quick Start
## Installation
This will install all Clara Viz packages use pip:
```bash
$ pip install clara-viz
```
Clara Viz is using namespace packages. The main functionality is implemented in the 'clara-viz-core' package,
Jupyter Notebook widgets are found in the 'clara-viz-widgets' package.
So for example if you just need the renderer use
```bash
$ pip install clara-viz-core
```
## Use interactive widget in Jupyter Notebook
Install the Jupyter notebook widgets.
```bash
$ pip install clara-viz-widgets
```
Start Jupyter Lab, open the notebooks in the `notebooks` folder. Make sure Git LFS is installed when cloning the repo, else the data files are not downloaded correctly and you will see file open errors when using the example notebooks.
```python
from clara.viz.widgets import Widget
from clara.viz.core import Renderer
import numpy as np
# load a RAW CT data file (volume is 512x256x256 voxels)
input = np.fromfile("CT.raw", dtype=np.int16)
input = input.reshape((512, 256, 256))
display(Widget(Renderer(input)))
```
## Render CT data from Python
```python
from PIL import Image
import clara.viz.core
import numpy as np
# load a RAW CT data file (volume is 512x256x256 voxels)
input = np.fromfile("CT.raw", dtype=np.int16)
input = input.reshape((512, 256, 256))
# create the renderer
renderer = clara.viz.core.Renderer(input)
# render to a raw numpy array
output = renderer.render_image(1024, 768, image_type=clara.viz.core.ColorImageType.RAW_RGBA_U8)
rgb_data = np.asarray(output)[:, :, :3]
# show with PIL
image = Image.fromarray(rgb_data)
image.show()
```
# clara-viz 0.4.0 (April 10 2024)
## Features
* Add Python and pybind11 source code
* Add support for Python 3.10 and 3.11 packages and set Python wheel requirement to fail installation on unsupported Python versions
## Bug Fixes
* Add missing <thread> include to DataSourceUS.cpp ([32](https://github.com/NVIDIA/clara-viz/pull/32)) [@thewtex](https://github.com/thewtex)
* Upgrade almalinux-release in Docker build for GPG keys ([31](https://github.com/NVIDIA/clara-viz/pull/32)) [@thewtex](https://github.com/thewtex)
* Gracefully disable OptiX and NvENC features if initialization fails.
* Python: Fix segfault when accessing RGBA data of rendered image ([33](https://github.com/NVIDIA/clara-viz/issues/33)) [@thewtex](https://github.com/thewtex)
# clara-viz 0.3.2 (November 27 2023)
## Features
* Support camera pose for non-stereo cases as well
## Bug Fixes
* Fix cmake warnings and consolidate cmake_minimum_required() usage
* Fix compile warning in NvEnvService.cpp
# clara-viz 0.3.1 (July 12 2023)
## Bug Fixes
* Gracefully disable OptiX denoiser if it can't be created
* make nvjpeg support optional
# clara-viz 0.3.0 (June 22 2023)
## Features
* C++ interface is now public
* Add support for aarch64 (not for Python wheels)
* Add support for VR/AR rendering
+ Camera has stereo mode and left end right eye poses, tangents and gaze directions
+ Add warped and foveated rendering
+ Add reprojection
* Add support for separate depth buffer
* Add support for alpha channel
* Add support for near and far depth plane
* Add support for transforming the volume using a matrix
## Bug Fixes
* Fix tonemap enable, had no effect before (always enabled).
* AttributeError: module 'itk' has no attribute 'itkSpatialOrientationPython' (https://github.com/NVIDIA/clara-viz/issues/26)
## Security
* Update Jupyter widget Java code packages to fix vulnerability CVE-2022-46175
# clara-viz 0.2.2 (October 17 2022)
## Bug Fixes
* Jupyter notebooks fail with AttributeError: 'Widget' object has no attribute 'on_displayed' (https://github.com/NVIDIA/clara-viz/issues/23)
## Security
* Update Jupyter widget Java code packages to fix vulnerabilities
## Documentation
* pip install fails on Windows machines (https://github.com/NVIDIA/clara-viz/issues/22)
* Windows is not supported, added a section on supported OS to readme
# clara-viz 0.2.1 (March 29 2022)
## Bug Fixes
* Widget can't be displayed because of version mismatch
# clara-viz 0.2.0 (March 29 2022)
## Features
* Add support for rendering multi resolution images used in digital pathology
## Security
* Update Jupyter widget Java code packages to fix vulnerabilities
## Bug Fixes
* Error when using a widget with a renderer using a numpy array (https://github.com/NVIDIA/clara-viz/issues/18)
## Documentation
* Fix typo for `image_type` parameter in the sample code of the readme file
* Extended documentation, added multi resolution image rendering
# clara-viz 0.1.4 (Feb 15 2022)
## Security
* Update Jupyter widget Java code packages to fix vulnerabilities
## Bug Fixes
* Regression - cinematic rendering example throws an error (https://github.com/NVIDIA/clara-viz/issues/16)
# clara-viz 0.1.3 (Jan 31 2022)
## New
* Support installation of recommended dependencies
## Bug Fixes
* Failed to load data files with ITK when using Clara Train docker image (https://github.com/NVIDIA/clara-viz/issues/12)
* Rendering is wrong when passing non-contiguous data in (e.g. transposed numpy array)
* Widget interaction in slice mode not working correctly (https://github.com/NVIDIA/clara-viz/issues/13)
# clara-viz 0.1.2 (Jan 19 2022)
## Bug Fixes
* When the renderer is immediately destroyed after creation there is a segmentation fault. This could happen when providing a unsupported data type (e.g. 64 bit floating point values), when creating a temporary object (e.g. in Python `print(Renderer(data)))`) or when the initialization of the Renderer failed. (https://github.com/NVIDIA/clara-viz/issues/7, https://github.com/NVIDIA/clara-viz/issues/8)
* Widget is not working with Jupyter Notebooks (but with Jupyter Lab) (https://github.com/NVIDIA/clara-viz/issues/9)
## Documentation
* Added missing `video` capability to docker run command
# clara-viz 0.1.1 (Dec 14 2021)
## Bug Fixes
* When installing the `clara-viz-core` Python package only there is the error `ModuleNotFoundError: No module named 'packaging'` when doing `import clara.viz.core`
* When getting the settings from the renderer the 'TransferFunctions' sections is returned as 'Transferfunctions' with lower case 'f'
## Documentation
* Added a section on using Clara Viz within a docker container.
* Added a link to the documentation.
* Added a section on WSL (Windows Subsystem for Linux).
## Notebooks
* The DataDefinition class is using ITK to load the data files, make sure ITK is available.
* Added a slice rendering example (Slice_rendering.ipynb)
* Fixed the check if the volume file exists in Render_image.ipynb, also fixed volume orientation and scaling.
* Updated the settings files to match the settings conventions used by the renderer.
## Misc
* Changed the camera names and removed the `Slice` prefix of the orthographic cameras. Renamed the perspective camera from `Cinematic` to `Perspective`
# clara-viz 0.1.0 (Dec 3 2021)
Initial release of Clara Viz
Raw data
{
"_id": null,
"home_page": "https://github.com/NVIDIA/clara-viz",
"name": "clara-viz",
"maintainer": null,
"docs_url": null,
"requires_python": "<=3.11,>=3.6",
"maintainer_email": null,
"keywords": null,
"author": "NVIDIA Corporation",
"author_email": null,
"download_url": null,
"platform": "manylinux_2_28_x86_64",
"description": "# Quick Start\n\n## Installation\n\nThis will install all Clara Viz packages use pip:\n\n```bash\n$ pip install clara-viz\n```\n\nClara Viz is using namespace packages. The main functionality is implemented in the 'clara-viz-core' package,\nJupyter Notebook widgets are found in the 'clara-viz-widgets' package.\nSo for example if you just need the renderer use\n\n```bash\n$ pip install clara-viz-core\n```\n\n## Use interactive widget in Jupyter Notebook\n\nInstall the Jupyter notebook widgets.\n\n```bash\n$ pip install clara-viz-widgets\n```\n\nStart Jupyter Lab, open the notebooks in the `notebooks` folder. Make sure Git LFS is installed when cloning the repo, else the data files are not downloaded correctly and you will see file open errors when using the example notebooks.\n\n```python\nfrom clara.viz.widgets import Widget\nfrom clara.viz.core import Renderer\nimport numpy as np\n\n# load a RAW CT data file (volume is 512x256x256 voxels)\ninput = np.fromfile(\"CT.raw\", dtype=np.int16)\ninput = input.reshape((512, 256, 256))\n\ndisplay(Widget(Renderer(input)))\n```\n\n## Render CT data from Python\n\n```python\nfrom PIL import Image\nimport clara.viz.core\nimport numpy as np\n\n# load a RAW CT data file (volume is 512x256x256 voxels)\ninput = np.fromfile(\"CT.raw\", dtype=np.int16)\ninput = input.reshape((512, 256, 256))\n\n# create the renderer\nrenderer = clara.viz.core.Renderer(input)\n\n# render to a raw numpy array\noutput = renderer.render_image(1024, 768, image_type=clara.viz.core.ColorImageType.RAW_RGBA_U8)\nrgb_data = np.asarray(output)[:, :, :3]\n\n# show with PIL\nimage = Image.fromarray(rgb_data)\nimage.show()\n```\n\n# clara-viz 0.4.0 (April 10 2024)\n\n## Features\n\n* Add Python and pybind11 source code\n* Add support for Python 3.10 and 3.11 packages and set Python wheel requirement to fail installation on unsupported Python versions\n\n## Bug Fixes\n\n* Add missing <thread> include to DataSourceUS.cpp ([32](https://github.com/NVIDIA/clara-viz/pull/32)) [@thewtex](https://github.com/thewtex)\n* Upgrade almalinux-release in Docker build for GPG keys ([31](https://github.com/NVIDIA/clara-viz/pull/32)) [@thewtex](https://github.com/thewtex)\n* Gracefully disable OptiX and NvENC features if initialization fails.\n* Python: Fix segfault when accessing RGBA data of rendered image ([33](https://github.com/NVIDIA/clara-viz/issues/33)) [@thewtex](https://github.com/thewtex)\n\n# clara-viz 0.3.2 (November 27 2023)\n\n## Features\n\n* Support camera pose for non-stereo cases as well\n\n## Bug Fixes\n\n* Fix cmake warnings and consolidate cmake_minimum_required() usage\n* Fix compile warning in NvEnvService.cpp\n\n# clara-viz 0.3.1 (July 12 2023)\n\n## Bug Fixes\n\n* Gracefully disable OptiX denoiser if it can't be created\n* make nvjpeg support optional\n\n# clara-viz 0.3.0 (June 22 2023)\n\n## Features\n\n* C++ interface is now public\n* Add support for aarch64 (not for Python wheels)\n* Add support for VR/AR rendering\n + Camera has stereo mode and left end right eye poses, tangents and gaze directions\n + Add warped and foveated rendering\n + Add reprojection\n* Add support for separate depth buffer\n* Add support for alpha channel\n* Add support for near and far depth plane\n* Add support for transforming the volume using a matrix\n\n## Bug Fixes\n\n* Fix tonemap enable, had no effect before (always enabled).\n* AttributeError: module 'itk' has no attribute 'itkSpatialOrientationPython' (https://github.com/NVIDIA/clara-viz/issues/26)\n\n## Security\n\n* Update Jupyter widget Java code packages to fix vulnerability CVE-2022-46175\n\n# clara-viz 0.2.2 (October 17 2022)\n\n## Bug Fixes\n\n* Jupyter notebooks fail with AttributeError: 'Widget' object has no attribute 'on_displayed' (https://github.com/NVIDIA/clara-viz/issues/23)\n\n## Security\n\n* Update Jupyter widget Java code packages to fix vulnerabilities\n\n## Documentation\n\n* pip install fails on Windows machines (https://github.com/NVIDIA/clara-viz/issues/22)\n * Windows is not supported, added a section on supported OS to readme\n\n# clara-viz 0.2.1 (March 29 2022)\n\n## Bug Fixes\n\n* Widget can't be displayed because of version mismatch\n\n# clara-viz 0.2.0 (March 29 2022)\n\n## Features\n\n* Add support for rendering multi resolution images used in digital pathology\n\n## Security\n\n* Update Jupyter widget Java code packages to fix vulnerabilities\n\n## Bug Fixes\n\n* Error when using a widget with a renderer using a numpy array (https://github.com/NVIDIA/clara-viz/issues/18)\n\n## Documentation\n\n* Fix typo for `image_type` parameter in the sample code of the readme file\n* Extended documentation, added multi resolution image rendering\n\n# clara-viz 0.1.4 (Feb 15 2022)\n\n## Security\n\n* Update Jupyter widget Java code packages to fix vulnerabilities\n\n## Bug Fixes\n\n* Regression - cinematic rendering example throws an error (https://github.com/NVIDIA/clara-viz/issues/16)\n\n# clara-viz 0.1.3 (Jan 31 2022)\n\n## New\n\n* Support installation of recommended dependencies\n\n## Bug Fixes\n\n* Failed to load data files with ITK when using Clara Train docker image (https://github.com/NVIDIA/clara-viz/issues/12)\n* Rendering is wrong when passing non-contiguous data in (e.g. transposed numpy array)\n* Widget interaction in slice mode not working correctly (https://github.com/NVIDIA/clara-viz/issues/13)\n\n# clara-viz 0.1.2 (Jan 19 2022)\n\n## Bug Fixes\n\n* When the renderer is immediately destroyed after creation there is a segmentation fault. This could happen when providing a unsupported data type (e.g. 64 bit floating point values), when creating a temporary object (e.g. in Python `print(Renderer(data)))`) or when the initialization of the Renderer failed. (https://github.com/NVIDIA/clara-viz/issues/7, https://github.com/NVIDIA/clara-viz/issues/8)\n* Widget is not working with Jupyter Notebooks (but with Jupyter Lab) (https://github.com/NVIDIA/clara-viz/issues/9)\n\n## Documentation\n\n* Added missing `video` capability to docker run command\n\n# clara-viz 0.1.1 (Dec 14 2021)\n\n## Bug Fixes\n\n* When installing the `clara-viz-core` Python package only there is the error `ModuleNotFoundError: No module named 'packaging'` when doing `import clara.viz.core`\n* When getting the settings from the renderer the 'TransferFunctions' sections is returned as 'Transferfunctions' with lower case 'f'\n\n## Documentation\n\n* Added a section on using Clara Viz within a docker container.\n* Added a link to the documentation.\n* Added a section on WSL (Windows Subsystem for Linux).\n\n## Notebooks\n\n* The DataDefinition class is using ITK to load the data files, make sure ITK is available.\n* Added a slice rendering example (Slice_rendering.ipynb)\n* Fixed the check if the volume file exists in Render_image.ipynb, also fixed volume orientation and scaling.\n* Updated the settings files to match the settings conventions used by the renderer.\n\n## Misc\n\n* Changed the camera names and removed the `Slice` prefix of the orthographic cameras. Renamed the perspective camera from `Cinematic` to `Perspective`\n\n# clara-viz 0.1.0 (Dec 3 2021)\n\nInitial release of Clara Viz\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A toolkit to provide GPU accelerated visualization of medical data.",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/NVIDIA/clara-viz"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33af18bfb66f495d3fb8c0b40f0ab6fc96ef3ee6d2e6027c38222d7f4c2a8b98",
"md5": "a638034f603dee12342f1546654ea587",
"sha256": "7ea94f325b2a07572e4cb1f991f8b383a40a714135d917dcb9c2c8a14d30f35a"
},
"downloads": -1,
"filename": "clara_viz-0.4.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a638034f603dee12342f1546654ea587",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "<=3.11,>=3.6",
"size": 9818,
"upload_time": "2024-04-10T09:14:59",
"upload_time_iso_8601": "2024-04-10T09:14:59.745939Z",
"url": "https://files.pythonhosted.org/packages/33/af/18bfb66f495d3fb8c0b40f0ab6fc96ef3ee6d2e6027c38222d7f4c2a8b98/clara_viz-0.4.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-10 09:14:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NVIDIA",
"github_project": "clara-viz",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "clara-viz"
}
JSON
