@itk-wasm/downsample v1.6.0

@itk-wasm/downsample

Pipelines for downsampling images.

💻 Live API Demo ✨

🕮 Documentation 📚

Installation

npm install @itk-wasm/downsample

Usage

Browser interface

Import:

import {
  downsampleBinShrink,
  downsampleLabelImage,
  downsampleSigma,
  downsample,
  gaussianKernelRadius,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
} from "@itk-wasm/downsample"

downsampleBinShrink

Apply local averaging and subsample the input image.

async function downsampleBinShrink(
  input: Image,
  options: DownsampleBinShrinkOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleBinShrinkResult>

DownsampleBinShrinkOptions interface:

DownsampleBinShrinkResult interface:

downsampleLabelImage

Apply a smoothing anti-alias filter and subsample the input image.

async function downsampleLabelImage(
  input: Image,
  options: DownsampleLabelImageOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleLabelImageResult>

DownsampleLabelImageOptions interface:

DownsampleLabelImageResult interface:

downsampleSigma

Compute gaussian kernel sigma values in pixel units for downsampling.

async function downsampleSigma(
  options: DownsampleSigmaOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleSigmaResult>

DownsampleSigmaOptions interface:

DownsampleSigmaResult interface:

downsample

Apply a smoothing anti-alias filter and subsample the input image.

async function downsample(
  input: Image,
  options: DownsampleOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleResult>

DownsampleOptions interface:

DownsampleResult interface:

gaussianKernelRadius

Radius in pixels required for effective discrete gaussian filtering.

async function gaussianKernelRadius(
  options: GaussianKernelRadiusOptions = { size: [] as number[], sigma: [{}, ], }
) : Promise<GaussianKernelRadiusResult>

GaussianKernelRadiusOptions interface:

GaussianKernelRadiusResult interface:

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 {
  downsampleBinShrinkNode,
  downsampleLabelImageNode,
  downsampleSigmaNode,
  downsampleNode,
  gaussianKernelRadiusNode,
} from "@itk-wasm/downsample"

downsampleBinShrinkNode

Apply local averaging and subsample the input image.

async function downsampleBinShrinkNode(
  input: Image,
  options: DownsampleBinShrinkNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleBinShrinkNodeResult>

DownsampleBinShrinkNodeOptions interface:

DownsampleBinShrinkNodeResult interface:

downsampleLabelImageNode

Apply a smoothing anti-alias filter and subsample the input image.

async function downsampleLabelImageNode(
  input: Image,
  options: DownsampleLabelImageNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleLabelImageNodeResult>

DownsampleLabelImageNodeOptions interface:

DownsampleLabelImageNodeResult interface:

downsampleSigmaNode

Compute gaussian kernel sigma values in pixel units for downsampling.

async function downsampleSigmaNode(
  options: DownsampleSigmaNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleSigmaNodeResult>

DownsampleSigmaNodeOptions interface:

DownsampleSigmaNodeResult interface:

downsampleNode

Apply a smoothing anti-alias filter and subsample the input image.

async function downsampleNode(
  input: Image,
  options: DownsampleNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleNodeResult>

DownsampleNodeOptions interface:

DownsampleNodeResult interface:

gaussianKernelRadiusNode

Radius in pixels required for effective discrete gaussian filtering.

async function gaussianKernelRadiusNode(
  options: GaussianKernelRadiusNodeOptions = { size: [] as number[], sigma: [{}, ], }
) : Promise<GaussianKernelRadiusNodeResult>

GaussianKernelRadiusNodeOptions interface:

GaussianKernelRadiusNodeResult interface: