0.1.0 • Published 1 year ago

nornir v0.1.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

nornir

npm version

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>
ParameterTypeDescription
imageImageInput image

IrRefineGridOptions interface:

PropertyTypeDescription
webWorkernull or Worker or booleanWebWorker 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.
noCopybooleanWhen SharedArrayBuffer's are not available, do not copy inputs.

IrRefineGridResult interface:

PropertyTypeDescription
outputImageOutput image
webWorkerWorkerWebWorker 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>
ParameterTypeDescription
imageImageInput image

IrRefineGridNodeResult interface:

PropertyTypeDescription
outputImageOutput image
0.1.0

1 year ago