https://github.com/imagej/imagej-node
ImageJ module for node.js
https://github.com/imagej/imagej-node
Last synced: about 1 year ago
JSON representation
ImageJ module for node.js
- Host: GitHub
- URL: https://github.com/imagej/imagej-node
- Owner: imagej
- License: unlicense
- Created: 2018-05-17T21:46:53.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T14:04:31.000Z (about 3 years ago)
- Last Synced: 2025-04-19T02:23:15.238Z (about 1 year ago)
- Language: JavaScript
- Size: 32.2 KB
- Stars: 8
- Watchers: 12
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node.js module for ImageJ
Do you want to embed [ImageJ](https://imagej.net/) in your node.js application?
Well then, today is your lucky day!
## Installation
```
npm install imagej
```
## Usage
```javascript
config = {}
config.imagej_dir = '/path/to/Fiji.app'
config.headless = true // Unless you want the GUI.
console.log('==> Starting ImageJ')
var imagej = require('imagej')(config)
imagej.on('ready', function(ij) {
ij.log().info('==> ImageJ is ready to go.')
dataset = ij.io().open('/path/to/myImage.tif')
filtered = ij.op().run('filter.gauss', dataset, [8, 10, 1])
ij.scifio().datasetIO().save(filtered, '/path/to/outputImage.png')
ij.context().dispose()
})
```
## Examples
```
node examples/versions.js
node examples/gauss-filter.js
```
They assume you've set the `IMAGEJ_DIR` environment variable
to an [ImageJ2](https://imagej.net/ImageJ2) installation.
The easiest way to get ImageJ2 is to install [Fiji](https://fiji.sc/).
## Troubleshooting
* __If the ImageJ startup hangs on macOS__, you may have been bit by the dreaded
AWT main thread issue. Try setting `config.headless = true` in the `config`
object you pass to the imagej initialization function.
For further details, see
[this article](http://mirror.informatimago.com/next/developer.apple.com/technotes/tn2005/tn2147.html#TNTAG40)
as well as
[joeferner/node-java#21](https://github.com/joeferner/node-java/issues/21).
* __If `npm install` fails on macOS__, you may have an issue with Python
configuration. The `java` module used by `imagej` requires native compilation
via `node-gyp`, which uses Python 2 (not 3!) internally. Try this:
```
npm config set python /usr/bin/python
export PATH=/usr/bin:$PATH
```
And then `npm install` again.