API v1.2.0（Javascript）

API 文档（Javascript接口）

1. Javascript API 目录

2. Javascript API 详细说明

1. Javascript API 目录

2. API 详细说明

core

FCVImageType

说明： 图像类型枚举

const FCVImageType {
    GRAY_U8 : 0,            // 单通道，unsigned char存储
    GRAY_U16,               // 单通道，unsigned short存储
    GRAY_S16,               // 单通道，signed short存储
    GRAY_S32,               // 单通道，int32存储
    GRAY_F32,               // 单通道，float32存储
    GRAY_F64,               // 单通道，double存储
    PLA_BGR_U8 : 20,        // 三通道，unsigned char存储，存储顺序：BBB...GGG...RRR...
    PLA_RGB_U8,             // 三通道，unsigned char存储，存储顺序：RRR...GGG...BBB...
    PKG_BGR_U8,             // 三通道，unsigned char存储，存储顺序：BGRBGR...
    PKG_RGB_U8,             // 三通道，unsigned char存储，存储顺序：RGBRGB...
    PLA_BGRA_U8,            // 四通道，unsigned char存储，存储顺序：BBB...GGG...RRR...AAA...
    PLA_RGBA_U8,            // 四通道，unsigned char存储，存储顺序：RRR...GGG...BBB...AAA...
    PKG_BGRA_U8,            // 四通道，unsigned char存储，存储顺序：BGRABGRA...
    PKG_RGBA_U8,            // 四通道，unsigned char存储，存储顺序：RGBARGBA...
    PLA_BGR_F32 : 40,       // 三通道，float存储，存储顺序：BBB...GGG...RRR...
    PLA_RGB_F32,            // 三通道，float存储，存储顺序：RRR...GGG...BBB...
    PKG_BGR_F32,            // 三通道，float存储，存储顺序：BGRBGR...
    PKG_RGB_F32,            // 三通道，float存储，存储顺序：RGBRGB...
    PLA_BGRA_F32,           // 四通道，float存储，存储顺序：BBB...GGG...RRR...AAA...
    PLA_RGBA_F32,           // 四通道，float存储，存储顺序：RRR...GGG...BBB...AAA...
    PKG_BGRA_F32,           // 四通道，float存储，存储顺序：BGRABGRA...
    PKG_RGBA_F32,           // 四通道，float存储，存储顺序：RGBARGBA...
    PKG_BGR_F64,            // 三通道，double存储，存储顺序：BGRBGR...
    PKG_RGB_F64,            // 三通道，double存储，存储顺序：RGBRGB...
    PKG_BGRA_F64,           // 四通道，double存储，存储顺序：BGRABGRA...
    PKG_RGBA_F64,           // 四通道，double存储，存储顺序：RGBARGBA...
    PKG_BGR565_U8,          // 三通道，unsigned char存储，存储顺序：BGRBGR...
    PKG_RGB565_U8,          // 三通道，unsigned char存储，存储顺序：RGBRGB...
    NV12 : 60,              // YUV420SP类型，像素占比为Y:V:U=4:1:1，存储顺序：YYY...UVUV...
    NV21,                   // YVU420SP类型，像素占比为Y:U:V=4:1:1，存储顺序：YYY...VUVU...
    I420,                   // YUV420P类型，像素占比为Y:U:V=4:1:1，存储顺序：YYY...UUU...VVV...
};

InterpolationType

说明： 插值类型枚举

const InterpolationType = {
    INTER_NEAREST : 0,          // 最近邻插值
    INTER_LINEAR,               // 双线性插值
    INTER_CUBIC,                // 立方插值
    INTER_AREA,                 // 区域插值
    WARP_INVERSE_MAP : 16       // 双线性插值（变换矩阵不求逆）
};

BorderType

说明： 边缘填充类型

const BorderType = {
    BORDER_CONSTANT    : 0,
    BORDER_REPLICATE   : 1,
    BORDER_REFLECT     : 2,
    BORDER_WRAP        : 3,
    BORDER_REFLECT_101 : 4,
    BORDER_TRANSPARENT : 5
};

NormType

说明： 范数类型

const NormType = {
    NORM_INF       : 0,    // 无穷范数，所有元素中绝对值最大的数
    NORM_L1,               // L1范数，各个元素绝对值之和
    NORM_L2                // L2范数，各个元素平方和的平方根
};

RotateType

说明： 旋转类型

const RotateType = {
    CLOCK_WISE_90,     // 顺时针方向旋转90度
    CLOCK_WISE_180,    // 顺时针方向旋转180度
    CLOCK_WISE_270     // 顺时针方向旋转270度
};

Scalar

说明： 长度为4的数组。

Rect

说明： 矩形框类。

class Rect {
    constructor();
    constructor(x, y, width, height);

    setX(x);             // 设置矩形左上角顶点x坐标
    setY(y);             // 设置矩形左上角顶点y坐标
    setWidth(width);     // 设置矩形宽度
    setHeight(height);   // 设置矩形高度
    x();                 // 获取矩形左上角顶点x坐标
    y();                 // 获取矩形左上角顶点y坐标
    width();             // 获取矩形宽度
    height();            // 获取矩形高度
};

Size

说明： 存储宽高数据（整型数）。

class Size {
    constructor();
    constructor(width, height);

    setWidth(width);     // 设置宽度
    setHeight(height);   // 设置高度
    width();             // 获取宽度
    height();            // 获取高度
};

Size2f

说明： 存储宽高数据（浮点数）。

class Size2f {
    constructor();
    constructor(width, height);

    setWidth(width);     // 设置宽度
    setHeight(height);   // 设置高度
    width();             // 获取宽度
    height();            // 获取高度
};

Point

说明： 存储坐标数据（整型数）。

class Point {
    constructor();
    constructor(x, y);

    setX(x);     // 设置x坐标
    setY(y);     // 设置y左边
    x();         // 获取x坐标
    y();         // 获取y坐标
};

Point2f

说明： 存储坐标数据（浮点数）。

class Point2f {
    constructor();
    constructor(x, y);

    setX(x);     // 设置x坐标
    setY(y);     // 设置y左边
    x();         // 获取x坐标
    y();         // 获取y坐标
};

RotatedRect

说明： 存储旋转矩形框数据。

class RotatedRect {
    constructor();
    constructor(x, y, width, height, angle);
    constructor(center, size, angle);

    setCenter(center);     // 设置矩形中心点坐标
    setCenterX(x);         // 设置矩形中心点x坐标
    setCenterY(y);         // 设置矩形中心点y坐标
    setSize(size);         // 设置矩形宽高
    setWidth(width);       // 设置矩形宽度
    setHeight(height);     // 设置矩形高度
    setAngle(angle);       // 设置矩形旋转角度
    center();              // 获取矩形中心点坐标
    centerX();             // 获取矩形中心点x坐标
    centerY();             // 获取矩形中心点y坐标
    size();                // 获取矩形宽高
    width();               // 获取矩形宽度
    height();              // 获取矩形高度
    angle();               // 获取矩形角度
};

Mat

说明： 图像数据类。

class Mat {
    constructor();
    constructor(width, height, type);
    constructor(width, height, type, data, stride);

    width();                  // 获取图像宽度
    height();                 // 获取图像高度
    channels();               // 获取图像通道数
    type();                   // 返回图像类型
    data();                   // 返回数据数组
    clone();                  // 拷贝图像

    /* 
     * 缩放、平移，转化为指定数据类型
     * dst：目标图像
     * dst_type：指定目标图像的类型。
     * scale：缩放系数
     * shift：平移值
     */
    convertTo(dst, dst_type, scale, shift);              
};