v25.5.6964

Read before using


This document and the software sample codes are internal documents of Hamamatsu Photonics K.K.(it is described as the following HPK) and are disclosed upon request in order to enable the user to create a host software using DCAM-API.
This document and the software sample codes are disclosed only for the purpose described above, and do not constitute a license, transfer, or any other entitlement for the owner.
All of risk and result of using software depending on this document remains with the user.
This document may include technical inaccuracies or typographical errors. HPK does not guarantee any damage arising from such errors or this document.
HPK makes no commitment to update or keep current the information contained in this document.
All brand and product names are trademarks or registered trademarks of their respective owners. HPK has copyright of this document with all rights reserved.
No part of this documentation may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form, or by any means, in any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of HPK.

Go to top of this chapter


Overview


This document explains support parameter at Flat Panel Sensor and how to control them by DCAM Properties. This document requires knowledge of basic concept of DCAM-API and SDK. If you need description about them, please reffer other documents.

Go to top of this chapter


Scan Mode

Fine Mode (1x1 Mode)
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1
Fast Mode (2x2 Mode)
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__2
4x4 Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__4
Panoramic Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__PANORAMIC
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1
DCAM_IDPROP_SENSORMODE_PANORAMICSTARTV
R/W
LONG
n Value range is described by the chapter of Camera Info.
Rectangular binning Panoramic Mode (Rtbin Panoramic Mode)
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__PANORAMIC
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1_2
DCAM_IDPROP_SENSORMODE_PANORAMICSTARTV
R/W
LONG
n Value range is described by the chapter of Camera Info.
Partial Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__PARTIALAREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__2
1x2 Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__1_2
2x4 Mode
DCAM_IDPROP_SENSORMODE
R/W
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_BINNING
R/W
MODE
DCAMPROP_BINNING__2_4

Go to top of this chapter


Trigger Mode

Internal Trigger Mode
DCAM_IDPROP_TRIGGERSOURCE
R/W
MODE
DCAMPROP_TRIGGERSOURCE__INTERNAL
DCAM_IDPROP_EXPOSURETIME
R/W
REAL
Exposuretime(sec) Value range is described by each datasheet.
External Trigger Mode
DCAM_IDPROP_TRIGGERSOURCE
R/W
MODE
DCAMPROP_TRIGGERSOURCE__EXTERNAL

Go to top of this chapter


Flexible Partial Mode

Flexible Partial Mode(FPM) is implemented in some cameras. The model name of cameras implemented this function is described by the chapter of Camera Info. DCAM has SUBARRAYMODE in standard and FPM is what used the function. Therefore, how to set FPM is the same as SUBARRAYMODE. Specifically, the cameras which support FPM work as FPM, the cameras which don't support FPM work as SUBARRAYMODE by setting SUBARRAYMODE. Detail how to use SUBARRAYMODE is described by "property_reference.html". The difference between FPM and SUBARRAYMODE is at what point the image is cropped. The camera selects the area in FPM when the camera readout a charge. DCAM crops selected area in SUBARRAYMODE after DCAM receives image data from camera. For the reason, the max limit of framerate in FPM is changed depending on VSIZE but is not changed in SUBARRAYMODE. The formula of framerate is described by each datasheet.
Flexible Partial Mode
DCAM_IDPROP_SUBARRAYMODE
R/W
MODE
DCAMPROP_SUBARRAYMODE__OFF (default)
DCAMPROP_SUBARRAYMODE__ON
DCAM_IDPROP_SUBARRAYHSIZE
R/W
LONG
n Value range is described by the chapter of Camera Info. When 1x1 or 1x2 mode is applied, set multiple of 8. When 2x2 or 2x4 or 4x4 mode is applied, set multiple of 16.
DCAM_IDPROP_SUBARRAYVSIZE
R/W
LONG
n Value range is described by the chapter of Camera Info. When 1x1 or 1x2 mode is applied, set multiple of 2. When 2x2 or 2x4 or 4x4 mode is applied, set multiple of 4.
DCAM_IDPROP_SUBARRAYHPOS
R/W
LONG
n Value range is described by the chapter of Camera Info. When 1x1 or 1x2 or 4x4 mode is applied, set multiple of 8. When 2x2 or 2x4 mode is applied, set multiple of 16.
DCAM_IDPROP_SUBARRAYVPOS
R/W
LONG
n Value range is described by the chapter of Camera Info. When 1x1 or 1x2 mode is applied, set multiple of 2. When 2x2 or 2x4 mode is applied, set multiple of 4. When 4x4 mode is applied, set multiple of 16.

Go to top of this chapter


Selectable Gain Mode

C14406DK-81, C14408DK-50, and C14409DK-52 have "Selectable Gain Mode". The Gain can be set with DCAM_IDPROP_CONTRASTGAIN. In principle, each Gain is set to High=0, Middle=1 and Low=2. The default is High Gain mode. The detail is described by each datasheet.
Selectable Gain Mode
DCAM_IDPROP_CONTRASTGAIN
R/W
MODE
0 to 2 High Gain = 0(Default), Middle Gain = 1, Low Gain = 2

Go to top of this chapter


Device Buffer Mode

Device Buffer Mode is implemented in some cameras. This function is initially unable. When it is enabled, the image is stored to buffer memory inside camera and it retransmits from the memory when frames are missed during the process. Retransmission during capturing is not supported. You have to set DCAMCAP_START_SNAP as the argument of dcamcap_start() because this function is only available in SNAP mode and is not available in SEQUENCE mode. If SNAPSHOT is selected, frames are retransmitted after DCAMWAIT_CAPEVENT_CYCLEEND is issued. If SNAPSHOTEX is selected, even before DCAMWAIT_CAPEVENT_CYCLEEND is issued (when capture stops before the specified number of frames have been acquired), frames missed up to dcamcap_stop() are retransmitted. Use SNAPSHOTEX unless there is a specific reason because SNAPSHOT is just retained for compatibility. The number of stored frames is limited. Therefore, the value of frame count set as argument of dcambuf_alloc() needs to be under the value of DCAM_IDPROP_DEVICEBUFFER_FRAMECOUNTMAX, or when using the dcambuf_attach() function, it must be less than or equal to the "buffercount" value specified in the DCAMBUF_ATTACH structure. The value of FRAMECOUNTMAX depends on active photosensitive size of each camera. The detail is described by the chapter of Camera Info. Device Buffer Mode is also described by "property_reference.html".
Device Buffer Mode
DCAM_IDPROP_DEVICEBUFFER_MODE
R/W
MODE
DCAMPROP_DEVICEBUFFER_MODE_THRU (disable:defalt)
DCAMPROP_DEVICEBUFFER_MODE_SNAPSHOT (enable)
DCAMPROP_DEVICEBUFFER_MODE_SNAPSHOTEX (enable)
DCAM_IDPROP_DEVICEBUFFER_FRAMECOUNTMAX
R/O
LONG
n The value of each camera is described by the chapter of Camera Info.

Go to top of this chapter


Primary Buffer


This function can set the ring buffer size allocated to the interface driver of PC. To increase the size may reduce the occurrence of lost frames. When specifying with PRIMARYBUFFER_TOTALBYTES, the value is in Bytes, and when specifying with PRIMARYBUFFER_TOTALBYTES_MB, the value is in MBytes. Use PRIMARYBUFFER_TOTALBYTES_MB unless there is a specific reason because PRIMARYBUFFER_TOTALBYTES is just retained for compatibility. If PRIMARYBUFFER_TOTALBYTES(_MB) is unspecified or set to 0, the default value (buffer for 100 frames) is reserved. Do not allocate more than necessary besause Primary Buffer uses memory on PC. It may affect the performance of PC.
Product DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES_MB
R/W LONG R/W LONG
C10500D-43 0 to 2000000000 0 to (2000 or 50% of PC memory(MB))
C10502D-43
C10900D-40
C10901D-40
C12902D-40
C12903D-40
C14400DK-41
C14401DK-41
C14406DK-81
C10500D-70 0 to (8191 × Value of DCAM_IDPROP_IMAGE_FRAMEBYTES) *Up to 2000000000 0 to (8191 × Value of DCAM_IDPROP_IMAGE_FRAMEBYTES/1000000)
C12504D-56
C10502D-70
C12505D-56
C14400DK-51
C14400DK-52
C14400DK-54
C14408DK-50
C14409DK-52
C16401SK-51

Go to top of this chapter


Camera Info


Camera wihtout Flexible Partial Mode
Scan mode ( A:available N/A:not available ) PANORAMICSTARTV value range
Product Fine(1x1) Fast(2x2) Panoramic Rtbin Panoramic Partial
C10500D-43 N/A N/A N/A N/A N/A N/A
C10500D-70 N/A N/A A A N/A N/A
C12504D-56 N/A N/A A A N/A N/A
C10502D-43 N/A N/A N/A N/A N/A N/A
C10502D-70 N/A N/A A A N/A N/A
C10505D-56 N/A N/A A A N/A N/A
C10900D-40 A A A N/A A 0 to 1160
C10901D-40 A A A N/A N/A N/A
C12902D-40 A A A A N/A 0 to 938
C12903D-40 A A A A N/A 0 to 1152
C14408DK-50 A A N/A N/A N/A N/A

Camera with Flexible Partial Mode
1x1 Mode 2x2 Mode 4x4 Mode 1x2 Mode 2x4 Mode
Horizontal Vertical Horizontal Vertical Horizontal Vertical Horizontal Vertical Horizontal Vertical
Product Size Position Size Position Size Position Size Position Size Position Size Position Size Position Size Position Size Position Size Position
C14400DK-41/51/52/54 8 to 1328 0 to 1320 1 to 1308 0 to 1307 16 to 1328 0 to 1312 2 to 1308 0 to 1306 N/A N/A N/A N/A 8 to 1328 0 to 1320 2 to 1308 0 to 1306 16 to 1328 0 to 1312 4 to 1308 0 to 1304
C14401DK-41 8 to 2192 0 to 2184 1 to 1776 0 to 1775 16 to 2192 0 to 2176 2 to 1776 0 to 1774 N/A N/A N/A N/A 8 to 2192 0 to 2184 2 to 1776 0 to 1774 16 to 2192 0 to 2176 4 to 1776 0 to 1772
C14406DK-81 4 to 3072 0 to 3068 1 to 3072 0 to 3068 8 to 3072 0 to 3064 2 to 3072 0 to 3064 16 to 3072 0 to 3056 8 to 3072 0 to 3056 N/A N/A N/A N/A N/A N/A N/A N/A
C14409DK-52 8 to 2000 0 to 1992 1 to 1392 0 to 1391 16 to 2000 0 to 1984 2 to 1392 0 to 1390 N/A N/A N/A N/A 8 to 2000 0 to 1992 2 to 1392 0 to 1390 N/A N/A N/A N/A
C16401SK-51 8 to 1272 0 to 1264 1 to 1104 0 to 1103 16 to 1272 0 to 1256 2 to 1104 0 to 1102 N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A

Notes:
The setting value is not changed if scan mode is changed. For example, you should set to HSIZE:800, VSIZE:640 when trying to achieve H:400, V:320 in 2x2 mode. The total value of POS and SIZE must not exceed the number of active photosensitive pixels of the camera.


FRAMECOUNTMAX value of cameras with Device Buffer Mode
Product Binning mode
1x1 2x2 1x2 2x4
C10500D-70 2925 N/A 5851 N/A
C12504D-56 4208 N/A 8407 N/A
C10502D-70 1940 N/A 3878 N/A
C12505D-56 2792 N/A 5585 N/A
C14400DK-51* 149 to 15863 598 to 15863 299 to 15863 1196 to 15863
C14400DK-52* 304 to 32247 1216 to 32247 608 to 32247 2433 to 32247
C14400DK-54* 618 to 65015 2452 to 65015 1226 to 65015 4905 to 65015
C14408DK-50 33 to 15863 135 to 15863 N/A N/A
C14409DK-52* 189 to 32247 792 to 32247 379 to 32247 N/A
C16401SK-51* 185 to 15863 740 to 15863 N/A N/A
*When the image size is reduced, the number of frames stored in buffer memory increases.

Go to top of this chapter