Skip to content

Algorithm

Core and matricesclassOpenCV 5.0.0
import { Algorithm } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

ARGUMENTSConstructor or factory
CLASSAlgorithm
RETURN TYPEOwned native handle
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Native object: release it with using or delete(). Factories can return null; check before calling methods.

example: samples/cpp/snippets/detect_blob.cpp An example using the BLOB to detect and filter region. This is a base class for all more or less complex algorithms in OpenCV

especially for classes of algorithms, for which there can be multiple implementations. The examples are stereo correspondence (for which there are algorithms like block matching, semi-global block matching, graph-cut etc.), background subtraction (which can be done using mixture-of-gaussians models, codebook-based algorithm etc.), optical flow (block matching, Lucas-Kanade, Horn-Schunck etc.).

Here is example of SimpleBlobDetector use in your application via Algorithm interface:

Constructors and members

clone

Create another handle to the same native object. This retains the object without copying its pixels or algorithm state; dispose both handles separately.

clone(): this;
Returns

The this result.

clear

Clears the algorithm state

clear(): void;

empty

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

empty(): boolean;
Returns

The boolean result.

save

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

save(filename: EmbindString): void;
filename

filename argument (EmbindString).

getDefaultName

Returns the algorithm string identifier. This string is used as top level xml/yml node tag when the object is saved to a file or string.

getDefaultName(): string;
Returns

The string result.

write

Stores algorithm parameters in a file storage

write(fs: FileStorage): void;
fs

fs argument (FileStorage).

write1

Stores algorithm parameters in a file storage

write1(fs: FileStorage, name: EmbindString): void;
fs

fs argument (FileStorage).

name

name argument (EmbindString).

read

Reads algorithm parameters from a file storage

read(fn: FileNode): void;
fn

fn argument (FileNode).

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.