PixpipeContainer) from object that processes data (inherit from
The concept of pipeline implies that the output of a
Filter can be used as an input for the next one, like in ITK. In Pixpipe.js, this is done by using the
Filter may have several input or output of different kinds.
npm install --save pixpipe
Usage in prod
The bundle in
dist/pixpipe.js is a umd bundle, meaning it's ugly but it's compatible everywhere.
In HTML file:
<!-- or alternatively -->
const pixpipe = ;
In ES6 module:
Or, if you don't want to export the whole bundle, you can select sub-parts of Pixpipe:
To make image processing:
- accessible, using just a web browser and a textpad
- easy to use in a sense that "all filters work the same way".
- with no other dependency than
- with no required compilation or system fuss
- generic enough to use different kind of data/datasource
- easy to contribute
- well documented for both users and contributors.
Here are some slides to present Pixpipejs. Maybe an easier introduction.
Here is the list of compatible formats:
- jpeg (to Image2D)
- png (to Image2D)
- tiff (to Image2D)
- NIfTI (to Image3D / MniVolume)
- Minc2 (to Image3D / MniVolume)
- MGH/MHZ (to Image3D / MniVolume)
- EDF - European Data Format (to Signal1D)
- MOD EEG (to Signal1D)
- PixBin (generic Pixpipe format for pretty much everything)
HERE is the repo where some sample data are stored (mainly to avoid this repos to be too fat).
The PixBin format
This is the binary file format used to store data from a Pixpipe pipeline. Thanks to it's proximity to Pixpipe structures a PixBin file can be opened and create the Pixpipe object instances as you left them.
Pixpipejs is open to contribution via fork + pull requests.
In addition, if you have an idea of a feature you would like to see in Pixpipejs, you can mention if in the Wiki and we'll see what we can do.
MIT - See LICENSE file.