凱視佳工業(yè)相機(jī)api函數(shù)說明書彩色參數(shù)設(shè)置篇

1、凱視佳工業(yè)相機(jī)凱視佳工業(yè)相機(jī) API 函數(shù)說明書彩色相機(jī)參數(shù)設(shè)置篇：版本：發(fā)布日期：（文檔適用相機(jī)型號等說明）本文檔適用于 MUC36C(MGYYO)、2015-5-14 2014-2015凱視佳光電設(shè)備 1凱視佳光電（）400：400-0300-601技術(shù)支持：http:/2015-5-14 2014-2015凱視佳光電設(shè)備 2. 1 參數(shù)類型41、視場( AOI Area Oferest)42、抽點(diǎn)（Skip）43、BIN54、(Exure)55、增益(Gain)66、水平消隱（Horizontal Bl7、垂直消隱( Vertical Bl）. 6). 78、垂直翻轉(zhuǎn)（Flip）79、水

2、平翻轉(zhuǎn)（Mirror）710、亮度（Brightness）711、對比度（Contrast）812、壞點(diǎn)校正813、靈敏度（Sensitive）814、Gamma 校正8二 相關(guān)函數(shù)91、KSJ_PARAM 類型92、KSJ_GetParamRange123、KSJ_SetParam134、KSJ_GetParam145、KSJ_GammaSetValue146、KSJ_GammaOn.157、KSJ_ Ex8、KSJ_ ExureTimeSet15ureTimeGet162015-5-14 2014-2015凱視佳光電設(shè)備 3凱視佳相機(jī)開發(fā)包針對黑白相機(jī)提供的標(biāo)準(zhǔn)參數(shù)設(shè)置分為：由硬件實(shí)現(xiàn)的功

3、能和由軟件算法實(shí)現(xiàn)的功能。由硬件實(shí)現(xiàn)的功能所增加的耗時(shí)可以忽略。而由實(shí)現(xiàn)的部分功能因?yàn)樾枰M(jìn)行大量的計(jì)算，造成增加耗時(shí)，因此可能對相機(jī)速度有一定的影響。這些影響將在下面。 參數(shù)類型1、視場( AOI Area Oferest)凱視佳公司的所有型號的相機(jī)都可以設(shè)置視場，并且相機(jī)的預(yù)覽視場和視場是相互獨(dú)立的。也就是說，預(yù)覽視場可以和視場不同，方便用戶根據(jù)實(shí)際情況設(shè)置不同的視場。用戶可以通過函數(shù) KSJ_PreviewSetFieldOfView() 和函數(shù) 預(yù)覽視場和 KSJ_CaptureSetFieldOfView()設(shè)置預(yù)覽視場和視場。KSJ_PreviewSetFieldOfViewEx(

4、)和 KSJ_CaptureSetFieldOfViewEx()則在設(shè)置視場的同時(shí)提供的功能，詳細(xì)請參考 API函數(shù)使用說明書。需要注意的是，用戶設(shè)置完視場之后，再分配內(nèi)存數(shù)據(jù)之前，最好通過調(diào)用函數(shù) KSJ_CaptureGetSize() 或者 KSJ_PreviewGetSize()重新獲取圖像或者預(yù)覽的圖像的大小，這是由于開發(fā)包會對用戶設(shè)置不合理的一些參數(shù)進(jìn)行一些微調(diào)，這有可能會改變或預(yù)覽圖像的大小。同時(shí)，如果用戶設(shè)置了抽點(diǎn)模式也會對或預(yù)覽圖像的大小造成影響。因此為安全起見，需要用戶重新獲取圖像的大小。2、抽點(diǎn)（Skip）凱視佳工業(yè)相機(jī)支持抽點(diǎn)功能，所謂 N*N 抽點(diǎn)為在分辨率視場內(nèi)每隔

5、 N 行或列出一行或一列。抽點(diǎn)功能可以實(shí)現(xiàn)在保證視場不變的情況下，縮小圖像的大小，從而減小數(shù)據(jù) 量 ， 一 定 程 度 上 提 高 相 機(jī) 速 度 。 可 以 通 過 在 設(shè) 置視 場（KSJ_PreviewSetFieldOfView() ）和預(yù)覽視場( KSJ_CaptureSetFieldOfView() )時(shí)通過設(shè)置參數(shù) KSJ_ADDRESSMODE 設(shè)置抽點(diǎn)模式。需要注意的是：用戶設(shè)置了抽點(diǎn)模式之后，圖像和預(yù)覽圖像的大小就不再是單純的設(shè)置視場或預(yù)覽視場的大小，此時(shí)，用戶需要通過調(diào)用 KSJ_PreviewGetSize()或 KSJ_PreviewGetSizeEx()和 KSJ_

6、CapturgetSize()2015-5-14 2014-2015凱視佳光電設(shè)備 4或 KSJ_CaptureGetSizeEx()重新獲取預(yù)覽圖像或圖像的大小，以便分配合適的內(nèi)存或根據(jù)對應(yīng)的參數(shù)進(jìn)行正確處理。抽點(diǎn)的大小不是可以任意設(shè)置的，參看枚舉類型KSJ_ADDRESSMODE，凱視佳工業(yè)相機(jī) API 函數(shù)使用說明。3、BINBin 模式只有在設(shè)置抽點(diǎn)功能的前提下才能設(shè)置。在凱視佳工業(yè)相機(jī)提供的開發(fā)模式中，單純的抽點(diǎn)是指間隔 N 行（列）讀出一行（列）。Bin 實(shí)際上是通過把鄰近的像素點(diǎn)的感光電荷相加來提高相機(jī)對光的響應(yīng)。一般情況下，圖像傳感器支持水平（行）bin和垂直（列）bin。因此

7、，在設(shè)置了 N*N 抽點(diǎn)的前提下，啟用 bin 模式，可以實(shí)現(xiàn)將 N*N個(gè)像素點(diǎn)合并為一個(gè)，以此來提高相機(jī)對光的靈敏度。用戶可以通過調(diào)用函數(shù)KSJ_SetParam（）設(shè)置參數(shù) KSJ_BIN 啟用 BIN 模式。注意：并不是所有的凱視佳工業(yè)相機(jī)都提供 BIN KSJ_UC500M_。模式功能，此模式只支持 KSJ_UC320C_X 相機(jī)型號。如用戶需要使用 BIN 功能，請X,KSJ_UC500C_凱視佳科技（X,）4、(Exure)凱視佳工業(yè)相機(jī)支持時(shí)間的設(shè)置。調(diào)整時(shí)間可以提高圖像亮度，但是過大的時(shí)間也會拖慢相機(jī)圖像的速度。如果用戶需要提高圖像亮度可以從以下幾個(gè)方面調(diào)整：調(diào)整鏡頭光圈，大光

8、圈將增大進(jìn)光量，增強(qiáng)圖像亮度；增強(qiáng)光源亮度；調(diào)整圖像傳感器的增益（Gain）; 延長時(shí)間。凱視佳公司提供的相機(jī)開發(fā)包同時(shí)支持以 ms 為或者以行為設(shè)置時(shí)間。其中，時(shí)間行是相機(jī)支持的最小，即便用戶以 ms 為設(shè)置時(shí)間，在相機(jī)也會轉(zhuǎn)換為行。因此，以行為設(shè)置時(shí)間比以 ms 為更加精確。同時(shí)，以行為時(shí)間設(shè)置能設(shè)置為更小的時(shí)間，這對于需要更小時(shí)間的動態(tài)圖像的應(yīng)用有很好的效果。行與 ms 之間的轉(zhuǎn)換，每個(gè)相機(jī)是不同的，轉(zhuǎn)換公式也和水平消隱和垂直消隱有關(guān)。具體轉(zhuǎn)換方式較為復(fù)雜，此處不再贅述.司。疑問請凱視佳科技（）有限公2015-5-14 2014-2015凱視佳光電設(shè)備 5用戶可以使用函數(shù) KSJ_Set

9、Param()使用參數(shù) KSJ_EXURE 以 ms 為設(shè)置相機(jī)時(shí)間，或者使用參數(shù) KSJ_EXURE_LINES 以行為設(shè)置時(shí)間。除此之外，用戶可以直接使用函數(shù) KSJ_ ExureTimeSet（）以 ms 為設(shè)置時(shí)間。KSJ_ ExureTimeGet（）獲取當(dāng)前的時(shí)間（ms）。如果用戶以行為設(shè)置了時(shí)間，而想換算得到設(shè)置的時(shí)間的 ms 值(不必通過公式計(jì)算)，可以通過調(diào)用函數(shù) KSJ_GetParam（）使用參數(shù) KSJ_EXURE 獲取設(shè)置的ms 值。反之，亦然。5、增益(Gain)增益是圖像傳感器中的信號放大器，增大 Gain 值實(shí)際上是放大圖像傳感器對光信號的響應(yīng)，有增強(qiáng)圖像亮度的

10、作用。 但是，Gain 值的增大不僅僅放大了對有效光信號的響應(yīng)，同時(shí)也會放大對噪聲信號的響應(yīng)。因此，增益的調(diào)整會影響圖像的質(zhì)量（噪聲）。大致說來，Gain 越大，圖像的噪聲也會更嚴(yán)重。在噪聲可接受范圍內(nèi)，可以適當(dāng)提高增益。同時(shí)，不同的圖像傳感器所需要的 Gain 值不同，一般傳感器 Gain 值在 50 以內(nèi)。而如 MU3E200M 等少部分相機(jī)則需要設(shè)置 Gain 到 128 或以上才能獲得正常亮度的圖像。用戶疑問請凱視佳科技（）.對于黑白相機(jī)，設(shè)置增益可以調(diào)用函數(shù) KSJ_SetParam() 對參數(shù) KSJ_RED 、 KSJ_GREEN、KSJ_BLUE 任意一個(gè)進(jìn)行設(shè)置即可，不必設(shè)置

11、三個(gè)參數(shù)值。而對于彩色相機(jī)則需要同時(shí)設(shè)置 KSJ_RED、KSJ_GREEN、KSJ_BLUE 三個(gè)參數(shù)值，之后還需要進(jìn)行白平衡校正，才能得到正確的圖像色彩。關(guān)于白平衡校正，請參考凱視佳公司提供的相關(guān)技術(shù)文檔。6、水平消隱（Horizontal Bl）水平消隱是相機(jī)的圖像傳感器每完成一行，開始下一行的時(shí)間間隔。可以使用函數(shù) KSJ_SetParam()中的參數(shù) KSJ_ HORIZONTALBL這個(gè)一般用戶不需要調(diào)整。調(diào)整水平消隱。注意：2015-5-14 2014-2015凱視佳光電設(shè)備 67、垂直消隱( Vertical Bl)與水平消隱類似，垂直消隱指的是圖像傳感器完成當(dāng)前像素的，到下一

12、個(gè)像素曝光開始的時(shí)間間隔，可用于微調(diào)幀速，在適當(dāng)?shù)脑O(shè)置后，幀速會有所提高。通過函數(shù) KSJ_SetParam（）及參數(shù) KSJ_VERTICALBL可以調(diào)整垂直消隱。8、垂直翻轉(zhuǎn)（Flip）通過調(diào)用函數(shù) KSJ_SetParam（）和參數(shù) KSJ_FLIP 可以對圖像沿 X 軸垂直（上下）翻轉(zhuǎn)。此操作將同時(shí)影響預(yù)覽圖像和圖像。并且當(dāng)使用彩色相機(jī)進(jìn)行翻轉(zhuǎn)操作時(shí)，相機(jī)的 Bayer 模式也需要進(jìn)行對應(yīng)的改變，具體請參考 Bayer 模式說明。黑白相機(jī)無需考慮Bayer 模式。垂直翻轉(zhuǎn)操作是由相機(jī)硬件實(shí)現(xiàn)，不會影響相機(jī)的速度。9、水平翻轉(zhuǎn)（Mirror）通過調(diào)用函數(shù) KSJ_SetParam（）和參

13、數(shù) KSJ_MIRROR 可以對圖像沿 Y 軸水平（左右）翻轉(zhuǎn)。此操作將同時(shí)影響預(yù)覽圖像和圖像。并且當(dāng)使用彩色相機(jī)進(jìn)行鏡像操作時(shí)，相機(jī)的 Bayer 模式也需要進(jìn)行對應(yīng)的改變，具體請參考 Bayer 模式說明。黑白相機(jī)無需考慮Bayer 模式。水平翻轉(zhuǎn)操作是由相機(jī)硬件實(shí)現(xiàn)，不會影響相機(jī)的速度。10、亮度（Brightness）調(diào)整圖像亮度，通過函數(shù) KSJ_SetParam（）和參數(shù) KSJ_BRIGHTNESS 。通過KSJ_GetParam()獲取當(dāng)前的對比度值。或者也可以直接通過函數(shù) KSJ_ProsBrightnessSet() 和 KSJ_ ProsBrightnessGet() 直

14、接設(shè)置和獲取對比度參數(shù)值。可以通過函數(shù)KSJ_ProsBrightnessGetRange ()獲取亮度的設(shè)置范圍。2015-5-14 2014-2015凱視佳光電設(shè)備 711、對比度（Contrast）調(diào)整圖像對比度，通過函數(shù) KSJ_SetParam() 和參數(shù) KSJ_CONTRAST 。通過 KSJ_GetParam()獲取當(dāng)前的對比度值。或者也可以直接通過函數(shù) KSJ_ProsContrastSet()和 KSJ_ProsContrastGet() 直接設(shè) 置和獲取對比 度參數(shù)值?？?以通過函數(shù) KSJ_ProsContrastGetRange()獲取對比度的設(shè)置范圍。12、壞點(diǎn)校正

15、由于圖像傳感器本身的工作特點(diǎn)，圖像壞點(diǎn)的出現(xiàn)無法避免，用戶可以調(diào)用函數(shù)KSJ_BixelCorrectionSet（）設(shè)置開啟壞點(diǎn)校正功能。該功能由硬件實(shí)現(xiàn)，對相機(jī)幀速沒有任何影響。同時(shí)，也可以調(diào)用函數(shù) KSJ_BixelCorrectionGet（）獲取是否已經(jīng)開啟了壞點(diǎn)校正功能。需要注意的是，壞點(diǎn)校正功能只對部分幀存相機(jī)有效，如*（MRYY），*（MGYY）。壞點(diǎn)校正功能由 FPGA 硬件實(shí)現(xiàn)，對相機(jī)速度不影響。13、靈敏度（Sensitive）該參數(shù)僅支持幀存相機(jī)。用戶可以通過函數(shù) KSJ_ SensitivitySetMode（）設(shè)置靈敏度。使用函數(shù) KSJ_ SensitivityG

16、etMode 獲取當(dāng)前相機(jī)的靈敏度。所謂靈敏度是相機(jī)對光線的感光靈敏度。14、Gamma 校正函數(shù) KSJ_GammaOn（）可以開啟或者關(guān)閉 Gamma 校正。通過函數(shù) KSJ_GammaSetValue()設(shè)置 Gamma 參數(shù)值。Gamma 參數(shù)范圍為-9-9. 也可以通過函數(shù) KSJ_GetParamRange()獲取參數(shù)的可設(shè)置范圍。當(dāng)參數(shù)設(shè)置為0時(shí)，圖像將不會改變。二相關(guān)函數(shù)1、KSJ_PARAM 類型相機(jī)參數(shù)的枚舉類型enum KSJ_PARAM2015-5-14 2014-2015凱視佳光電設(shè)備 8KSJ_EXURE = 0, KSJ_RED, KSJ_GREEN, KSJ_B

17、LUE, KSJ_GAMMA,KSJ_PREVIEW_COLUMNSTART, KSJ_PREVIEW_ROWSTART, KSJ_CAPTURE_COLUMNSTART,KSJ_CAPTURE_ROWSTART,KSJ_HORIZONTALBL KSJ_VERTICALBL KSJ_FLIP,KSJ_BIN, KSJ_MIRROR, KSJ_CONTRAST, KSJ_BRIGHTNESS,KSJ_VGAGAIN,KSJ_CLLEVEL,KSJ_CDSGAIN, KSJ_RED_SHIFT, KSJ_GREEN_SHIFT, KSJ_BLUE_SHIFT,PANDING,KSJ_EXURE_

18、LINES,KSJ_SATURATION, KSJ_TRIGGERDELAY, KSJ_STROBEDELAY,KSJ_TRIGGER_MODE,2015-5-14 2014-2015凱視佳光電設(shè)備 9KSJ_TRIGGER_METHOD;參數(shù)說明：KSJ_EXURE相機(jī)，此值已毫秒為，目前只能為整數(shù)，用戶如需精確到微妙級，請與凱視佳聯(lián)系。KSJ_RED相機(jī)紅增益KSJ_GREEN相機(jī)綠增益KSJ_PREVIEW_COLUMNSTART預(yù)覽視場的水平起始像素點(diǎn)KSJ_PREVIEW_ROWSTART預(yù)覽視場的垂直起始行KSJ_CAPTURE_COLUMNSTART視場的水平起始像素點(diǎn)KSJ_C

19、APTURE_ROWSTART視場的垂直起始行KSJ_ HORIZONTALBL水平消隱（這個(gè)用戶一般不必調(diào)節(jié)）KSJ_VERTICALBL垂直消隱（可用于微調(diào)幀速，在適當(dāng)?shù)脑O(shè)置后，幀速會有所提高）KSJ_FLIP對原始數(shù)據(jù)進(jìn)行垂直翻轉(zhuǎn)，這個(gè)操作由硬件進(jìn)行操作，請參考凱視佳工業(yè)相機(jī) API編程入門指南.V1.4中關(guān)于 Bayer 模式的說明部分。KSJ_SetParam 中的 nValue 參數(shù)為 0 表示不使用原始數(shù)據(jù)不翻轉(zhuǎn)，為 1 表示原始數(shù)據(jù)翻轉(zhuǎn)。KSJ_BIN2015-5-1410 2014-2015 凱視佳光電設(shè)備是否加入 Bin 模式，此模式只對 KSJ_SKIP2,KSJ_SKI

20、P4 兩種抽點(diǎn)模式有作用。此模式只支持 KSJ_UC320C_X,KSJ_UC500C_X, KSJ_UC500M_X 相機(jī)型號。KSJ_SetParam 中的 nValue 參數(shù)為 0 表示不使用 BIN 模式，為 1 表示使用 BIN 模式。KSJ_MIRROR此功能支持 UC500C,UC500M，UC900C,UC1000C,UD140C,UD140M,UC36C,UC36M。對原始數(shù)據(jù)進(jìn)行水平翻轉(zhuǎn)，這個(gè)操作由硬件進(jìn)行操作(UD140C,UD140M 通過作，會降低預(yù)覽幀速)，所以不會影響任何效率。注意，水平翻轉(zhuǎn)后，Bayer 模式需要進(jìn)行相應(yīng)的設(shè)置，比如 UC500C 在正常設(shè)置下，

21、Bayer 排列格式為 GRBG 模式，水平翻轉(zhuǎn)后，Bayer 模式需設(shè)置為 RGGB。這些設(shè)置開發(fā)包不做處理，需用戶自行調(diào)用。另外他的設(shè)置不會影響白平衡區(qū)域和區(qū)域在圖像上的位置。KSJ_CONTRAST對比度KSJ_BRIGHTNESS亮度KSJ_VGAGAINUD140C,UD140M 支持，調(diào)節(jié) VGA 增益。KSJ_CLLEVELUD140C,UD140M 支持，調(diào)節(jié)鉗位電平KSJ_CDSGAINUD140C,UD140M 支持，調(diào)節(jié) CDS 增益。KSJ_RED_SHIFT（彩色相機(jī)有效）處理，顏色校正算法，紅偏移，必須先開啟 KSJ_CC_SHIFTRGB 色彩校正功能，此設(shè)置才能

22、有效，參考 KSJ_ColorCorrectSet 函數(shù)說明。KSJ_GREEN_SHIFT（彩色相機(jī)有效）處理，顏色校正算法，綠偏移，必須先開啟 KSJ_CC_SHIFTRGB 色彩校正功能，此設(shè)置才能有效，參考 KSJ_ColorCorrectSet 函數(shù)說明。KSJ_BLUE_SHIFT（彩色相機(jī)有效）處理，顏色校正算法，蘭偏移，必須先開啟 KSJ_CC_SHIFTRGB 色彩校正功能，此2015-5-1411 2014-2015 凱視佳光電設(shè)備設(shè)置才能有效，參考 KSJ_ColorCorrectSet 函數(shù)說明。PANDINGUC36C,UC36M 支持，是否開啟壓縮擴(kuò)展功能，類似背光

23、補(bǔ)償，能有效增大動態(tài)范圍。KSJ_EXURE_LINES行數(shù)KSJ_SATURATION（彩色相機(jī)有效）飽和度KSJ_TRIGGERDELAY外觸發(fā)延時(shí)KSJ_STROBEDELAY閃光燈延時(shí)(暫不支持)KSJ_TRIGGER_MODE觸發(fā)模式KSJ_TRIGGER_METHOD觸發(fā)信號方式2、KSJ_GetParamRangeKSJ_API stdcall KSJ_GetParamRange( INnChannel, IN KSJ_PARaram,OUT*pnMinValue, OUT*pnMaxValue );說明：獲取參數(shù)的設(shè)置范圍。由于 KSJApi 開發(fā)包支持全系列凱視佳的相機(jī)產(chǎn)品，

24、針對不同型號的相機(jī)，參數(shù)的設(shè)置范圍不同。用戶可以通過調(diào)用此函數(shù)獲得相關(guān)信息。參數(shù)nChannel設(shè)備索引（從 0 開始，最大索引數(shù)為:連接到主機(jī)的設(shè)備數(shù)目減一）。Param指定的參數(shù)（參考 KSJ_PARAM 定義）pnMinValue2015-5-1412 2014-2015 凱視佳光電設(shè)備取得指定參數(shù)設(shè)置的最小值pnMaxValue取得指定參數(shù)設(shè)置的最大值返回值參考返回狀態(tài)碼（KSJCode.H）3、KSJ_SetParam設(shè)置相機(jī)參數(shù)KSJ_API stdcall KSJ_SetParam( INnChannel, IN KSJ_PARaram,INnValue );參數(shù)nChannel

25、設(shè)備索引（從 0 開始，最大索引數(shù)為:連接到主機(jī)的設(shè)備數(shù)目減一）。Param要設(shè)置的相機(jī)參數(shù)（參考 KSJ_PARAM 的定義）。nValue參數(shù)設(shè)置的值。（設(shè)置范圍請參考 KSJ_GetParamRange 函數(shù)）。返回值參考返回狀態(tài)碼（KSJCode.H）4、KSJ_GetParam獲取相機(jī)參數(shù)KSJ_API stdcall KSJ_GetParam( INnChannel, IN KSJ_PARaram,OUT*pnValue );參數(shù)nChannel設(shè)備索引（從 0 開始，最大索引數(shù)為:連接到主機(jī)的設(shè)備數(shù)目減一）。2015-5-1413 2014-2015 凱視佳光電設(shè)備Param要獲

26、取的相機(jī)參數(shù)（參考 KSJ_PARAM 的定義）。pnValue函數(shù)返回時(shí)，參數(shù)值會寫入此地址。返回值參考返回狀態(tài)碼（KSJCode.H）5、KSJ_GammaSetValue設(shè)置 Gamma 值以產(chǎn)生 Gamma 表 stdcall KSJ_GammaSetValue(KSJ_APInChannel,nValue );參數(shù)nChannel設(shè)備索引（從 0 開始，最大索引數(shù)為:連接到主機(jī)的設(shè)備數(shù)目減一）。nValue需要設(shè)定的 Gamma 值，目前的調(diào)節(jié)范圍可以通過 KSJ_GetParamRange 獲得（-9-9）。返回值參考返回狀態(tài)碼（KSJCode.H）說明當(dāng) nValue 設(shè)置為 0 時(shí)，實(shí)際是沒有進(jìn)行 Gamma 校正的。6、KSJ_GammaOn打開或關(guān)閉 Gamm