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

#include <wx_idphoto.h>

Public Member Functions

 WXIDPhoto (WXDeviceType deviceType=kDeviceCPU)
 WXIDPhoto构造函数 More...
 
const std::shared_ptr< WXImage > makeIDPhoto (const std::shared_ptr< WXImage > &inImg, const WXIDPhotoConfig &config)
 证件照制作接口 More...
 
WXImage * makeIDPhoto (const WXImage *inImg, const WXIDPhotoConfig &config)
 证件照制作接口 More...
 
const std::shared_ptr< WXImage > makeIDPhoto (const std::shared_ptr< WXImage > &inImg, const WXIDPhotoConfig &config, const std::shared_ptr< WXIDPhotoPreDetectResult > &preResult)
 证件照制作接口 More...
 
WXImage * makeIDPhoto (const WXImage *inImg, const WXIDPhotoConfig &config, const WXIDPhotoPreDetectResult *preResult)
 
std::shared_ptr< WXIDPhotoPreDetectResult > preDetect (const std::shared_ptr< WXImage > &inImg)
 证件照环境检测接口 More...
 
WXIDPhotoPreDetectResult * preDetect (const WXImage *inImg)
 证件照环境检测接口 More...
 
void setSettings (const std::shared_ptr< WXIDPhotoSettings > &settings)
 证件照制作或者环境检测配置设置 More...
 
void setSettings (const WXIDPhotoSettings *settings)
 证件照制作或者环境检测配置设置 More...
 

Detailed Description

WXIDPhoto

class WXIDPhoto

Constructor & Destructor Documentation

◆ WXIDPhoto()

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

WXIDPhoto构造函数

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

Member Function Documentation

◆ makeIDPhoto() [1/4]

const std::shared_ptr< WXImage > wonxai::WXIDPhoto::makeIDPhoto ( const std::shared_ptr< WXImage > &  inImg,
const WXIDPhotoConfig &  config 
)

证件照制作接口

Parameters
[in]inImg- 待制作证件照的原图 WXImage
[in]config- 证件照相关配置 WXIDPhotoConfig
Returns
制作好的证件照图片 WXImage
Exceptions
WXException

◆ makeIDPhoto() [2/4]

const std::shared_ptr< WXImage > wonxai::WXIDPhoto::makeIDPhoto ( const std::shared_ptr< WXImage > &  inImg,
const WXIDPhotoConfig &  config,
const std::shared_ptr< WXIDPhotoPreDetectResult > &  preResult 
)

证件照制作接口

makeIDPhoto2

Parameters
[in]inImg待制作证件照的原图 WXImage
[in]config证件照相关配置 WXIDPhotoConfig
[in]preResult预检测接口"preDetect"的返回值 WXIDPhotoPreDetectResult 
可以为nullptr，
  调用本接口前，如果已经对本图片调用了preDetect预检测接口，
  并且获取了检测结果preResult，传入这个参数，
  可以一定程度提升makeIDPhoto的效率，
  如果没有进行预检测，本参数也可以直接传入nullptr；
Returns
制作好的证件照图片 WXImage
Exceptions
WXException

◆ makeIDPhoto() [3/4]

WXImage * wonxai::WXIDPhoto::makeIDPhoto ( const WXImage *  inImg,
const WXIDPhotoConfig &  config 
)

证件照制作接口

See also
makeIDPhoto

◆ makeIDPhoto() [4/4]

WXImage * wonxai::WXIDPhoto::makeIDPhoto ( const WXImage *  inImg,
const WXIDPhotoConfig &  config,
const WXIDPhotoPreDetectResult *  preResult 
)

证件照制作接口

See also
makeIDPhoto2

◆ preDetect() [1/2]

std::shared_ptr< WXIDPhotoPreDetectResult > wonxai::WXIDPhoto::preDetect ( const std::shared_ptr< WXImage > &  inImg)

证件照环境检测接口

Note
只有证件照服务端版本SDK才能调用
Parameters
inImg待检测的图片 WXImage
Returns
检测结果 WXIDPhotoPreDetectResult

◆ preDetect() [2/2]

WXIDPhotoPreDetectResult * wonxai::WXIDPhoto::preDetect ( const WXImage *  inImg)

证件照环境检测接口

See also
preDetect

◆ setSettings() [1/2]

void wonxai::WXIDPhoto::setSettings ( const std::shared_ptr< WXIDPhotoSettings > &  settings)

证件照制作或者环境检测配置设置

Note
本函数，一般情况下用不到，可以不考虑
Parameters
settings设置 WXIDPhotoSettings

◆ setSettings() [2/2]

void wonxai::WXIDPhoto::setSettings ( const WXIDPhotoSettings *  settings)

证件照制作或者环境检测配置设置

See also
setSettings
Parameters
settings设置 WXIDPhotoSettings
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.2