wx_human_seg 3.0.0
Public Member Functions | Static Public Member Functions | List of all members
wonxai::WXHumanMatting Class Referencefinal

#include <wx_human_matting.h>

Public Member Functions

 WXHumanMatting (WXDeviceType deviceType=kDeviceCPU)
 WXHumanMatting 构造函数 More...
 
void matting (const uint8_t *inRGB, int width, int height, float *outAlpha)
 matting函数，输入rgb像素图，输出alpha图 More...
 
std::shared_ptr< WXImage > removeBackground (const std::shared_ptr< WXImage > &inImage, const std::shared_ptr< WXImage > &bkImage)
 图片去背景或换背景 More...
 
WXImage * removeBackground (const WXImage *inImage, const WXImage *bkImage)
 图片去背景或换背景 More...
 

Static Public Member Functions

static void initialize ()
 初始化SDK，调用其他接口（除license相关接口外）之前，需要先调用这个函数。 More...
 
static void terminate ()
 进程结束前，调用此函数进行资源清理 More...
 
static const char * version ()
 返回SDK版本号 More...
 

Detailed Description

WXHumanMatting

class WXHumanMatting

Constructor & Destructor Documentation

◆ WXHumanMatting()

wonxai::WXHumanMatting::WXHumanMatting ( WXDeviceType  deviceType = kDeviceCPU)

WXHumanMatting 构造函数

Parameters
[in]deviceType使用GPU还是CPU来创建推理引擎
Note
只有证件照服务端版本的SDK才支持GPU版本的推理引擎，其他版本SDK只能使用CPU版本引擎
Exceptions
WXException

Member Function Documentation

◆ initialize()

static void wonxai::WXHumanMatting::initialize ( )
static

初始化SDK，调用其他接口（除license相关接口外）之前，需要先调用这个函数。

Deprecated:
: 本函数不再推荐使用，请换成WXSDKInitWithLicense 函数
Note
先调用WXSDKLicense::setLicense函数再调用本函数
一个进程只需要调用一次，不需要反复调用
Exceptions
WXException

◆ matting()

void wonxai::WXHumanMatting::matting ( const uint8_t *  inRGB,
int  width,
int  height,
float *  outAlpha 
)

matting函数，输入rgb像素图，输出alpha图

Note
免费版SDK，不能使用本接口，会抛出异常
调用之前，outAlpha内存空间由调用者分配，本函数不为它分配内存， 需要确保最少有(width * height * sizeof(float))个字节的存储空间
Parameters
[in]inRGBrgb像素图内存块，必须是连续存储的rgb格式，其长度必须是width * height * 3，RGBRGBRGB...
[in]widthinRGB宽度
[in]heightinRGB高度
[out]outAlpha输出的0-1.0之间的alpha图，浮点型，宽高和inRGB保持一致，内存由调用者分配，也是连续存储
Exceptions
WXException

◆ removeBackground() [1/2]

std::shared_ptr< WXImage > wonxai::WXHumanMatting::removeBackground ( const std::shared_ptr< WXImage > &  inImage,
const std::shared_ptr< WXImage > &  bkImage 
)

图片去背景或换背景

removeBackground

Note
免费版SDK，只能换背景，不能去背景（不能返回透明背景图片）
Parameters
[in]inImage输入图，可从WXImage 类创建
[in]bkImage背景图，可从WXImage 类创建， 
当本参数设置为nullptr时：
    对于付费版SDK，将返回透明背景图,
    对于免费版SDK，将返回白色背景图
Returns
返回去背景或换背景后的图片
Exceptions
WXException

◆ removeBackground() [2/2]

WXImage * wonxai::WXHumanMatting::removeBackground ( const WXImage *  inImage,
const WXImage *  bkImage 
)

图片去背景或换背景

See also
removeBackground

◆ terminate()

static void wonxai::WXHumanMatting::terminate ( )
static

进程结束前，调用此函数进行资源清理

Deprecated:
: 本函数不再推荐使用，请换成WXSDKTerminate 函数
Note
一个进程只需要调用一次，不需要反复调用
如果不调动此函数，直接结束进程，有可能在进程退出前发生异常

◆ version()

static const char * wonxai::WXHumanMatting::version ( )
static

返回SDK版本号

Deprecated:
: 本函数不再推荐使用，请换成WXSDKVersion 函数
Returns
SDK版本号
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.2