createAlignMTB
import { createAlignMTB } from '@banou/opencv-wasm'Use after await initOpenCV(). See the initialization and named imports guide.
ARGUMENTSmax_bits, exclude_range, cut
FUNCTIONcreateAlignMTB
RETURN TYPEAlignMTB | null
Creates AlignMTB object
createAlignMTB(max_bits: number, exclude_range: number, cut: boolean): AlignMTB | null;4 available overloads
createAlignMTB(): AlignMTB | null;createAlignMTB(max_bits: number): AlignMTB | null;createAlignMTB(max_bits: number, exclude_range: number): AlignMTB | null;createAlignMTB(max_bits: number, exclude_range: number, cut: boolean): AlignMTB | null;max_bitslogarithm to the base 2 of maximal shift in each dimension. Values of 5 and 6 are usually good enough (31 and 63 pixels shift respectively).
exclude_rangerange for exclusion bitmap that is constructed to suppress noise around the median value.
cutif true cuts images, otherwise fills the new regions with zeros.
Returns
The AlignMTB | null result.
These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.