凯视佳工业相机api函数说明书彩色参数设置篇

1、凯视佳工业相机凯视佳工业相机 API 函数说明书彩色相机参数设置篇：版本：发布日期：（文档适用相机型号等说明）本文档适用于 MUC36C(MGYYO)、2015-5-14 2014-2015凯视佳光电设备 1凯视佳光电（）400：400-0300-601技术支持：http:/2015-5-14 2014-2015凯视佳光电设备 2. 1 参数类型41、视场( AOI Area Oferest)42、抽点（Skip）43、BIN54、(Exure)55、增益(Gain)66、水平消隐（Horizontal Bl7、垂直消隐( Vertical Bl）. 6). 78、垂直翻转（Flip）79、水

2、平翻转（Mirror）710、亮度（Brightness）711、对比度（Contrast）812、坏点校正813、灵敏度（Sensitive）814、Gamma 校正8二 相关函数91、KSJ_PARAM 类型92、KSJ_GetParamRange123、KSJ_SetParam134、KSJ_GetParam145、KSJ_GammaSetValue146、KSJ_GammaOn.157、KSJ_ Ex8、KSJ_ ExureTimeSet15ureTimeGet162015-5-14 2014-2015凯视佳光电设备 3凯视佳相机开发包针对黑白相机提供的标准参数设置分为：由硬件实现的功

3、能和由软件算法实现的功能。由硬件实现的功能所增加的耗时可以忽略。而由实现的部分功能因为需要进行大量的计算，造成增加耗时，因此可能对相机速度有一定的影响。这些影响将在下面。 参数类型1、视场( AOI Area Oferest)凯视佳公司的所有型号的相机都可以设置视场，并且相机的预览视场和视场是相互独立的。也就是说，预览视场可以和视场不同，方便用户根据实际情况设置不同的视场。用户可以通过函数 KSJ_PreviewSetFieldOfView() 和函数 预览视场和 KSJ_CaptureSetFieldOfView()设置预览视场和视场。KSJ_PreviewSetFieldOfViewEx(

4、)和 KSJ_CaptureSetFieldOfViewEx()则在设置视场的同时提供的功能，详细请参考 API函数使用说明书。需要注意的是，用户设置完视场之后，再分配内存数据之前，最好通过调用函数 KSJ_CaptureGetSize() 或者 KSJ_PreviewGetSize()重新获取图像或者预览的图像的大小，这是由于开发包会对用户设置不合理的一些参数进行一些微调，这有可能会改变或预览图像的大小。同时，如果用户设置了抽点模式也会对或预览图像的大小造成影响。因此为安全起见，需要用户重新获取图像的大小。2、抽点（Skip）凯视佳工业相机支持抽点功能，所谓 N*N 抽点为在分辨率视场内每隔

5、 N 行或列出一行或一列。抽点功能可以实现在保证视场不变的情况下，缩小图像的大小，从而减小数据 量 ， 一 定 程 度 上 提 高 相 机 速 度 。 可 以 通 过 在 设 置视 场（KSJ_PreviewSetFieldOfView() ）和预览视场( KSJ_CaptureSetFieldOfView() )时通过设置参数 KSJ_ADDRESSMODE 设置抽点模式。需要注意的是：用户设置了抽点模式之后，图像和预览图像的大小就不再是单纯的设置视场或预览视场的大小，此时，用户需要通过调用 KSJ_PreviewGetSize()或 KSJ_PreviewGetSizeEx()和 KSJ_

6、CapturgetSize()2015-5-14 2014-2015凯视佳光电设备 4或 KSJ_CaptureGetSizeEx()重新获取预览图像或图像的大小，以便分配合适的内存或根据对应的参数进行正确处理。抽点的大小不是可以任意设置的，参看枚举类型KSJ_ADDRESSMODE，凯视佳工业相机 API 函数使用说明。3、BINBin 模式只有在设置抽点功能的前提下才能设置。在凯视佳工业相机提供的开发模式中，单纯的抽点是指间隔 N 行（列）读出一行（列）。Bin 实际上是通过把邻近的像素点的感光电荷相加来提高相机对光的响应。一般情况下，图像传感器支持水平（行）bin和垂直（列）bin。因此

7、，在设置了 N*N 抽点的前提下，启用 bin 模式，可以实现将 N*N个像素点合并为一个，以此来提高相机对光的灵敏度。用户可以通过调用函数KSJ_SetParam（）设置参数 KSJ_BIN 启用 BIN 模式。注意：并不是所有的凯视佳工业相机都提供 BIN KSJ_UC500M_。模式功能，此模式只支持 KSJ_UC320C_X 相机型号。如用户需要使用 BIN 功能，请X,KSJ_UC500C_凯视佳科技（X,）4、(Exure)凯视佳工业相机支持时间的设置。调整时间可以提高图像亮度，但是过大的时间也会拖慢相机图像的速度。如果用户需要提高图像亮度可以从以下几个方面调整：调整镜头光圈，大光

8、圈将增大进光量，增强图像亮度；增强光源亮度；调整图像传感器的增益（Gain）; 延长时间。凯视佳公司提供的相机开发包同时支持以 ms 为或者以行为设置时间。其中，时间行是相机支持的最小，即便用户以 ms 为设置时间，在相机也会转换为行。因此，以行为设置时间比以 ms 为更加精确。同时，以行为时间设置能设置为更小的时间，这对于需要更小时间的动态图像的应用有很好的效果。行与 ms 之间的转换，每个相机是不同的，转换公式也和水平消隐和垂直消隐有关。具体转换方式较为复杂，此处不再赘述.司。疑问请凯视佳科技（）有限公2015-5-14 2014-2015凯视佳光电设备 5用户可以使用函数 KSJ_Set

9、Param()使用参数 KSJ_EXURE 以 ms 为设置相机时间，或者使用参数 KSJ_EXURE_LINES 以行为设置时间。除此之外，用户可以直接使用函数 KSJ_ ExureTimeSet（）以 ms 为设置时间。KSJ_ ExureTimeGet（）获取当前的时间（ms）。如果用户以行为设置了时间，而想换算得到设置的时间的 ms 值(不必通过公式计算)，可以通过调用函数 KSJ_GetParam（）使用参数 KSJ_EXURE 获取设置的ms 值。反之，亦然。5、增益(Gain)增益是图像传感器中的信号放大器，增大 Gain 值实际上是放大图像传感器对光信号的响应，有增强图像亮度的

10、作用。 但是，Gain 值的增大不仅仅放大了对有效光信号的响应，同时也会放大对噪声信号的响应。因此，增益的调整会影响图像的质量（噪声）。大致说来，Gain 越大，图像的噪声也会更严重。在噪声可接受范围内，可以适当提高增益。同时，不同的图像传感器所需要的 Gain 值不同，一般传感器 Gain 值在 50 以内。而如 MU3E200M 等少部分相机则需要设置 Gain 到 128 或以上才能获得正常亮度的图像。用户疑问请凯视佳科技（）.对于黑白相机，设置增益可以调用函数 KSJ_SetParam() 对参数 KSJ_RED 、 KSJ_GREEN、KSJ_BLUE 任意一个进行设置即可，不必设置

11、三个参数值。而对于彩色相机则需要同时设置 KSJ_RED、KSJ_GREEN、KSJ_BLUE 三个参数值，之后还需要进行白平衡校正，才能得到正确的图像色彩。关于白平衡校正，请参考凯视佳公司提供的相关技术文档。6、水平消隐（Horizontal Bl）水平消隐是相机的图像传感器每完成一行，开始下一行的时间间隔。可以使用函数 KSJ_SetParam()中的参数 KSJ_ HORIZONTALBL这个一般用户不需要调整。调整水平消隐。注意：2015-5-14 2014-2015凯视佳光电设备 67、垂直消隐( Vertical Bl)与水平消隐类似，垂直消隐指的是图像传感器完成当前像素的，到下一

12、个像素曝光开始的时间间隔，可用于微调帧速，在适当的设置后，帧速会有所提高。通过函数 KSJ_SetParam（）及参数 KSJ_VERTICALBL可以调整垂直消隐。8、垂直翻转（Flip）通过调用函数 KSJ_SetParam（）和参数 KSJ_FLIP 可以对图像沿 X 轴垂直（上下）翻转。此操作将同时影响预览图像和图像。并且当使用彩色相机进行翻转操作时，相机的 Bayer 模式也需要进行对应的改变，具体请参考 Bayer 模式说明。黑白相机无需考虑Bayer 模式。垂直翻转操作是由相机硬件实现，不会影响相机的速度。9、水平翻转（Mirror）通过调用函数 KSJ_SetParam（）和参

13、数 KSJ_MIRROR 可以对图像沿 Y 轴水平（左右）翻转。此操作将同时影响预览图像和图像。并且当使用彩色相机进行镜像操作时，相机的 Bayer 模式也需要进行对应的改变，具体请参考 Bayer 模式说明。黑白相机无需考虑Bayer 模式。水平翻转操作是由相机硬件实现，不会影响相机的速度。10、亮度（Brightness）调整图像亮度，通过函数 KSJ_SetParam（）和参数 KSJ_BRIGHTNESS 。通过KSJ_GetParam()获取当前的对比度值。或者也可以直接通过函数 KSJ_ProsBrightnessSet() 和 KSJ_ ProsBrightnessGet() 直

14、接设置和获取对比度参数值。可以通过函数KSJ_ProsBrightnessGetRange ()获取亮度的设置范围。2015-5-14 2014-2015凯视佳光电设备 711、对比度（Contrast）调整图像对比度，通过函数 KSJ_SetParam() 和参数 KSJ_CONTRAST 。通过 KSJ_GetParam()获取当前的对比度值。或者也可以直接通过函数 KSJ_ProsContrastSet()和 KSJ_ProsContrastGet() 直接设 置和获取对比 度参数值。可 以通过函数 KSJ_ProsContrastGetRange()获取对比度的设置范围。12、坏点校正

15、由于图像传感器本身的工作特点，图像坏点的出现无法避免，用户可以调用函数KSJ_BixelCorrectionSet（）设置开启坏点校正功能。该功能由硬件实现，对相机帧速没有任何影响。同时，也可以调用函数 KSJ_BixelCorrectionGet（）获取是否已经开启了坏点校正功能。需要注意的是，坏点校正功能只对部分帧存相机有效，如*（MRYY），*（MGYY）。坏点校正功能由 FPGA 硬件实现，对相机速度不影响。13、灵敏度（Sensitive）该参数仅支持帧存相机。用户可以通过函数 KSJ_ SensitivitySetMode（）设置灵敏度。使用函数 KSJ_ SensitivityG

16、etMode 获取当前相机的灵敏度。所谓灵敏度是相机对光线的感光灵敏度。14、Gamma 校正函数 KSJ_GammaOn（）可以开启或者关闭 Gamma 校正。通过函数 KSJ_GammaSetValue()设置 Gamma 参数值。Gamma 参数范围为-9-9. 也可以通过函数 KSJ_GetParamRange()获取参数的可设置范围。当参数设置为0时，图像将不会改变。二相关函数1、KSJ_PARAM 类型相机参数的枚举类型enum KSJ_PARAM2015-5-14 2014-2015凯视佳光电设备 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凯视佳光电设备 9KSJ_TRIGGER_METHOD;参数说明：KSJ_EXURE相机，此值已毫秒为，目前只能为整数，用户如需精确到微妙级，请与凯视佳联系。KSJ_RED相机红增益KSJ_GREEN相机绿增益KSJ_PREVIEW_COLUMNSTART预览视场的水平起始像素点KSJ_PREVIEW_ROWSTART预览视场的垂直起始行KSJ_CAPTURE_COLUMNSTART视场的水平起始像素点KSJ_C

19、APTURE_ROWSTART视场的垂直起始行KSJ_ HORIZONTALBL水平消隐（这个用户一般不必调节）KSJ_VERTICALBL垂直消隐（可用于微调帧速，在适当的设置后，帧速会有所提高）KSJ_FLIP对原始数据进行垂直翻转，这个操作由硬件进行操作，请参考凯视佳工业相机 API编程入门指南.V1.4中关于 Bayer 模式的说明部分。KSJ_SetParam 中的 nValue 参数为 0 表示不使用原始数据不翻转，为 1 表示原始数据翻转。KSJ_BIN2015-5-1410 2014-2015 凯视佳光电设备是否加入 Bin 模式，此模式只对 KSJ_SKIP2,KSJ_SKI

20、P4 两种抽点模式有作用。此模式只支持 KSJ_UC320C_X,KSJ_UC500C_X, KSJ_UC500M_X 相机型号。KSJ_SetParam 中的 nValue 参数为 0 表示不使用 BIN 模式，为 1 表示使用 BIN 模式。KSJ_MIRROR此功能支持 UC500C,UC500M，UC900C,UC1000C,UD140C,UD140M,UC36C,UC36M。对原始数据进行水平翻转，这个操作由硬件进行操作(UD140C,UD140M 通过作，会降低预览帧速)，所以不会影响任何效率。注意，水平翻转后，Bayer 模式需要进行相应的设置，比如 UC500C 在正常设置下，

21、Bayer 排列格式为 GRBG 模式，水平翻转后，Bayer 模式需设置为 RGGB。这些设置开发包不做处理，需用户自行调用。另外他的设置不会影响白平衡区域和区域在图像上的位置。KSJ_CONTRAST对比度KSJ_BRIGHTNESS亮度KSJ_VGAGAINUD140C,UD140M 支持，调节 VGA 增益。KSJ_CLLEVELUD140C,UD140M 支持，调节钳位电平KSJ_CDSGAINUD140C,UD140M 支持，调节 CDS 增益。KSJ_RED_SHIFT（彩色相机有效）处理，颜色校正算法，红偏移，必须先开启 KSJ_CC_SHIFTRGB 色彩校正功能，此设置才能

22、有效，参考 KSJ_ColorCorrectSet 函数说明。KSJ_GREEN_SHIFT（彩色相机有效）处理，颜色校正算法，绿偏移，必须先开启 KSJ_CC_SHIFTRGB 色彩校正功能，此设置才能有效，参考 KSJ_ColorCorrectSet 函数说明。KSJ_BLUE_SHIFT（彩色相机有效）处理，颜色校正算法，兰偏移，必须先开启 KSJ_CC_SHIFTRGB 色彩校正功能，此2015-5-1411 2014-2015 凯视佳光电设备设置才能有效，参考 KSJ_ColorCorrectSet 函数说明。PANDINGUC36C,UC36M 支持，是否开启压缩扩展功能，类似背光

23、补偿，能有效增大动态范围。KSJ_EXURE_LINES行数KSJ_SATURATION（彩色相机有效）饱和度KSJ_TRIGGERDELAY外触发延时KSJ_STROBEDELAY闪光灯延时(暂不支持)KSJ_TRIGGER_MODE触发模式KSJ_TRIGGER_METHOD触发信号方式2、KSJ_GetParamRangeKSJ_API stdcall KSJ_GetParamRange( INnChannel, IN KSJ_PARaram,OUT*pnMinValue, OUT*pnMaxValue );说明：获取参数的设置范围。由于 KSJApi 开发包支持全系列凯视佳的相机产品，

24、针对不同型号的相机，参数的设置范围不同。用户可以通过调用此函数获得相关信息。参数nChannel设备索引（从 0 开始，最大索引数为:连接到主机的设备数目减一）。Param指定的参数（参考 KSJ_PARAM 定义）pnMinValue2015-5-1412 2014-2015 凯视佳光电设备取得指定参数设置的最小值pnMaxValue取得指定参数设置的最大值返回值参考返回状态码（KSJCode.H）3、KSJ_SetParam设置相机参数KSJ_API stdcall KSJ_SetParam( INnChannel, IN KSJ_PARaram,INnValue );参数nChannel

25、设备索引（从 0 开始，最大索引数为:连接到主机的设备数目减一）。Param要设置的相机参数（参考 KSJ_PARAM 的定义）。nValue参数设置的值。（设置范围请参考 KSJ_GetParamRange 函数）。返回值参考返回状态码（KSJCode.H）4、KSJ_GetParam获取相机参数KSJ_API stdcall KSJ_GetParam( INnChannel, IN KSJ_PARaram,OUT*pnValue );参数nChannel设备索引（从 0 开始，最大索引数为:连接到主机的设备数目减一）。2015-5-1413 2014-2015 凯视佳光电设备Param要获

26、取的相机参数（参考 KSJ_PARAM 的定义）。pnValue函数返回时，参数值会写入此地址。返回值参考返回状态码（KSJCode.H）5、KSJ_GammaSetValue设置 Gamma 值以产生 Gamma 表 stdcall KSJ_GammaSetValue(KSJ_APInChannel,nValue );参数nChannel设备索引（从 0 开始，最大索引数为:连接到主机的设备数目减一）。nValue需要设定的 Gamma 值，目前的调节范围可以通过 KSJ_GetParamRange 获得（-9-9）。返回值参考返回状态码（KSJCode.H）说明当 nValue 设置为 0 时，实际是没有进行 Gamma 校正的。6、KSJ_GammaOn打开或关闭 Gamm