Skip to content

Commit 0f17c11

Browse files
author
haesleinhuepf
committed
documentation updates
1 parent c18c75b commit 0f17c11

14 files changed

+45
-40
lines changed

generate_clijx_plugins.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,11 @@ directory of their Fiji installation.
77
If you're about to generate Fiji plugins for the first time, please follow the installation instructions [here](https://clij.github.io/assistant/installation#maven) first.
88

99
## How does it work?
10-
After entering some parameters, such as plugin name, description, author and maven/java/git installation folders, a template is downloaded from here:
11-
https://github.com/clij/clijx-assistant-plugin-generator-template
10+
After entering some parameters, such as plugin name, description, author and maven/java/git installation folders, a template is downloaded from [here](https://github.com/clij/clijx-assistant-plugin-generator-template).
1211
Afterwards, some placeholders in this [ImageJ/Fiji/CLIJ maven project](https://imagej.net/Maven) are replaced before it is compiled and the resulting .jar file is installed to your Fijis `/plugins/` folder.
1312

14-
<iframe src="images/generate_clijx_plugins3_acc.mp4" width="600" height="300"></iframe>
15-
[Download video](images/generate_clijx_plugins3_acc.mp4)
13+
<iframe src="images/fiji_plugin_generator.mp4" width="600" height="300"></iframe>
14+
[Download video](images/fiji_plugin_generator.mp4)
1615

1716
Back to [CLIJx-Assistant](https://clij.github.io/assistant)
1817

getting_started.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,9 @@ You can use ImageJs `Duplicate...` menu or the built in menu:
2929

3030
![Image](images/interoperability_imagej.png)
3131

32-
3332
## The assistant in action
34-
<iframe src="images/window_positioning.mp4" width="540" height="540"></iframe>
35-
[Download video](images/window_positioning.mp4)
33+
<iframe src="images/basic_usage.mp4" width="600" height="300"></iframe>
34+
[Download video](images/basic_usage.mp4)
3635

3736

3837
Back to [CLIJx-Assistant](https://clij.github.io/assistant)

icy_protocol_export.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Intensity projection
2+
Workflows can be exported as Icy Protocols.
3+
4+
## Installation
5+
If you want to conveniently open Icy Protocols directly from Fiji,
6+
please follow the corresponding [installation instructions](https://clij.github.io/assistant/installation#icy).
7+
8+
## Usage
9+
In order to export a workflow as protocol to Icy, click the right mouse button on any
10+
assistant window and click the menu `Generate Script > Icy Protocol`.
11+
12+
Please note: Export to Icy Workflows is limited to operations from the CLIJ2 library at the moment.
13+
14+
<iframe src="images/icy_export.mp4" width="600" height="300"></iframe>
15+
[Download video](images/icy_export.mp4)

images/basic_usage.mp4

3.76 MB
Binary file not shown.

images/fiji_plugin_generator.mp4

4.2 MB
Binary file not shown.

images/generate_clijx_plugins.mp4

-3.24 MB
Binary file not shown.
-4.64 MB
Binary file not shown.

images/icy_export.mp4

1.58 MB
Binary file not shown.

images/ijmmd.mp4

-3.9 MB
Binary file not shown.

images/window_positioning.mp4

-3.3 MB
Binary file not shown.

morpholibj_chamfer_distance_map.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ Assuming one wants to analyse distances of cells towards a common structures suc
55
![Image](images/morpholibj_distance_map.png)
66

77
### Installation
8-
Activate the "IJPB-plugins" update site in Fiji.
8+
In order to use the MorphoLibJ extension, please follow the corresponding [installation instructions](https://clij.github.io/assistant/installation#extensions).
99

1010
### Application
1111
* Starting point: Intensity image showing nuclei
1212
* Threshold Otsu
1313
* Connected Components Labeling
1414
* Pull To ROIManager
15-
* Starting point: Binary image representing vessels...
15+
* Starting point: Binary image representing vessels for example
1616
* Binary Not
1717
* Morpho Lib J Chamfer Distance Map
1818

parameter_optimization.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
# Parameter optimization
2-
3-
---
4-
Note: Parameter optimization is deactivated at the moment for technical reasons. Stay tuned.
5-
---
6-
7-
8-
9-
1+
# Parameter optimization for binarization operations
102
If a workflow results in a binary image and some annotations are availabe, its parameters can be automatically optimized.
113
To prepare the optimization, draw Freehand or Polyline ROIs and store them in the ROI Manager.
124
Name the positive annotations "p" and the negative annotations "n" (background).

readme.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# CLIJx-Assistant
22
[CLIJx-Assistant](https://clij.github.io/assistant) is an intuitive user interface for building custom GPU-accelerated image processing workflows using [CLIJ2](https://clij.github.io) in [Fiji](https://fiji.sc).
3-
It visualizes workflows while building them, suggests what to do next and generates scripts and human readable protocols to facilitate reproducible bio-image analysis.
4-
These generated scripts also run in other platforms such as Matlab, Icy, Python and QuPath.
3+
It visualizes workflows as image date flow graphs while building them.
4+
It suggests what to do next and generates scripts and human readable protocols to facilitate reproducible bio-image analysis.
5+
These generated scripts also be executed in other platforms such as Matlab, Icy, Python and QuPath.
56

67
CLIJx-Assistant is under development and is subject to change.
7-
Please treat everything with care.
8-
Do not use it for routine research yet.
9-
Planned release is early 2021.
10-
Stay tuned.
8+
Give it a try and let us know what you think!
9+
Do not use it for routine research yet.
10+
Provide feedback and stay tuned.
1111

1212
<iframe src="images/clijxa_teaser1_fast.mp4" width="800" height="640"></iframe>
1313
[Download slower version of the video](images/clijxa_teaser1.mp4) [Image data source: Daniela Vorkel, Myers lab, CSBD / MPI CBG]
@@ -17,9 +17,7 @@ Stay tuned.
1717
* [Installation](https://clij.github.io/assistant/installation)
1818
* [Building workflows](https://clij.github.io/assistant/getting_started)
1919
* [Saving and loading workflows](https://clij.github.io/assistant/save_and_load)
20-
* [Optimize parameters](https://clij.github.io/assistant/parameter_optimization)
2120
* [Undo parameter changes](https://clij.github.io/assistant/undo)
22-
* [Reference](https://clij.github.io/assistant/reference)
2321

2422
* Filtering / correction
2523
* [Image filtering](https://clij.github.io/assistant/filtering)
@@ -33,11 +31,10 @@ Stay tuned.
3331
* [Sphere projection](https://clij.github.io/assistant/sphere_projection)
3432

3533
* Regionalisation
36-
* Spot detection
37-
* Cell segmentation
38-
* [Nuclei segmentation](https://clij.github.io/assistant/segmentation_nuclei)
39-
* [Cell segmentation based on membranes](https://clij.github.io/assistant/segmentation_cells)
40-
* [Pixel classifier (Weka)](https://clij.github.io/assistant/clijx_weka_pixel_classifier)
34+
* [Nuclei segmentation](https://clij.github.io/assistant/segmentation_nuclei)
35+
* [Cell segmentation based on membranes](https://clij.github.io/assistant/segmentation_cells)
36+
* [Optimize parameters for binarization](https://clij.github.io/assistant/parameter_optimization)
37+
* [Pixel classifier (Weka)](https://clij.github.io/assistant/clijx_weka_pixel_classifier)
4138

4239
* Analysis
4340
* [Cell neighbor analysis](https://clij.github.io/assistant/neighbor_analysis_generated)
@@ -46,20 +43,23 @@ Stay tuned.
4643

4744
* Reproducibility / interoperability
4845
* [Export workflows as ImageJ Script](https://clij.github.io/assistant/macro_export)
49-
* [Supplementary methods section generator](https://clij.github.io/assistant/supplementary_methods_section_generator)
46+
* [Export human readable protocols and ImageJ Macro Markdown notebooks](https://clij.github.io/assistant/supplementary_methods_section_generator)
5047
* [Generate CLIJx / Fiji plugins](https://clij.github.io/assistant/generate_clijx_plugins)
48+
* [Export as Icy Protocol](https://clij.github.io/assistant/icy_protocol_export)
5149
* [Export Groovy Script for QuPath](https://clij.github.io/assistant/export_to_clupath)
5250
* [Export workflows as Python script using clEsperanto and Napari](https://clij.github.io/assistant/te_oki_export)
5351

52+
* [Reference](https://clij.github.io/assistant/reference)
53+
5454
* Extensibility
5555
* [CLIJ2 Plugin template](https://github.com/clij/clij2-plugin-template)
56-
* [CLIJ2 imglib2 example plugin](https://github.com/clij/clijx-assistant-imglib2)
57-
* [CLIJ2 ImageJ example plugin](https://github.com/clij/clijx-assistant-imagej)
58-
* [CLIJ2 ImageJ2 example plugin](https://github.com/clij/clijx-assistant-imagej2)
59-
* [CLIJ2 BoneJ example plugin](https://github.com/clij/clijx-assistant-bonej)
60-
* [CLIJ2 MorphoLibJ example plugin](https://github.com/clij/clijx-assistant-morpholibj)
61-
* [CLIJ2 ImageJ 3D Suite example plugin](https://github.com/clij/clijx-assistant-imagej3dsuite)
62-
* [CLIJ2 SimpleITK example plugin](https://github.com/clij/clijx-assistant-simpleitk)
56+
* [CLIJ2 imglib2 extensions](https://github.com/clij/clijx-assistant-imglib2)
57+
* [CLIJ2 ImageJ extensions](https://github.com/clij/clijx-assistant-imagej)
58+
* [CLIJ2 ImageJ2 extensions](https://github.com/clij/clijx-assistant-imagej2)
59+
* [CLIJ2 BoneJ extensions](https://github.com/clij/clijx-assistant-bonej)
60+
* [CLIJ2 MorphoLibJ extensions](https://github.com/clij/clijx-assistant-morpholibj)
61+
* [CLIJ2 ImageJ 3D Suite extensions](https://github.com/clij/clijx-assistant-imagej3dsuite)
62+
* [CLIJ2 SimpleITK extensions](https://github.com/clij/clijx-assistant-simpleitk)
6363

6464
## Feedback welcome!
6565
I'm eager to receiving feedback: rhaase at mpi minus cbg dot de

supplementary_methods_section_generator.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Supplementary Methods Section generator
1+
## Export human readable protocols
22
Just like [generating scripts](https://clij.github.io/assistant/macro_export), one can also
33
generate human readable protocols of workflows. Just click the right-click menu `Generate Script > Human readable protocol`.
44

0 commit comments

Comments
 (0)