nornir

Nornir takes large sets of overlapping images in 2D and produces registered, i.e. aligned, 2D and 3D volumes of any size and scale.

Installation

npm install nornir

Usage

Browser interface

Import:

import {
  irRefineGrid,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
} from "nornir"

irRefineGrid

Refine the alignment of a grid of collected tiles.

async function irRefineGrid(
  image: Image,
  options: IrRefineGridOptions = {}
) : Promise<IrRefineGridResult>

| Parameter | Type | Description | | :-------: | :-----: | :---------- | | image | Image | Input image |

IrRefineGridOptions interface:

| Property | Type | Description | | :---------: | :-------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------- | | webWorker | null or Worker or boolean | WebWorker for computation. Set to null to create a new worker. Or, pass an existing worker. Or, set to false to run in the current thread / worker. | | noCopy | boolean | When SharedArrayBuffer's are not available, do not copy inputs. |

IrRefineGridResult interface:

| Property | Type | Description | | :---------: | :------: | :------------------------------ | | output | Image | Output image | | webWorker | Worker | WebWorker used for computation. |

setPipelinesBaseUrl

Set base URL for WebAssembly assets when vendored.

function setPipelinesBaseUrl(
  baseUrl: string | URL
) : void

getPipelinesBaseUrl

Get base URL for WebAssembly assets when vendored.

function getPipelinesBaseUrl() : string | URL

Node interface

Import:

import {
  irRefineGridNode,
} from "nornir"

irRefineGridNode

Refine the alignment of a grid of collected tiles.

async function irRefineGridNode(
  image: Image
) : Promise<IrRefineGridNodeResult>

| Parameter | Type | Description | | :-------: | :-----: | :---------- | | image | Image | Input image |

IrRefineGridNodeResult interface:

| Property | Type | Description | | :------: | :-----: | :----------- | | output | Image | Output image |