Pipelines for downsampling images.
npm install @itk-wasm/downsampleImport:
import {
downsampleBinShrink,
downsampleLabelImage,
downsampleSigma,
downsample,
gaussianKernelRadius,
setPipelinesBaseUrl,
getPipelinesBaseUrl,
} from "@itk-wasm/downsample"Apply local averaging and subsample the input image.
async function downsampleBinShrink(
input: Image,
options: DownsampleBinShrinkOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleBinShrinkResult>| Parameter | Type | Description |
|---|---|---|
input |
Image | Input image |
DownsampleBinShrinkOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
informationOnly |
boolean | Generate output image information only. Do not process pixels. |
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. |
DownsampleBinShrinkResult interface:
| Property | Type | Description |
|---|---|---|
downsampled |
Image | Output downsampled image |
webWorker |
Worker | WebWorker used for computation. |
Apply a smoothing anti-alias filter and subsample the input image.
async function downsampleLabelImage(
input: Image,
options: DownsampleLabelImageOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleLabelImageResult>| Parameter | Type | Description |
|---|---|---|
input |
Image | Input image |
DownsampleLabelImageOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
cropRadius |
number[] | Optional crop radius in pixel units. |
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. |
DownsampleLabelImageResult interface:
| Property | Type | Description |
|---|---|---|
downsampled |
Image | Output downsampled image |
webWorker |
Worker | WebWorker used for computation. |
Compute gaussian kernel sigma values in pixel units for downsampling.
async function downsampleSigma(
options: DownsampleSigmaOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleSigmaResult>| Parameter | Type | Description |
|---|
DownsampleSigmaOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
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. |
DownsampleSigmaResult interface:
| Property | Type | Description |
|---|---|---|
sigma |
JsonCompatible | Output sigmas in pixel units. |
webWorker |
Worker | WebWorker used for computation. |
Apply a smoothing anti-alias filter and subsample the input image.
async function downsample(
input: Image,
options: DownsampleOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleResult>| Parameter | Type | Description |
|---|---|---|
input |
Image | Input image |
DownsampleOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
cropRadius |
number[] | Optional crop radius in pixel units. |
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. |
DownsampleResult interface:
| Property | Type | Description |
|---|---|---|
downsampled |
Image | Output downsampled image |
webWorker |
Worker | WebWorker used for computation. |
Radius in pixels required for effective discrete gaussian filtering.
async function gaussianKernelRadius(
options: GaussianKernelRadiusOptions = { size: [] as number[], sigma: [{}, ], }
) : Promise<GaussianKernelRadiusResult>| Parameter | Type | Description |
|---|
GaussianKernelRadiusOptions interface:
| Property | Type | Description |
|---|---|---|
size |
number[] | Size in pixels |
sigma |
number[] | Sigma in pixel units |
maxKernelWidth |
number | Maximum kernel width in pixels. |
maxKernelError |
number | Maximum kernel error. |
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. |
GaussianKernelRadiusResult interface:
| Property | Type | Description |
|---|---|---|
radius |
JsonCompatible | Output kernel radius. |
webWorker |
Worker | WebWorker used for computation. |
Set base URL for WebAssembly assets when vendored.
function setPipelinesBaseUrl(
baseUrl: string | URL
) : voidGet base URL for WebAssembly assets when vendored.
function getPipelinesBaseUrl() : string | URLImport:
import {
downsampleBinShrinkNode,
downsampleLabelImageNode,
downsampleSigmaNode,
downsampleNode,
gaussianKernelRadiusNode,
} from "@itk-wasm/downsample"Apply local averaging and subsample the input image.
async function downsampleBinShrinkNode(
input: Image,
options: DownsampleBinShrinkNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleBinShrinkNodeResult>| Parameter | Type | Description |
|---|---|---|
input |
Image | Input image |
DownsampleBinShrinkNodeOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
informationOnly |
boolean | Generate output image information only. Do not process pixels. |
DownsampleBinShrinkNodeResult interface:
| Property | Type | Description |
|---|---|---|
downsampled |
Image | Output downsampled image |
Apply a smoothing anti-alias filter and subsample the input image.
async function downsampleLabelImageNode(
input: Image,
options: DownsampleLabelImageNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleLabelImageNodeResult>| Parameter | Type | Description |
|---|---|---|
input |
Image | Input image |
DownsampleLabelImageNodeOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
cropRadius |
number[] | Optional crop radius in pixel units. |
DownsampleLabelImageNodeResult interface:
| Property | Type | Description |
|---|---|---|
downsampled |
Image | Output downsampled image |
Compute gaussian kernel sigma values in pixel units for downsampling.
async function downsampleSigmaNode(
options: DownsampleSigmaNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleSigmaNodeResult>| Parameter | Type | Description |
|---|
DownsampleSigmaNodeOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
DownsampleSigmaNodeResult interface:
| Property | Type | Description |
|---|---|---|
sigma |
JsonCompatible | Output sigmas in pixel units. |
Apply a smoothing anti-alias filter and subsample the input image.
async function downsampleNode(
input: Image,
options: DownsampleNodeOptions = { shrinkFactors: [] as number[], }
) : Promise<DownsampleNodeResult>| Parameter | Type | Description |
|---|---|---|
input |
Image | Input image |
DownsampleNodeOptions interface:
| Property | Type | Description |
|---|---|---|
shrinkFactors |
number[] | Shrink factors |
cropRadius |
number[] | Optional crop radius in pixel units. |
DownsampleNodeResult interface:
| Property | Type | Description |
|---|---|---|
downsampled |
Image | Output downsampled image |
Radius in pixels required for effective discrete gaussian filtering.
async function gaussianKernelRadiusNode(
options: GaussianKernelRadiusNodeOptions = { size: [] as number[], sigma: [{}, ], }
) : Promise<GaussianKernelRadiusNodeResult>| Parameter | Type | Description |
|---|
GaussianKernelRadiusNodeOptions interface:
| Property | Type | Description |
|---|---|---|
size |
number[] | Size in pixels |
sigma |
number[] | Sigma in pixel units |
maxKernelWidth |
number | Maximum kernel width in pixels. |
maxKernelError |
number | Maximum kernel error. |
GaussianKernelRadiusNodeResult interface:
| Property | Type | Description |
|---|---|---|
radius |
JsonCompatible | Output kernel radius. |