Skip to content

Commit d148853

Browse files
committed
DOC: Add data structure links
1 parent b23fc9d commit d148853

File tree

1 file changed

+31
-29
lines changed

1 file changed

+31
-29
lines changed

README.rst

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -33,53 +33,53 @@ itkwidgets
3333
:target: https://zenodo.org/badge/latestdoi/121581663
3434
:alt: Software citation DOI
3535

36-
Interactive `Jupyter <https://jupyter.org/>`_ widgets to visualize images,
37-
point sets, and meshes.
36+
Interactive Jupyter_ widgets to visualize images, point sets, and meshes.
3837

3938
.. image:: https://i.imgur.com/d8aXycW.png
4039
:width: 800px
4140
:alt: itkwidgets chest CT in JupyterLab
4241

4342
**Key Features**:
4443

45-
- Visualize 2D and 3D images, point sets, and geometry, e.g. meshes, in Jupyter
44+
- Visualize 2D and 3D images, point sets, and geometry, e.g. meshes, in Jupyter_
4645
- Support for
4746

48-
- NumPy array images
49-
- itk.Image
50-
- Dask array images
51-
- vtk.vtkImageData
52-
- pyvista.UniformGrid
53-
- vtkplotter.Volume
54-
- ImageJ / Fiji / ImageJ2 images
47+
- `NumPy array <https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.html>`_ images
48+
- `itk.Image <https://itkpythonpackage.readthedocs.io/en/latest/Quick_start_guide.html>`_
49+
- `Dask array <https://docs.dask.org/en/latest/array.html>`_ images
50+
- `vtk.vtkImageData <https://vtk.org>`_
51+
- `pyvista.UniformGrid <https://pyvista.org>`_
52+
- `vtkplotter.Volume <https://vtkplotter.embl.es/index.html>`_
53+
- `pyimagej ImageJ / Fiji / ImageJ2 images <https://github.com/imagej/pyimagej>`_
5554
- Additional NumPy array-like objects
56-
- SimpleITK.Image
55+
- `SimpleITK.Image <https://simpleitk-prototype.readthedocs.io/en/latest/user_guide/plot_image.html#sphx-glr-user-guide-plot-image-py>`_
5756

5857
- NumPy array point sets
59-
- itk.PointSet
60-
- vtk.vtkPolyData point sets
61-
- pyvista.PolyData point sets
62-
63-
- itk.Mesh
64-
- itk.PolyLineParametricPath
65-
- vtk.vtkPolyData
66-
- vtk.vtkStructuredGrid
67-
- vtk.vtkUnstructuredGrid
68-
- vtk.vtkActor
69-
- vtk.vtkVolume
70-
- vtk.vtkAssembly
71-
- pyvista.PolyData
72-
- pyvista.StructuredGrid
73-
- pyvista.UnstructuredGrid
74-
- vtkplotter.Actor
75-
- vtkplotter.Assembly
76-
- skan.csr.Skeleton
58+
- `itk.PointSet <https://itk.org/Doxygen/html/classitk_1_1PointSet.html>`_
59+
- `vtk.vtkPolyData <https://vtk.org/doc/nightly/html/classvtkPolyData.html>`_ point sets
60+
- `pyvista.PolyData <https://docs.pyvista.org/core/points.html>`_ point sets
61+
62+
- `itk.Mesh <https://itk.org/Doxygen/html/classitk_1_1Mesh.html>`_
63+
- `itk.PolyLineParametricPath <https://itk.org/Doxygen/html/classitk_1_1PolyLineParametricPath.html>`_
64+
- `vtk.vtkPolyData <https://vtk.org/doc/nightly/html/classvtkPolyData.html>`_
65+
- `vtk.vtkStructuredGrid <https://vtk.org/doc/nightly/html/classvtkStructuredGrid.html>`_
66+
- `vtk.vtkUnstructuredGrid <https://vtk.org/doc/nightly/html/classvtkUnstructuredGrid.html>`_
67+
- `vtk.vtkActor <https://vtk.org/doc/nightly/html/classvtkActor.html>`_
68+
- `vtk.vtkVolume <https://vtk.org/doc/nightly/html/classvtkVolume.html>`_
69+
- `vtk.vtkAssembly <https://vtk.org/doc/nightly/html/classvtkAssembly.html>`_
70+
- `pyvista.PolyData <https://docs.pyvista.org/core/points.html>`_
71+
- `pyvista.StructuredGrid <https://docs.pyvista.org/core/point-grids.html#structured-grid-creation>`_
72+
- `pyvista.UnstructuredGrid <https://docs.pyvista.org/core/point-grids.html#unstructured-grid-creation>`_
73+
- `vtkplotter.Actor <https://vtkplotter.embl.es/index.html>`_
74+
- `vtkplotter.Assembly <https://vtkplotter.embl.es/index.html>`_
75+
- `skan.csr.Skeleton <https://jni.github.io/skan/api/skan.csr.html#module-skan.csr>`_
7776

7877
- Exquisite volume rendering
7978
- Tri-plane volume slicing
8079
- Innovative, powerful opacity transfer function / window / level widget
8180
- Anisotropic voxel spacing supported
8281
- Image line profile widget
82+
- Compare images widget
8383
- Widgets to select solid colors for geometry or colormaps when point data or
8484
cell data is availble
8585
- Visualize point sets as points or spheres and interactively adjust the point
@@ -363,3 +363,5 @@ To develop for Jupyter Lab, additionally run::
363363

364364
This project is under active development. Its API and behavior may change at
365365
any time. We mean it.
366+
367+
.. _Jupyter: https://jupyter.org/

0 commit comments

Comments
 (0)