Skip to content

aruco_RefineParameters

objdetectclassOpenCV 5.0.0
import { aruco_RefineParameters } from '@banou/opencv-wasm'

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

ARGUMENTSConstructor or factory
CLASSaruco_RefineParameters
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.

struct RefineParameters is used by ArucoDetector

Constructors and members

static new

Create an owned aruco_RefineParameters object. Release native handles with using or delete().

new(minRepDistance: number, errorCorrectionRate: number, checkAllOrders: boolean): aruco_RefineParameters;
4 available overloads
new(): aruco_RefineParameters;
new(minRepDistance: number): aruco_RefineParameters;
new(minRepDistance: number, errorCorrectionRate: number): aruco_RefineParameters;
new(minRepDistance: number, errorCorrectionRate: number, checkAllOrders: boolean): aruco_RefineParameters;
minRepDistance

min rep distance argument (number).

errorCorrectionRate

error correction rate argument (number).

checkAllOrders

check all orders argument (boolean).

Returns

The aruco_RefineParameters result.

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.

minRepDistance

minRepDistance minimum distance between the corners of the rejected candidate and the reprojected marker in order to consider it as a correspondence.

minRepDistance: number;

errorCorrectionRate

errorCorrectionRate rate of allowed erroneous bits respect to the error correction capability of the used dictionary.

-1 ignores the error correction step.

errorCorrectionRate: number;

checkAllOrders

checkAllOrders consider the four possible corner orders in the rejectedCorners array.

If it set to false, only the provided corner order is considered (default true).

checkAllOrders: boolean;

readRefineParameters

Read a new set of RefineParameters from FileNode (use FileStorage.root()).

readRefineParameters(fn: FileNode): boolean;
fn

fn argument (FileNode).

Returns

The boolean result.

writeRefineParameters

Write a set of RefineParameters to FileStorage

writeRefineParameters(fs: FileStorage, name: EmbindString): boolean;
2 available overloads
writeRefineParameters(fs: FileStorage): boolean;
writeRefineParameters(fs: FileStorage, name: EmbindString): boolean;
fs

fs argument (FileStorage).

name

name argument (EmbindString).

Returns

The boolean 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.