Skip to content

createGraphAPI

TypeScript helpershelperOpenCV 5.0.0
ARGUMENTSSee signature below
HELPERcreateGraphAPI
RETURN TYPESee signature below
Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

TypeScript conveniences for the native CPU graph API and Python's graph factories.

export declare const createGraphAPI: (cv: MainModule) => {
    GArray: {
        Bool: () => import("../lib/opencv.js").GArray_bool;
        Int: () => import("../lib/opencv.js").GArray_int;
        Int64: () => import("../lib/opencv.js").GArray_int64_t;
        UInt64: () => import("../lib/opencv.js").GArray_uint64_t;
        Double: () => import("../lib/opencv.js").GArray_double;
        Float: () => import("../lib/opencv.js").GArray_float;
        String: () => import("../lib/opencv.js").GArray_string;
        Point: () => import("../lib/opencv.js").GArray_Point2i;
        Point2f: () => import("../lib/opencv.js").GArray_Point2f;
        Point3f: () => import("../lib/opencv.js").GArray_Point3f;
        Size: () => import("../lib/opencv.js").GArray_Size;
        Rect: () => import("../lib/opencv.js").GArray_Rect;
        Mat: () => import("../lib/opencv.js").GArray_Mat;
        Scalar: () => import("../lib/opencv.js").GArray_Scalar;
        Prim: () => import("../lib/opencv.js").GArray_Prim;
    };
    GOpaque: {
        Bool: () => import("../lib/opencv.js").GOpaque_bool;
        Int: () => import("../lib/opencv.js").GOpaque_int;
        Int64: () => import("../lib/opencv.js").GOpaque_int64_t;
        UInt64: () => import("../lib/opencv.js").GOpaque_uint64_t;
        Double: () => import("../lib/opencv.js").GOpaque_double;
        Float: () => import("../lib/opencv.js").GOpaque_float;
        String: () => import("../lib/opencv.js").GOpaque_string;
        Point: () => import("../lib/opencv.js").GOpaque_Point;
        Point2f: () => import("../lib/opencv.js").GOpaque_Point2f;
        Point3f: () => import("../lib/opencv.js").GOpaque_Point3f;
        Size: () => import("../lib/opencv.js").GOpaque_Size;
        Rect: () => import("../lib/opencv.js").GOpaque_Rect;
    };
    gin: (...values: GraphValue[]) => GraphValue[];
    descr_of: (...values: Mat[]) => import("./named.js").GraphMatDescriptor[];
    op: {
        <const Inputs extends GraphPorts, const Outputs extends GraphPorts>(id: string, signature: TypedGraphSignature<Inputs, Outputs>): TypedGraphOperation<Inputs, Outputs>;
        (id: string, signature: {
            inputs: number;
            outputs: number;
            outMeta: GraphMetadataFunction;
        }): GOperation;
    };
    kernel: {
        <Inputs extends GraphPorts, Outputs extends GraphPorts>(operation: TypedGraphOperation<Inputs, Outputs>, run: TypedGraphKernel<NoInfer<Inputs>, NoInfer<Outputs>>): GKernelPackage;
        (operation: GOperation, run: GraphKernelFunction): GKernelPackage;
    };
    kernels: (...packages: GKernelPackage[]) => GKernelPackage;
    networks: (...parameters: gapi_dnn_Params[]) => gapi_GNetPackage;
    compile_args: (...values: (GKernelPackage | GCompileArg | gapi_streaming_queue_capacity | gapi_GNetPackage)[]) => import("../lib/opencv.js").GCompileArgs;
    GIn: (nodes: readonly import("./named.js").GraphNode[]) => import("../lib/opencv.js").GProtoInputArgs;
    GOut: (nodes: readonly import("./named.js").GraphNode[]) => import("../lib/opencv.js").GProtoOutputArgs;
};

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.