@fintellab/ostrich v0.3.0

ostrich

ostrich is a volumetric imaging library for the web.

Quickstart

1. Install package dependencies with npm:

    $ npm install

2. Start development environment that keeps dist/main.js updated:

    $ npm run serve-example

3. Open example/example.html in a web-browser.

API

ostrich is always initialized on an existing <canvas>-element:

<canvas id="my-canvas-element"></canvas>

<script src="dist/main.js"></script>
<script>
   
   const canvasElement = document.getElementById('my-canvas-element');
   const imageData = new ostrich.OstrichImageData(/*...*/);
   
   ostrich.initializeElement(canvasElement, imageData);
</script>

ostrich.OstrichImageData

Image data to be rendered has to be passed as an instance of ostrich.OstrichImageData to ostrich.initializeElement:

// image data is passed by a Int16Array containing the actual data accompinied by dimensionality information as a three-valued array
const dimensions = [10, 600, 800]; // depth, height, width
const data = new Int16Array(dimensions[0] * dimensions[1] * dimensions[2]);

const imageData = new ostrich.OstrichImageData(data, dimensions);

Methods

Events

The following events are dispatched on an initialized <canvas>-element:

Tools

In addition to the general API, ostrich comes with several tools to interact with a loaded image. All tools have to be activated on an initialized image, e.g.:

const canvasElement = document.getElementById('my-canvas-element');
const imageData = new ostrich.OstrichImageData(/*...*/);

ostrich.initializeElement(canvasElement, imageData);
ostrich.activateTool(canvasElement, new ostrich.SliceScrollingTool());

All tools