Skip to content
Snippets Groups Projects
Commit 527d197c authored by fima's avatar fima :beers:
Browse files

Documentation update

parent de1d42cc
No related branches found
No related tags found
No related merge requests found
docs/assets/screenshots/gui-annotation_tool.gif

2.28 MiB

docs/assets/screenshots/interactive_edge_fading.png

364 KiB

docs/assets/screenshots/viz-fade_mask.gif

1.08 MiB

......@@ -17,3 +17,4 @@ Here, we provide functionalities designed specifically for 3D image analysis and
- remove_background
- watershed
- edge_fade
- fade_mask
......@@ -9,9 +9,17 @@ As the library is still in its early development stages, **there may be breaking
And remember to keep your pip installation [up to date](/qim3d/#upgrade) so that you have the latest features!
### v0.3.6 (30/05/2024)
- Refactoring for performance improvement
- Welcome message for the CLI
- Introduction of `qim3d.processing.fade_mask` 🎉
### v0.3.5 (27/05/2024)
- Added runtime and memory usage in the documentation
- Introduction of `qim3d.utils.generate_volume` 🎉
- Introduction of `preview` CLI 🎉
### v0.3.4 (22/05/2024)
- Documentation for `qim3d.viz.plot_cc`
......
......@@ -12,7 +12,7 @@ The `qim3d` library aims to provide easy ways to explore and get insights from v
- vectors
- plot_cc
- colormaps
- interactive_edge_fade
- interactive_fade_mask
::: qim3d.viz.colormaps
options:
......
......@@ -10,9 +10,14 @@ Or launched from a python script
```python
import qim3d
app = qim3d.gui.annotation_tool.Interface()
app.launch()
vol = qim3d.examples.NT_128x128x128
annotation_tool = qim3d.gui.annotation_tool.Interface()
# We can directly pass the image we loaded to the interface
app = annotation_tool.launch(vol[0])
```
![gui-annotation_tool](assets/screenshots/gui-annotation_tool.gif)
"""
import getpass
......
......@@ -562,19 +562,19 @@ def vol_masked(vol, vol_mask, viz_delta=128):
def interactive_fade_mask(vol: np.ndarray, axis: int = 0):
""" Interactive widget for visualizing the effect of edge fading on a 3D volume.
This can be used to select the best parameters before applying the mask.
Args:
vol (np.ndarray): The volume to apply edge fading to.
axis (int, optional): The axis along which to apply the fading. Defaults to 0.
Returns:
np.ndarray: The volume with edge fading applied.
Example:
```python
import qim3d
qim3d.viz.img.interactive_edge_fade(vol, geometric='cylindrical', axis=0)
vol = qim3d.examples.cement_128x128x128
qim3d.viz.interactive_fade_mask(vol)
```
![operations-edge_fade_before](assets/screenshots/interactive_edge_fading.png)
![operations-edge_fade_before](assets/screenshots/viz-fade_mask.gif)
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment