0.4.1 • Published 8 months ago

@itk-wasm/compare-meshes v0.4.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
8 months ago

@itk-wasm/compare-meshes

npm version

Compare meshes and polydata for regression testing.

Installation

npm install @itk-wasm/compare-meshes

Usage

Browser interface

Import:

import {
  compareMeshes,
  setPipelinesBaseUrl,
  getPipelinesBaseUrl,
} from "@itk-wasm/compare-meshes"

compareMeshes

Compare meshes with a tolerance for regression testing.

async function compareMeshes(
  testMesh: Mesh,
  options: CompareMeshesOptions = { baselineMeshes: [] as Mesh[], }
) : Promise<CompareMeshesResult>
ParameterTypeDescription
testMeshMeshThe input test mesh

CompareMeshesOptions interface:

PropertyTypeDescription
baselineMeshesMesh[]Baseline images to compare against
pointsDifferenceThresholdnumberDifference for point components to be considered different.
numberOfDifferentPointsTolerancenumberNumber of points whose points exceed the difference threshold that can be different before the test fails.
pointDataDifferenceThresholdnumberDifference for point data components to be considered different.
numberOfPointDataTolerancenumberNumber of point data that can exceed the difference threshold before the test fails.
cellDataDifferenceThresholdnumberDifference for cell data components to be considered different.
numberOfCellDataTolerancenumberNumber of cell data that can exceed the difference threshold before the test fails.
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.

CompareMeshesResult interface:

PropertyTypeDescription
metricsJsonCompatibleMetrics for the closest baseline.
pointsDifferenceMeshMeshMesh with the differences between the points of the test mesh and the closest baseline.
pointDataDifferenceMeshMeshMesh with the differences between the point data of the test mesh and the closest baseline.
cellDataDifferenceMeshMeshMesh with the differences between the cell data of the test mesh and the closest baseline.
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 {
  compareMeshesNode,
} from "@itk-wasm/compare-meshes"

compareMeshesNode

Compare meshes with a tolerance for regression testing.

async function compareMeshesNode(
  testMesh: Mesh,
  options: CompareMeshesNodeOptions = { baselineMeshes: [] as Mesh[], }
) : Promise<CompareMeshesNodeResult>
ParameterTypeDescription
testMeshMeshThe input test mesh

CompareMeshesNodeOptions interface:

PropertyTypeDescription
baselineMeshesMesh[]Baseline images to compare against
pointsDifferenceThresholdnumberDifference for point components to be considered different.
numberOfDifferentPointsTolerancenumberNumber of points whose points exceed the difference threshold that can be different before the test fails.
pointDataDifferenceThresholdnumberDifference for point data components to be considered different.
numberOfPointDataTolerancenumberNumber of point data that can exceed the difference threshold before the test fails.
cellDataDifferenceThresholdnumberDifference for cell data components to be considered different.
numberOfCellDataTolerancenumberNumber of cell data that can exceed the difference threshold before the test fails.

CompareMeshesNodeResult interface:

PropertyTypeDescription
metricsJsonCompatibleMetrics for the closest baseline.
pointsDifferenceMeshMeshMesh with the differences between the points of the test mesh and the closest baseline.
pointDataDifferenceMeshMeshMesh with the differences between the point data of the test mesh and the closest baseline.
cellDataDifferenceMeshMeshMesh with the differences between the cell data of the test mesh and the closest baseline.
0.4.1

8 months ago

0.4.0

10 months ago

0.3.0

1 year ago

0.2.0

1 year ago

0.1.0

1 year ago