Skip to content

Commit e4e6557

Browse files
Update documentation
1 parent 8bf1f74 commit e4e6557

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/documentation.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,19 @@ Use `--file_ext .raw` if the data is stored in raw files. The the output data fo
8787
- If you specify `.n5` the data will be exported to the [bdv.n5 format](https://github.com/bigdataviewer/bigdataviewer-core/blob/master/BDV%20N5%20format.md). It can be opened with BigDataViewer via `Plugins->BigDataViewer->Open XML/HDF5` or with [BigStitcher](https://imagej.net/plugins/bigstitcher/) as described [here](https://imagej.net/plugins/bigstitcher/open-existing).
8888
- If you specify `.ome.zarr` the data will be exported to the [ome.zarr format](https://ngff.openmicroscopy.org/).
8989

90-
`flamingo_tools.run_segmentation`: To segment cells in volumetric light microscopy data.
90+
`flamingo_tools.run_segmentation`: To segment cells in volumetric light microscopy data. You can use this command as follows:
91+
```bash
92+
flamingo_tools.run_segmentation -i /path/to/data.tif -o /path/to/output_folder -m SGN
93+
```
94+
Here, `-m` determines which model is used. See also [available models](#available-models).
95+
To use a custom trained model you can use the argument `--checkpoint_path` (`-c`).
9196

92-
`flamingo_tools.run_detection`: To detect synapses in volumetric light microscopy data.
97+
`flamingo_tools.run_detection`: To detect synapses in volumetric light microscopy data. The command is used similarly to `flamingo_tools.run_segmentation`.
9398

9499
For more information on any of the command run `flamingo_tools.<COMMAND> -h` (e.g. `flamingo_tools.run_segmentation -h`) in your terminal.
95100

101+
We will add additional command line functionality soon.
102+
96103
### Python Library
97104

98105
CochleaNet's functionality is implemented in the `flamingo_tools` python library. It implements:

0 commit comments

Comments
 (0)