Skip to content
opencv-wasm

img_hash_ImgHashBase

img_hashclassOpenCV 5.0.0
import { img_hash_ImgHashBase } from '@banou/opencv-wasm'

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

ARGUMENTSConstructor or factory
CLASSimg_hash_ImgHashBase
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. Inherits Algorithm.

The base class for image hash algorithms

Upstream declaration ↗

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.

compute

Computes hash of the input image

compute(inputArr: Mat, outputArr: Mat): void;
inputArr

input image want to compute hash value

outputArr

Output destination, filled by the native operation. hash of the image

Upstream declaration ↗

compare

Compare the hash value between inOne and inTwo

compare(hashOne: Mat, hashTwo: Mat): number;
hashOne

Hash value one

hashTwo

Hash value two

Returns

value indicate similarity between inOne and inTwo, the meaning of the value vary from algorithms to algorithms

Upstream declaration ↗

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.