mirror of
https://github.com/paulscherrerinstitute/ch.psi.imagej.hdf5.git
synced 2025-06-04 09:40:39 +02:00
Updated readme
This commit is contained in:
parent
eb4cc6ce7a
commit
c855f29635
19
Readme.md
19
Readme.md
@ -1,3 +1,22 @@
|
||||
# Overview
|
||||
ZMQ ImageJ is an ImageJ plugin for viewing images transmitted via ZMQ. It can handle data streamed via the message format defined in [ZMQ Data Steaming](https://confluence.psi.ch/display/SOF/ZMQ+Data+Streaming).
|
||||
|
||||
# Installation
|
||||
To install the plugin into ImageJ drop the all-in-one jar into the plugins directory of ImageJ. Afterwards (re)start ImageJ and open the plugin via _Plugins > ZeroMQ Viewer_. A plugin window will be opened where source, port and method can be specified. Once clicked on _Start_ and images are streamed from the source an additional window will open showing the images.
|
||||
|
||||
# Usage
|
||||
While using the ZeroMQ Viewer Plugin ImageJ need to be configured to have more memory. This can be done in the `run` file located in the ImageJ discribution.
|
||||
Add/Modify following flag: `-Xmx1024m`
|
||||
|
||||
# Development
|
||||
To build the code run following maven command/goals:
|
||||
`mvn clean compile assembly:single`
|
||||
|
||||
## References
|
||||
http://fiji.sc/wiki/index.php/Description_of_ImageJ's_plugin_architecture
|
||||
|
||||
|
||||
|
||||
# Installation
|
||||
|
||||
Drop jar into plugins directory of the ImageJ installation.
|
||||
|
Loading…
x
Reference in New Issue
Block a user