nvDentalDet.h 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863
  1. #ifndef NVDENTALDET_H
  2. #define NVDENTALDET_H
  3. #ifdef NVDENTALDET_EXPORTS
  4. #define NVDENTALDET_API __declspec(dllexport)
  5. #else
  6. #define NVDENTALDET_API __declspec(dllimport)
  7. #endif
  8. #include "nvTypes.h"
  9. #ifdef __cplusplus
  10. extern "C" {
  11. #endif
  12. /* DeviceProperty */
  13. /////////////////////////////////////////////////////////////////////////
  14. /// @brief 枚举网络上发现的探测器设备
  15. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  16. /// @param [in out] pDetBuffer 探测器缓冲区指针
  17. /// @param [in] iCount 探测器个数
  18. /// @note 不允许对获取到的缓冲区进行修改或删除,否则会导致程序崩溃
  19. NVDENTALDET_API NV_StatusType NV_EnumDets(NV_DET * pDets, int iBufferSize, int * iCount);
  20. /////////////////////////////////////////////////////////////////////////
  21. /// @brief 使用探测器ID打开探测器,读取配置文件初始化到硬件,并启动温度和状态监控线程
  22. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  23. /// @param [in] uDetID 探测器ID,如果使用DEFAULT_DETID,则默认打开网络上搜索到的第一个设备
  24. /// @note 该函数用户打开探测器,当探测器不再使用时必须调用 @c NV_CloseDet()
  25. /// 推荐在打开探测器设备前使用NV_EnumDets 获取探测器的数量,然后使用此函数打开设备
  26. /// @sa @c NV_CloseDet()
  27. NVDENTALDET_API NV_StatusType NV_OpenDet(NV_DETID uDetID);
  28. /////////////////////////////////////////////////////////////////////////
  29. /// @brief 是否已经打开了探测器
  30. /// @retval bool 返回是否打开的状态值,未打开为false,已打开为true
  31. NVDENTALDET_API bool NV_IsDetOpen();
  32. /////////////////////////////////////////////////////////////////////////
  33. /// @brief 探测器是否处于连接状态
  34. /// @retval bool 返回是否连接的状态值,已断开为false,已连接为true
  35. NVDENTALDET_API bool NV_IsDetConn();
  36. /////////////////////////////////////////////////////////////////////////
  37. /// @brief 关闭探测器,并停止温度和状态监控线程
  38. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  39. /// @note 当探测器关闭时,清理所用资源
  40. /// @sa @c NV_OpenDet()
  41. NVDENTALDET_API NV_StatusType NV_CloseDet();
  42. /////////////////////////////////////////////////////////////////////////
  43. /// @brief 设置时间回调函数,内部温度改变事件、状态改变事件、图像接收到事件等
  44. /// @param [out] pCallback 回调函数指针
  45. /// @param [out] pCallbackData 回调函数附带指针,在回调函数中直接返回
  46. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  47. /// @note 一般调用NV_OpenDet后,直接调用次函数
  48. NVDENTALDET_API NV_StatusType NV_SetEventCallback(NV_EVENT_CALLBACK pCallback, void *pCallbackData);
  49. /////////////////////////////////////////////////////////////////////////
  50. /// @brief 获取时间回调函数,内部温度改变事件、状态改变事件、图像接收到事件等
  51. /// @param [out] pCallback 回调函数指针
  52. /// @param [out] pCallbackData 回调函数附带指针,在回调函数中直接返回
  53. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  54. /// @note 一般调用NV_OpenDet后,直接调用次函数
  55. NVDENTALDET_API NV_StatusType NV_GetEventCallback(NV_EVENT_CALLBACK * pCallback, void **pCallbackData);
  56. /////////////////////////////////////////////////////////////////////////
  57. /// @brief 获取传感器尺寸
  58. /// @param [out] sensorWidth 传感器宽
  59. /// @param [out] sensorHeight 传感器高
  60. /// @param [out] bits 传感器位数
  61. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  62. NVDENTALDET_API NV_StatusType NV_GetSensorSize(int *sensorWidth, int *sensorHeight, int *bits);
  63. /////////////////////////////////////////////////////////////////////////
  64. /// @brief 获取版本信息
  65. /// @param [out] version 探测器版本信息
  66. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  67. NVDENTALDET_API NV_StatusType NV_GetVersion(NV_Version *version);
  68. /////////////////////////////////////////////////////////////////////////
  69. /// @brief 获取探测器序列号
  70. /// @param [out] pBuffer 探测器序列号
  71. /// @param [out] pSize 序列号缓存长度
  72. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  73. NVDENTALDET_API NV_StatusType NV_GetSerialNum(char* pBuffer, unsigned long* pSize);
  74. /* AcquisitionControl */
  75. /////////////////////////////////////////////////////////////////////////
  76. /// @brief 获取探测器支持的采集模式
  77. /// @param [in out] pMode 模式缓冲区指针
  78. /// @param [in] iBufLen 缓冲区长度
  79. /// @param [out] iCnt 支持的模式总数
  80. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  81. NVDENTALDET_API NV_StatusType NV_EnumAcquisitionMode(NV_AcquisitionMode * pMode, int iBufLen, int * iCnt);
  82. /////////////////////////////////////////////////////////////////////////
  83. /// @brief 获取探测器支持的快门模式
  84. /// @param [in out] pMode 模式缓冲区指针
  85. /// @param [in] iBufLen 缓冲区长度
  86. /// @param [out] iCnt 支持的模式总数
  87. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  88. NVDENTALDET_API NV_StatusType NV_EnumShutterMode(NV_ShutterMode * pMode, int iBufLen, int * iCnt);
  89. /////////////////////////////////////////////////////////////////////////
  90. /// @brief 获取探测器支持的binning模式
  91. /// @param [in out] pMode 模式缓冲区指针
  92. /// @param [in] iBufLen 缓冲区长度
  93. /// @param [out] iCnt 支持的模式总数
  94. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  95. NVDENTALDET_API NV_StatusType NV_EnumBinningMode(NV_BinningMode * pMode, int iBufLen, int * iCnt);
  96. /////////////////////////////////////////////////////////////////////////
  97. /// @brief 获取探测器支持的GAIN档位
  98. /// @param [out] iCnt 支持的增益档位总数
  99. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  100. NVDENTALDET_API NV_StatusType NV_EnumGains(int * iCnt);
  101. /////////////////////////////////////////////////////////////////////////
  102. /// @brief 获取探测器支持的数字增益档位
  103. /// @param [out] iCnt 支持的数字增益档位总数
  104. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  105. NVDENTALDET_API NV_StatusType NV_EnumDigitalGains(int * iCnt);
  106. /////////////////////////////////////////////////////////////////////////
  107. /// @brief 获取探测器档位描述信息
  108. /// @param [in] iGainIndex 增益档序号
  109. /// @param [in out] pBuffer 描述信息缓冲区指针
  110. /// @param [in] iBufLen 缓冲区长度
  111. /// @note 增益档位序号从0 开始,最大为支持的总数-1
  112. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  113. NVDENTALDET_API NV_StatusType NV_GetGainDescription(int iGainIndex, char* pBuffer, int iBufLen);
  114. /////////////////////////////////////////////////////////////////////////
  115. /// @brief 获取探测器数字增益档位描述信息
  116. /// @param [in] iGainIndex 数字增益档序号
  117. /// @param [in out] pBuffer 描述信息缓冲区指针
  118. /// @param [in] iBufLen 缓冲区长度
  119. /// @note 增益档位序号从0 开始,最大为支持的总数-1
  120. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  121. NVDENTALDET_API NV_StatusType NV_GetDigitalGainDescription(int iGainIndex, char* pBuffer, int iBufLen);
  122. /////////////////////////////////////////////////////////////////////////
  123. /// @brief 设置采集模式
  124. /// @param [in] aMode 采集模式
  125. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  126. NVDENTALDET_API NV_StatusType NV_SetAcquisitionMode(NV_AcquisitionMode aMode);
  127. /////////////////////////////////////////////////////////////////////////
  128. /// @brief 设置快门模式
  129. /// @param [in] sMode 快门模式
  130. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  131. NVDENTALDET_API NV_StatusType NV_SetShutterMode(NV_ShutterMode sMode);
  132. /////////////////////////////////////////////////////////////////////////
  133. /// @brief 设置Binning模式
  134. /// @param [in] bMode Binning模式
  135. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  136. NVDENTALDET_API NV_StatusType NV_SetBinningMode(NV_BinningMode bMode);
  137. /////////////////////////////////////////////////////////////////////////
  138. /// @brief 获取采集模式
  139. /// @param [out] aMode 采集模式
  140. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  141. NVDENTALDET_API NV_StatusType NV_GetAcquisitionMode(NV_AcquisitionMode *aMode);
  142. /////////////////////////////////////////////////////////////////////////
  143. /// @brief 获取快门模式
  144. /// @param [out] sMode 快门模式
  145. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  146. NVDENTALDET_API NV_StatusType NV_GetShutterMode(NV_ShutterMode *sMode);
  147. /////////////////////////////////////////////////////////////////////////
  148. /// @brief 获取Binning模式
  149. /// @param [out] bMode Binning模式
  150. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  151. NVDENTALDET_API NV_StatusType NV_GetBinningMode(NV_BinningMode *bMode);
  152. /* WorkControl */
  153. /////////////////////////////////////////////////////////////////////////
  154. /// @brief 设置触发输入是否反向
  155. /// @param [out] bReverse 是否反向
  156. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  157. NVDENTALDET_API NV_StatusType NV_SetTriggerInReversionStatus(bool bReverse);
  158. /////////////////////////////////////////////////////////////////////////
  159. /// @brief 获取触发输入是否反向
  160. /// @param [out] bReverse 是否反向
  161. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  162. NVDENTALDET_API NV_StatusType NV_GetTriggerInReversionStatus(bool * bReverse);
  163. /////////////////////////////////////////////////////////////////////////
  164. /// @brief 设置触发输出是否反向
  165. /// @param [out] bReverse 是否反向
  166. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  167. NVDENTALDET_API NV_StatusType NV_SetTriggerOutReversionStatus(bool bReverse);
  168. /////////////////////////////////////////////////////////////////////////
  169. /// @brief 获取触发输出的反向状态
  170. /// @param [out] bReverse 是否反向
  171. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  172. NVDENTALDET_API NV_StatusType NV_GetTriggerOutReversionStatus(bool * bReverse);
  173. /////////////////////////////////////////////////////////////////////////
  174. /// @brief 设置增益档灵敏度
  175. /// @param [in] iGainIndex 增益档序号
  176. /// @note 增益档位序号从0 开始,最大为支持的总数-1
  177. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  178. NVDENTALDET_API NV_StatusType NV_SetGainEx(int iGainIndex);
  179. /////////////////////////////////////////////////////////////////////////
  180. /// @brief 设置数字增益档
  181. /// @param [in] iGainIndex 增益档序号
  182. /// @note 增益档位序号从0 开始,最大为支持的总数-1
  183. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  184. NVDENTALDET_API NV_StatusType NV_SetDigitalGainEx(int iGainIndex);
  185. /////////////////////////////////////////////////////////////////////////
  186. /// @brief 设置ROI模式图像范围
  187. /// @param [in] offsetX 图像起始列
  188. /// @param [in] offsetY 图像起始行
  189. /// @param [in] width 图像宽
  190. /// @param [in] height 图像高
  191. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  192. NVDENTALDET_API NV_StatusType NV_SetImageRange(int offsetX, int offsetY, int width, int height);
  193. /////////////////////////////////////////////////////////////////////////
  194. /// @brief 设置探测器的积分时间(即X射线出线时间),单位0.1ms。当AcquisitionMode是CONTINUE、FALLING_EDGE_TRRIGER及RISING_EDGE_TRIGGER时,以该设定值作为Sensor的积分窗口时间
  195. /// @param [in] expTime 探测器的积分时间(即X射线出线时间)
  196. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  197. /// @note v1.3.0.0版之后的SDK不推荐使用该函数,该函数等效于以下两步操作,
  198. /// 使用NV_SetAcqSpeedCtrlMode将控制模式切换为通过曝光时间控制速度
  199. /// 使用NV_SetAcqSpeedCtrlParam配置了参数
  200. NVDENTALDET_API NV_StatusType NV_SetExpTime(int expTime);
  201. /////////////////////////////////////////////////////////////////////////
  202. /// @brief 设置探测器的采集帧率
  203. /// @param [in] iFPS 采集帧率(会自动根据探测器类型计算探测器的积分时间)
  204. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  205. /// @note v1.3.0.0版之后的SDK不推荐使用该函数,该函数等效于以下两步操作,
  206. /// 使用NV_SetAcqSpeedCtrlMode将控制模式切换为FPS
  207. /// 使用NV_SetAcqSpeedCtrlParam配置了参数
  208. NVDENTALDET_API NV_StatusType NV_SetFramePerSecond(int iFPS);
  209. /////////////////////////////////////////////////////////////////////////
  210. /// @brief 设置探测器的采集速度控制模式
  211. /// @param [in] eAcqSpeedCtrlMode 控制模式(积分时间和FPS控制)
  212. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  213. NVDENTALDET_API NV_StatusType NV_SetAcqSpeedCtrlMode(NV_AcqSpeedCtrlType eAcqSpeedCtrlMode);
  214. /////////////////////////////////////////////////////////////////////////
  215. /// @brief 设置探测器的采集速度控制参数
  216. /// @param [in] eAcqSpeedCtrlMode 控制参数
  217. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  218. /// @note 当控制模式为NV_ACQSPEED_CTRL_EXPTIME时,设置的参数为积分时间,单位为0.1ms
  219. /// 当控制模式为NV_ACQSPEED_CTRL_FPS时,设置的参数为帧率,单位为每秒多少张图
  220. NVDENTALDET_API NV_StatusType NV_SetAcqSpeedCtrlParam(int iParam);
  221. /////////////////////////////////////////////////////////////////////////
  222. /// @brief 设置该序列的最大图像帧数。
  223. /// @param [in] maxFrames 该序列的最大图像帧数。当为0时,不限制图像帧数
  224. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  225. /// @note 当maxFrames不为0时,达到最大帧数会自动停止采集。
  226. NVDENTALDET_API NV_StatusType NV_SetMaxFrames(int maxFrames);
  227. /////////////////////////////////////////////////////////////////////////
  228. /// @brief 获取增益档
  229. /// @param [out] iGainIndex 增益档序号
  230. /// @note 增益档位序号从0 开始,最大为支持的总数-1
  231. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  232. NVDENTALDET_API NV_StatusType NV_GetGainEx(int *iGainIndex);
  233. /////////////////////////////////////////////////////////////////////////
  234. /// @brief 获取数字增益档
  235. /// @param [out] iGainIndex 增益档序号
  236. /// @note 增益档位序号从0 开始,最大为支持的总数-1
  237. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  238. NVDENTALDET_API NV_StatusType NV_GetDigitalGainEx(int *iGainIndex);
  239. /////////////////////////////////////////////////////////////////////////
  240. /// @brief 获取ROI模式图像范围
  241. /// @param [out] offsetX 图像起始列
  242. /// @param [out] offsetY 图像起始行
  243. /// @param [out] width 图像宽
  244. /// @param [out] height 图像高
  245. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  246. NVDENTALDET_API NV_StatusType NV_GetImageRange(int *offsetX, int *offsetY, int *width, int *height);
  247. /////////////////////////////////////////////////////////////////////////
  248. /// @brief 获取探测器的积分时间(即X射线出线时间),单位0.1ms。当AcquisitionMode是CONTINUE、FALLING_EDGE_TRRIGER及RISING_EDGE_TRIGGER时,以该设定值作为Sensor的积分窗口时间
  249. /// @param [out] expTime 探测器的积分时间(即X射线出线时间)
  250. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  251. /// @note v1.3.0.0版之后,如果当前的采集速度控制模式不是曝光时间控制模式,则会返回失败
  252. NVDENTALDET_API NV_StatusType NV_GetExpTime(int *expTime);
  253. /////////////////////////////////////////////////////////////////////////
  254. /// @brief 获取探测器的采集帧率
  255. /// @param [out] iFPS 探测器的采集帧率
  256. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  257. /// @note v1.3.0.0版之后,如果当前的采集速度控制模式不是FPS模式,则会返回失败
  258. NVDENTALDET_API NV_StatusType NV_GetFramePerSecond(int * iFPS);
  259. /////////////////////////////////////////////////////////////////////////
  260. /// @brief 获取探测器的采集速度控制模式
  261. /// @param [out] eAcqSpeedCtrlMode 控制模式(积分时间和FPS控制)
  262. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  263. NVDENTALDET_API NV_StatusType NV_GetAcqSpeedCtrlMode(NV_AcqSpeedCtrlType * eAcqSpeedCtrlMode);
  264. /////////////////////////////////////////////////////////////////////////
  265. /// @brief 获取探测器的采集速度控制参数
  266. /// @param [out] eAcqSpeedCtrlMode 控制参数
  267. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  268. /// @note 当控制模式为NV_ACQSPEED_CTRL_EXPTIME时,返回的参数为积分时间,单位为0.1ms
  269. /// 当控制模式为NV_ACQSPEED_CTRL_FPS时,返回的参数为帧率,单位为每秒多少张图
  270. NVDENTALDET_API NV_StatusType NV_GetAcqSpeedCtrlParam(int * iParam);
  271. /////////////////////////////////////////////////////////////////////////
  272. /// @brief 获取该序列的最大图像帧数。
  273. /// @param [out] maxFrames 该序列的最大图像帧数。当为0时,不限制图像帧数
  274. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  275. NVDENTALDET_API NV_StatusType NV_GetMaxFrames(int *maxFrames);
  276. /* Acq */
  277. /////////////////////////////////////////////////////////////////////////
  278. /// @brief 创建采图缓冲区
  279. /// @param [in] imgCount 要缓存的图像总张数
  280. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  281. /// @note 调用该函数之前必须确保探测器已经打开,否则会返回失败。
  282. /// 如果缓冲区满则覆盖最早的数据,读索引向后移动。
  283. /// 不再使用缓冲区时必须调用 @c NV_AcqBufferDestroy()释放。如果之前的缓冲区没有释放,则函数返回失败。
  284. /// 如果图像大小改变(改变Binning模式或设置图像宽高),SDK自动调整到适合图像宽高的缓冲区,缓存的图像总张数不变。
  285. /// @sa @c NV_AcqBufferDestroy()
  286. NVDENTALDET_API NV_StatusType NV_AcqBufferCreate(unsigned int imgCount);
  287. /////////////////////////////////////////////////////////////////////////
  288. /// @brief 获取采图缓冲区可读图像张数
  289. /// @param [out] readableNum 采图缓冲区可读图像张数
  290. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  291. NVDENTALDET_API NV_StatusType NV_AcqBufferReadableNum(unsigned int *readableNum);
  292. /////////////////////////////////////////////////////////////////////////
  293. /// @brief 读取采图缓冲区一张最新图像
  294. /// @param [out] imgInfo 读出的图像内容
  295. /// @param [in] milliseconds 等待读取的时间
  296. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  297. /// @note 先进先出,顺序读取,即:最早采集到的图像最先读出。
  298. /// 如果有数据被覆盖,读索引会自动向后移动。读到的数据始终是最先进入队列的数据。
  299. /// 若设置milliseconds为0,则没有可读数据会立即返回;若设置milliseconds>0,则阻塞milliseconds毫秒直到超时或有数据可读
  300. NVDENTALDET_API NV_StatusType NV_AcqBufferReadImage(NV_ImageInfo *imgInfo, unsigned long milliseconds = 0);
  301. /////////////////////////////////////////////////////////////////////////
  302. /// @brief 获取已缓存的图像张数总数
  303. /// @retval NV_StatusCodes 返回状态码图像张数
  304. NVDENTALDET_API int NV_AcqBufferGetNumFrames();
  305. /////////////////////////////////////////////////////////////////////////
  306. /// @brief 从缓存中获取一张指定的图像
  307. /// @param [in] index 图像索引
  308. /// @param [in out] frame 图像数据缓冲区指针
  309. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  310. NVDENTALDET_API NV_StatusType NV_AcqBufferGetImage(int index, unsigned short *frame);
  311. /////////////////////////////////////////////////////////////////////////
  312. /// @brief 清空采图缓冲区,即全置0
  313. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  314. NVDENTALDET_API NV_StatusType NV_AcqBufferClear();
  315. /////////////////////////////////////////////////////////////////////////
  316. /// @brief 释放采图缓冲区
  317. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  318. /// @note 该函数负责回收资源。
  319. /// 不再使用采图缓冲区时,必须调用该函数,否则会造成内存泄漏。
  320. /// @sa @c NV_AcqBufferCreate()
  321. NVDENTALDET_API NV_StatusType NV_AcqBufferDestroy();
  322. /////////////////////////////////////////////////////////////////////////
  323. /// @brief 开始采集
  324. /// @param [in] pCallback 采集到达最大帧回调函数
  325. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  326. /// @note 该函数创建新线程接收数据,并发送"AcquisitionStart"命令启动采集,然后立即返回。
  327. /// 如果MaxFrame不为0,采集到最大帧数时,自动发送"AcquisitionStop"命令停止采集,并回调用户提供的回调函数。
  328. /// 采集过程中用户可以自己调用 @c NV_StopAcq()结束采集。
  329. /// SDK提供两种方式获取图像数据:1.设置回调函数 @c NV_SetAcqCallback(); 2.创建缓冲区 @c NV_AcqBufferCreate() @c NV_AcqBufferReadImage()
  330. /// @sa @c NV_StopAcq() @c NV_SetAcqCallback() @c NV_AcqBufferCreate() @c NV_AcqBufferReadImage() ..
  331. NVDENTALDET_API NV_StatusType NV_StartAcq();
  332. /////////////////////////////////////////////////////////////////////////
  333. /// @brief 是否正在采集
  334. /// @retval bool 返回是否正在采集的状态,未采集为false,已采集为true
  335. /// 采集过程中用户调用该函数以结束采集。
  336. NVDENTALDET_API bool NV_IsAcqing();
  337. /////////////////////////////////////////////////////////////////////////
  338. /// @brief 结束采集
  339. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  340. /// @note 该函数发送"AcquisitionStop"命令停止采集,并结束 @c NV_StartAcq()创建的接收数据线程。
  341. /// 采集过程中用户调用该函数以结束采集。
  342. /// @sa @c NV_StartAcq()
  343. NVDENTALDET_API NV_StatusType NV_StopAcq();
  344. /* Calibration */
  345. /////////////////////////////////////////////////////////////////////////
  346. /// @brief 启动本底校正线程,读取配置文件进行校正,校正完成后保存并加载本底模板文件,同时外部调用者可使用提供的模板数据,自行保存模板
  347. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  348. /// @note 启动新线程后台工作,该函数立刻返回。线程结束时回调通知本底校正是否成功
  349. /// 调用该函数之前需要调用 @c NV_ResetCorrection()重置校正使能
  350. /// @sa @c NV_CancelOffsetCal() @c NV_ResetCorrection()
  351. NVDENTALDET_API NV_StatusType NV_RunOffsetCalThread();
  352. /////////////////////////////////////////////////////////////////////////
  353. /// @brief 取消本底校正
  354. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  355. /// @note 本底校正线程会被终止
  356. /// @sa @c NV_RunOffsetCalThread()
  357. NVDENTALDET_API NV_StatusType NV_CancelOffsetCal();
  358. /// @brief 加载用户保存的本底模板文件
  359. /// @param [in] pTemplateData 增益模板数据
  360. /// @param [in] iTempSize 增益模板大小
  361. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  362. /// @note 加载模板之后,将会以加载的模板数据进行校正,之前加载的模板或者加载的本地保存的模板将会失效
  363. /// @note 加载模板之后,依然需要调用NV_SetOffsetCal启用校正功能
  364. /// @note 加载的模板数据必须是对应BINNING模式和增益档位,否则会加载失败
  365. NVDENTALDET_API NV_StatusType NV_LoadOffsetTemplateData(const char * pTemplateData, int iTempSize);
  366. /// @brief 加载本地保存的本底模板文件
  367. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  368. /// @note 加载模板之后,将会以加载的模板数据进行校正,之前加载的模板将会失效
  369. /// @note 加载模板之后,依然需要调用NV_SetOffsetCal启用校正功能
  370. NVDENTALDET_API NV_StatusType NV_LoadLocalOffsetTemplate();
  371. /////////////////////////////////////////////////////////////////////////
  372. /// @brief 启动增益校正线程,读取配置文件进行校正,校正完成后在本地保存并加载增益模板文件,同时外部调用者可使用提供的模板数据,自行保存模板
  373. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  374. /// @note 启动新线程后台工作,该函数立刻返回。线程结束时回调通知增益校正是否成功
  375. /// 调用该函数之前需要调用 @c NV_ResetCorrection()重置校正使能
  376. /// @sa @c NV_CancelGainCal() @c NV_ResetCorrection()
  377. NVDENTALDET_API NV_StatusType NV_RunGainCalThread();
  378. /////////////////////////////////////////////////////////////////////////
  379. /// @brief 取消增益校正
  380. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  381. /// @note 增益校正线程会被终止
  382. /// @sa @c NV_RunGainCalThread()
  383. NVDENTALDET_API NV_StatusType NV_CancelGainCal();
  384. /////////////////////////////////////////////////////////////////////////
  385. /// @brief 启动本底校正线程,读取配置文件进行校正,校正完成后保存本底模板文件
  386. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  387. /// @note 启动新线程后台工作,该函数立刻返回。线程结束时回调通知本底校正是否成功
  388. /// @note 当有温度值发生改变时,通过EVENT_CALLBACK通知用户
  389. /// EVENT类型:NV_EVENTTYPE_AUTOOFFSETCAL
  390. /// 数据:无
  391. NVDENTALDET_API NV_StatusType NV_PerformOffsetCal();
  392. /// @brief 加载用户保存的增益模板文件
  393. /// @param [in] pTemplateData 增益模板数据
  394. /// @param [in] iTempSize 增益模板大小
  395. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  396. /// @note 加载模板之后,将会以加载的模板数据进行校正,之前加载的模板或者加载的本地保存的模板将会失效
  397. /// @note 加载模板之后,依然需要调用NV_SetGainCal启用校正功能
  398. /// @note 加载的模板数据必须是对应BINNING模式和增益档位,否则会加载失败
  399. NVDENTALDET_API NV_StatusType NV_LoadGainTemplateData(const char * pTemplateData, int iTempSize);
  400. /// @brief 加载本地保存的增益模板文件
  401. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  402. /// @note 加载模板之后,将会以加载的模板数据进行校正,之前加载的模板将会失效
  403. /// @note 加载模板之后,依然需要调用NV_SetGainCal启用校正功能
  404. NVDENTALDET_API NV_StatusType NV_LoadLocalGainTemplate();
  405. /////////////////////////////////////////////////////////////////////////
  406. /// @brief 启动自动坏点校正线程,读取配置文件进行校正,校正完成后保存自动坏点模板文件
  407. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  408. /// @note 启动新线程后台工作,该函数立刻返回。线程结束时回调通知自动坏点校正是否成功
  409. /// 调用该函数之前需要调用 @c NV_ResetCorrection()重置校正使能
  410. /// @sa @c NV_ResetCorrection()
  411. NVDENTALDET_API NV_StatusType NV_RunAutoDefectCalThread();
  412. /////////////////////////////////////////////////////////////////////////
  413. /// @brief 保存手动坏点模板(坏点用非0数表示)
  414. /// @param [in] pixel 手动坏点模板的数据区域
  415. /// @param [in] width 图像宽
  416. /// @param [in] height 图像高
  417. /// @param [in] mode Binning模式
  418. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  419. NVDENTALDET_API NV_StatusType NV_SaveManDefectData(const unsigned short* pixel, int width, int height, NV_BinningMode mode);
  420. /////////////////////////////////////////////////////////////////////////
  421. /// @brief 手动添加坏点(在当前的增益和binning模式下添加)
  422. /// @param [in] pixel 手动坏点模板的数据区域
  423. /// @param [in] width 图像宽
  424. /// @param [in] height 图像高
  425. /// @param [in] mode Binning模式
  426. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  427. NVDENTALDET_API NV_StatusType NV_SaveManDefectData(const unsigned short* pixel, int width, int height, NV_BinningMode mode);
  428. /* ImageProcessing */
  429. /////////////////////////////////////////////////////////////////////////
  430. /// @brief 设置本底校正使能
  431. /// @param [in] type 校正类型
  432. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  433. NVDENTALDET_API NV_StatusType NV_SetOffsetCal(NV_CorrType type);
  434. /////////////////////////////////////////////////////////////////////////
  435. /// @brief 设置增益校正使能
  436. /// @param [in] type 校正类型
  437. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  438. NVDENTALDET_API NV_StatusType NV_SetGainCal(NV_CorrType type);
  439. /////////////////////////////////////////////////////////////////////////
  440. /// @brief 设置坏点校正使能
  441. /// @param [in] type 校正类型
  442. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  443. NVDENTALDET_API NV_StatusType NV_SetDefectCal(NV_CorrType type);
  444. /////////////////////////////////////////////////////////////////////////
  445. /// @brief 设置水平镜像使能
  446. /// @param [in] type 校正类型
  447. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  448. NVDENTALDET_API NV_StatusType NV_SetMirrorX(NV_CorrType type);
  449. /////////////////////////////////////////////////////////////////////////
  450. /// @brief 设置垂直镜像使能
  451. /// @param [in] type 校正类型
  452. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  453. NVDENTALDET_API NV_StatusType NV_SetMirrorY(NV_CorrType type);
  454. /////////////////////////////////////////////////////////////////////////
  455. /// @brief 设置图像反白使能
  456. /// @param [in] type 校正类型
  457. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  458. NVDENTALDET_API NV_StatusType NV_SetInversion(NV_CorrType type);
  459. /////////////////////////////////////////////////////////////////////////
  460. /// @brief 设置Gamma校正使能
  461. /// @param [in] type 校正类型
  462. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  463. NVDENTALDET_API NV_StatusType NV_SetDigitalGamma(NV_CorrType type);
  464. /////////////////////////////////////////////////////////////////////////
  465. /// @brief 设置LUT校正使能
  466. /// @param [in] type 校正类型
  467. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  468. NVDENTALDET_API NV_StatusType NV_SetDigitalLUT(NV_CorrType type);
  469. /////////////////////////////////////////////////////////////////////////
  470. /// @brief 设置图像校正完成后整体的像素灰度偏移量
  471. /// @param [in] imageOffset 整体的像素灰度偏移量,默认为0
  472. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  473. NVDENTALDET_API NV_StatusType NV_SetImageOffset(int imageOffset);
  474. /////////////////////////////////////////////////////////////////////////
  475. /// @brief 重置校正使能
  476. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  477. /// @note 校正使能全部设为不使能,偏移量设为0,采图范围设为默认值
  478. NVDENTALDET_API NV_StatusType NV_ResetCorrection();
  479. /////////////////////////////////////////////////////////////////////////
  480. /// @brief 获取本底校正使能状态
  481. /// @param [out] type 校正类型
  482. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  483. NVDENTALDET_API NV_StatusType NV_GetOffsetCal(NV_CorrType *type);
  484. /////////////////////////////////////////////////////////////////////////
  485. /// @brief 获取增益校正使能状态
  486. /// @param [out] type 校正类型
  487. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  488. NVDENTALDET_API NV_StatusType NV_GetGainCal(NV_CorrType *type);
  489. /////////////////////////////////////////////////////////////////////////
  490. /// @brief 获取坏点校正使能状态
  491. /// @param [out] type 校正类型
  492. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  493. NVDENTALDET_API NV_StatusType NV_GetDefectCal(NV_CorrType *type);
  494. /////////////////////////////////////////////////////////////////////////
  495. /// @brief 获取水平镜像使能状态
  496. /// @param [out] type 校正类型
  497. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  498. NVDENTALDET_API NV_StatusType NV_GetMirrorX(NV_CorrType *type);
  499. /////////////////////////////////////////////////////////////////////////
  500. /// @brief 获取垂直镜像使能状态
  501. /// @param [out] type 校正类型
  502. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  503. NVDENTALDET_API NV_StatusType NV_GetMirrorY(NV_CorrType *type);
  504. /////////////////////////////////////////////////////////////////////////
  505. /// @brief 获取图像反白使能状态
  506. /// @param [out] type 校正类型
  507. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  508. NVDENTALDET_API NV_StatusType NV_GetInversion(NV_CorrType *type);
  509. /////////////////////////////////////////////////////////////////////////
  510. /// @brief 获取Gamma校正使能状态
  511. /// @param [out] type 校正类型
  512. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  513. NVDENTALDET_API NV_StatusType NV_GetDigitalGamma(NV_CorrType *type);
  514. /////////////////////////////////////////////////////////////////////////
  515. /// @brief 获取LUT校正使能状态
  516. /// @param [out] type 校正类型
  517. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  518. NVDENTALDET_API NV_StatusType NV_GetDigitalLUT(NV_CorrType *type);
  519. /////////////////////////////////////////////////////////////////////////
  520. /// @brief 获取图像校正完成后整体的像素灰度偏移量
  521. /// @param [out] imageOffset 整体的像素灰度偏移量
  522. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  523. NVDENTALDET_API NV_StatusType NV_GetImageOffset(int *imageOffset);
  524. /* SystemStatus */
  525. /////////////////////////////////////////////////////////////////////////
  526. /// @brief 设置连接断开消息通知超时时间
  527. /// @param [in] iTimeSec 连接断开后消息通知的超时时间,单位秒
  528. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  529. /// @note 超时时间单位秒,范围1sec~30sec,缺省为30sec,超时时间不能够被记录
  530. NVDENTALDET_API NV_StatusType NV_SetConnbreakTime(int iTimeSec);
  531. /////////////////////////////////////////////////////////////////////////
  532. /// @brief 获取连接断开消息通知超时时间
  533. /// @param [in] iTimeSec 获取到的连接断开后消息通知的超时时间,单位秒
  534. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  535. NVDENTALDET_API NV_StatusType NV_GetConnbreakTime(int * iTimeSec);
  536. /* ErrorMsg */
  537. /////////////////////////////////////////////////////////////////////////
  538. /// @brief 获取详细错误信息
  539. /// @param [out] errorMsg 错误信息缓存区
  540. /// @param [in] bufflen 缓存区长度
  541. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  542. /// @note 如果函数接口返回错误码,用该函数获取详细错误信息
  543. NVDENTALDET_API NV_StatusType NV_LastErrorMsg(char *errorMsg, unsigned int bufflen);
  544. /////////////////////////////////////////////////////////////////////////
  545. /// @brief 设置最后一次详细得错误信息
  546. /// @param [in] errorMsg 错误信息缓存区
  547. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  548. NVDENTALDET_API NV_StatusType NV_SetLastErrorMsg(char *errorMsg);
  549. /* ParamFile */
  550. /////////////////////////////////////////////////////////////////////////
  551. /// @brief 初始化SDK的语言设置
  552. /// @param [in] lang 语言类型
  553. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  554. NVDENTALDET_API NV_StatusType NV_InitLanguage(NV_LANGUAGE &lang);
  555. /////////////////////////////////////////////////////////////////////////
  556. /// @brief 获取当前SDK配置的语言类型
  557. /// @param [in out] lang 语言类型
  558. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  559. NVDENTALDET_API NV_StatusType NV_GetLanguage(NV_LANGUAGE& lang);
  560. /////////////////////////////////////////////////////////////////////////
  561. /// @brief 设置SDK配置的语言类型
  562. /// @param [in] lang 语言类型
  563. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  564. NVDENTALDET_API NV_StatusType NV_SetLanguage(NV_LANGUAGE lang);
  565. /////////////////////////////////////////////////////////////////////////
  566. /// @brief 设置SDK与探测器传输数据块大小
  567. /// @param [in] frameType 帧类型
  568. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  569. NVDENTALDET_API NV_StatusType NV_SetFrameType(NV_FRAME_TYPE frameType);
  570. /////////////////////////////////////////////////////////////////////////
  571. /// @brief 获取SDK与探测器传输数据块大小
  572. /// @param [out] frameType 帧类型
  573. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  574. NVDENTALDET_API NV_StatusType NV_GetFrameType(NV_FRAME_TYPE * frameType);
  575. /// @brief 获取网卡MTU大小
  576. /// @param [out] iMtuSize MTU大小
  577. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  578. NVDENTALDET_API NV_StatusType SV_GetAdapterMtuSize(int * iMtuSize);
  579. /// @brief 获取网卡理论最大带宽
  580. /// @param [out] iBandwidth 带宽大小(兆字节)
  581. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  582. NVDENTALDET_API NV_StatusType SV_GetAdapterBandWidth(int * iBandwidth);
  583. /// @brief 获取通讯协商的包大小
  584. /// @param [out] iPackSize 数据包大小
  585. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  586. NVDENTALDET_API NV_StatusType SV_GetCommPackageSize(int * iPackSize);
  587. /// @brief 添加坏点
  588. /// @param [in] pPixelPos 坐标序列首地址
  589. /// @param [in] iCnt 坐标序列个数
  590. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  591. /// @note 在当前binning和增益档位下增加一组坏点,如果需要在不同档位下增加,需调用档位切换函数NV_SetBinningMode以及增益切换函数NV_SetGainEx
  592. NVDENTALDET_API NV_StatusType SV_AppendManualDefectPixel(const SV_PixelPos * pPixelPos, int iCnt);
  593. /// @brief 删除坏点
  594. /// @param [in] pPixelPos 坐标序列首地址
  595. /// @param [in] iCnt 坐标序列个数
  596. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  597. /// @note 在当前binning和增益档位下删除一组坏点,如果需要在不同档位下增加,需调用档位切换函数NV_SetBinningMode以及增益切换函数NV_SetGainEx
  598. NVDENTALDET_API NV_StatusType SV_RemoveManualDefectPixel(const SV_PixelPos * pPixelPos, int iCnt);
  599. /// @brief 添加坏线
  600. /// @param [in] bHorzLine 是否是水平线
  601. /// @param [in] iIndex 坏线序号,从0开始编号
  602. /// @param [in] mode binning模式
  603. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  604. /// @note 在当前binning和增益档位下增加一条坏线,如果需要在不同档位下增加,需调用档位切换函数NV_SetBinningMode以及增益切换函数NV_SetGainEx
  605. NVDENTALDET_API NV_StatusType SV_AppendManualDefectLine(bool bHorzLine, int iIndex);
  606. /// @brief 删除坏线
  607. /// @param [in] bHorzLine 是否是水平线
  608. /// @param [in] iIndex 坏线序号,从0开始编号
  609. /// @param [in] mode binning模式
  610. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  611. /// @note 在当前binning和增益档位下删除一条坏线,如果需要在不同档位下增加,需调用档位切换函数NV_SetBinningMode以及增益切换函数NV_SetGainEx
  612. NVDENTALDET_API NV_StatusType SV_RemoveManualDefectLine(bool bHorzLine, int iIndex);
  613. /// @brief 获取缺省坏点模板映射图
  614. /// @param [in out] pMapData 模板数据缓冲区
  615. /// @param [in] iMaxSize 外部提供的缓冲区最大长度
  616. /// @param [in out] iRetSize 返回的缓冲数据长度
  617. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  618. /// @note 缓存需外部提供,建议使用NV_GetImageRange获取图像尺寸,并使用unsigned short类型,申请获取尺寸的缓冲,用于存放获取的模板数据
  619. NVDENTALDET_API NV_StatusType SV_GetManualDefectTemplateMap(unsigned short * pMapData, int iMaxSize, int * iRetSize);
  620. /// @brief 设置是否自动接受亮场校正结果
  621. /// @param [in] bEanble 是否自动接受亮场校正结果
  622. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  623. NVDENTALDET_API NV_StatusType SV_SetAcceptCorrRltAutomaticEnable(bool bEnable);
  624. /// @brief 获取是否自动接受亮场校正结果使能
  625. /// @param [in] bEanble 是否自动接受亮场校正结果
  626. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  627. NVDENTALDET_API NV_StatusType SV_GetAcceptCorrRltAutomaticEnable(bool * bEnable);
  628. /// @brief 使能动态暗场校正
  629. /// @param [in] bEanble 是否启用动态暗场校正
  630. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  631. NVDENTALDET_API NV_StatusType SV_SetDynamicOffsetCorrectEnable(bool bEnable);
  632. /// @brief 获取动态暗场校正使能状态
  633. /// @param [in] bEanble 查看动态暗场校正的启用状态
  634. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  635. NVDENTALDET_API NV_StatusType SV_GetDynamicOffsetCorrectEnable(bool * bEnable);
  636. /// @brief 使能手动更新动态校正模板
  637. /// @param [in] bEanble 是否手动启动更新动态暗场校正模板
  638. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  639. NVDENTALDET_API NV_StatusType SV_SetManualUpdateDOCTEnable(bool bEnable);
  640. /// @brief 获取手动更新动态校正模板的使能状态
  641. /// @param [in] bEanble 查看是否启动了手动更新动态暗场校正模板
  642. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  643. NVDENTALDET_API NV_StatusType SV_GetManualUpdateDOCTEnable(bool * bEnable);
  644. /////////////////////////////////////////////////////////////////////////
  645. /// @brief 设置是否启用多帧叠加输出,是否启用运动侦测,同时设置叠加张数,即采集输出的图像为叠加后的图像
  646. /// @param [in] bEnable 是否启用多帧叠加输出
  647. /// @param [in] bMotionDetection是否启用运动侦测
  648. /// @param [in] iMeanCnt 设置叠加张数
  649. /// @retval bool 返回是否正在采集的状态,未采集为false,已采集为true
  650. /// 采集过程中用户调用该函数以结束采集。
  651. /// @note 可在采集过程中或者采集前进行设置
  652. NVDENTALDET_API NV_StatusType SV_SetMeanFrameOutputEnable(bool bEnable, bool bMotionDetection, int iMeanCnt) ;
  653. /////////////////////////////////////////////////////////////////////////
  654. /// @brief 获取是否启用多帧叠加输出,是否启用运动侦测,同时设置叠加张数,即采集输出的图像为叠加后的图像
  655. /// @param [in] bEnable 是否启用多帧叠加输出
  656. /// @param [in] bMotionDetection 是否启用运动侦测
  657. /// @param [in] iMeanCnt 设置叠加张数
  658. /// @retval bool 返回是否正在采集的状态,未采集为false,已采集为true
  659. /// 采集过程中用户调用该函数以结束采集。
  660. /// @note 可在采集过程中或者采集前进行设置
  661. NVDENTALDET_API NV_StatusType SV_GetMeanFrameOutputEnable(bool * bEnable, bool * bMotionDetection, int * iMeanCnt) ;
  662. /// @brief 设置图像传输模式
  663. /// @param [in] HDET 探测器句柄,由NV_CreateDetectorInstance函数创建
  664. /// @param [in] eTransMode 图像传输方式
  665. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  666. /// @note SV_DTMODE_CT:CT传输模式:在有限缓存下,尽可能保证图像完整。(在传输链路信号质量差时,帧率波动以及图像传输延迟较大,推荐单次有限张数图像采集场景)
  667. /// @note SV_DTMODE_XR:二维X光摄影传输模式:丢弃丢包严重的图像,保证图像采集的实时性。(在传输链路信号质量差时,帧率波动以及图像传输延迟较小,推荐实时性有要求的连续采集场景)
  668. NVDENTALDET_API NV_StatusType SV_SetDataTransMode(SV_DATATRANS_MODE eTransMode);
  669. /// @brief 获取图像传输模式
  670. /// @param [in] HDET 探测器句柄,由NV_CreateDetectorInstance函数创建
  671. /// @param [in out] eTransMode 图像传输方式
  672. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  673. /// @note SV_DTMODE_CT:CT传输模式:在有限缓存下,尽可能保证图像完整。(在传输链路信号质量差时,帧率波动以及图像传输延迟较大,推荐单次有限张数图像采集场景)
  674. /// @note SV_DTMODE_XR:二维X光摄影传输模式:丢弃丢包严重的图像,保证图像采集的实时性。(在传输链路信号质量差时,帧率波动以及图像传输延迟较小,推荐实时性有要求的连续采集场景)
  675. NVDENTALDET_API NV_StatusType SV_GetDataTransMode(SV_DATATRANS_MODE * eTransMode);
  676. /// @brief 设置DSA模式触发使能
  677. /// @param [in] bEnable true 打开使能 false 关闭使能
  678. /// @retval NV_StatusType 返回状态码,若成功则返回NV_SC_SUCCESS
  679. NVDENTALDET_API NV_StatusType SV_SetDSATrigger(bool bEnable);
  680. /// @brief 获取DSA模式触发使能
  681. /// @param [out] bEnable true 打开使能 false 关闭使能
  682. /// @retval NV_StatusType 返回状态码,若成功则返回NV_SC_SUCCESS
  683. NVDENTALDET_API NV_StatusType SV_GetDSATrigger(bool * bEnable);
  684. /// @brief 获取日志储存的绝对路径
  685. /// @param [in out] pPath 获取储存路径的缓冲
  686. /// @param [in] pPath 储存路径的缓冲大小
  687. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  688. NVDENTALDET_API NV_StatusType SV_GetLogStoragePath(char * pPathBuf, int iPathSize);
  689. /// @brief 设置日志储存的绝对路径
  690. /// @param [in] pPath 设置储存路径的缓冲
  691. /// @param [in] pPath 储存路径的缓冲大小
  692. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  693. /// @note 在所有接口调用前调用
  694. /// @note 调用接口时,请确保设置日志的绝对路径(pPath)已经存在,否则将会使用默认路径
  695. NVDENTALDET_API NV_StatusType SV_SetLogStoragePath(const char * pPath, int iPathSize);
  696. /// @brief 获取日志文件在本地储存的天数
  697. /// @param [in out] iDay 获取本地储存的天数
  698. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  699. /// @note 过期的日志自动清除
  700. NVDENTALDET_API NV_StatusType SV_GetLogStorageDay(int * iDay);
  701. /// @brief 设置日志文件在本地储存的天数
  702. /// @param [in] iDay 设置本地储存的天数
  703. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  704. /// @note 在所有接口调用前调用
  705. /// @note 过期的日志自动清除
  706. NVDENTALDET_API NV_StatusType SV_SetLogStorageDay(int iDay);
  707. /// @brief 获取日志储存的类型限制
  708. /// @param [in] iType 获取储存类型的组合值
  709. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  710. /// @note 将获取的组合值与类型列表LOG_MSG_TYPE中的值&运算,结果值为类型本身表示该项开启,值为0表示该项关闭
  711. /// @note 示例:((iType & LOG_MSG_INFO) == LOG_MSG_INFO ?) "开启" : "关闭"
  712. NVDENTALDET_API NV_StatusType SV_GetLogStorageType(int * iType);
  713. /// @brief 设置日志文件在本地储存的天数
  714. /// @param [in] iType 设置储存类型的组合值
  715. /// @retval NV_StatusCodes 返回状态码,若成功则返回NV_SC_SUCCESS
  716. /// @note 在所有接口调用前调用
  717. /// @note 将类型列表LOG_MSG_TYPE中需要开启日志记录的值进行 | 运算得到组合值,
  718. /// @note 示例:SV_SetLogStorageType(LOG_MSG_INFO | LOG_MSG_WARNING); 开启LOG_MSG_INFO与LOG_MSG_WARNING的记录,其它关闭
  719. NVDENTALDET_API NV_StatusType SV_SetLogStorageType(int iType);
  720. #ifdef __cplusplus
  721. }
  722. #endif
  723. #endif //NVDENTALDET_H