Skip to content

Commit 1dcccce

Browse files
author
joeljonsson
committed
Added some info on Python support to README
1 parent 509f731 commit 1dcccce

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,26 @@ All examples except Example_get_apr require an already produced APR, such as tho
112112

113113
For tutorial on how to use the examples, and explanation of data-structures see [the library guide](./docs/lib_guide.pdf).
114114

115+
## Python support
116+
117+
Basic functionality is supported in Python through wrappers. To build the python module,
118+
use the CMake option
119+
120+
`-DAPR_BUILD_PYTHON_WRAPPERS=ON`
121+
122+
Example usage of the available functionality:
123+
| Example | How to ... |
124+
|:--|:--|
125+
| [Example_get_apr_from_array](./examples/python_examples/Example_get_apr_from_array.py) | create an APR from an ndarray and store as hdf5. |
126+
| [Example_get_apr_from_file](./examples/python_examples/Example_get_apr_from_file.py) | create an APR from a TIFF and store as hdf5. |
127+
| [Example_reconstruct_image](./examples/python_examples/Example_reconstruct_image.py) | read in an APR and reconstruct a pixel image |
128+
129+
115130
## Coming soon
116131

117132
* more examples for APR-based filtering and segmentation
118133
* deployment of the Java wrappers to Maven Central so they can be used in your project directly
119134
* support for loading the APR in [Fiji](https://fiji.sc), including [scenery-based](https://github.com/scenerygraphics/scenery) 3D rendering
120-
* basic python wrapper support
121135
* improved java wrapper support
122136
* CUDA GPU-accelerated APR generation and processing
123137

0 commit comments

Comments
 (0)