v24.9.6861

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 C14120-20P 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


How to read the table


Property List is described according to the following rules.
1.Classfication
2.PropertyID
3.
4.
5.
6.
7.
8.ValueType
9.PropertyValue 10.Information
Description table
index item explanation
1 Classification Large classification of the Property.
2 Property ID Property ID that camera supported.
3 Property Ver DCAM-API version of this Property.
4 Readable Flag Whether it is possible to read the value from this Property. In the case of "-" is not readable. In the case of "R" is readable.
5 Writable Flag(Stable) Whether it is possible to change this Property value during status is "Stable". In the case of "-" is not writable. In the case of "W" is writable.
6 Writable Flag(Ready) Whether it is possible to change this Property value during status is "Ready". In the case of "-" is not writable. In the case of "W" is writable.
7 Writable Flag(Busy) Whether it is possible to change this Property value during status is "Busy". In the case of "-" is not writable. In the case of "W" is writable.
8 Value Type Property value types : MODE, LONG and REAL.
9 Property Value ID or minimum, maximum, default, step values from this Property.
10 Information Additional information about this Property.

Go to top of this chapter


Property List


Sensor mode and speed
DCAM_IDPROP_SENSORMODE
-
R
W
-
-
MODE
DCAMPROP_SENSORMODE__AREA (default)
DCAMPROP_SENSORMODE__PROGRESSIVE
DCAM_IDPROP_READOUT_DIRECTION
-
R
-
-
-
MODE
DCAMPROP_READOUT_DIRECTION__FORWARD
Trigger
DCAM_IDPROP_TRIGGERSOURCE
-
R
W
W
W
MODE
DCAMPROP_TRIGGERSOURCE__INTERNAL (default)
DCAMPROP_TRIGGERSOURCE__EXTERNAL
DCAMPROP_TRIGGERSOURCE__SOFTWARE
DCAM_IDPROP_TRIGGER_MODE
-
R
W
W
-
MODE
DCAMPROP_TRIGGER_MODE__NORMAL (default)
DCAMPROP_TRIGGER_MODE__START
DCAM_IDPROP_TRIGGERACTIVE
-
R
W
W
-
MODE
DCAMPROP_TRIGGERACTIVE__EDGE (default) ALL DCAM_IDPROP_SENSORMODE
DCAMPROP_TRIGGERACTIVE__LEVEL @ DCAMPROP_SENSORMODE__AREA
DCAMPROP_TRIGGERACTIVE__SYNCREADOUT @ DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_TRIGGER_GLOBALEXPOSURE
-
R
W
-
-
MODE
DCAMPROP_TRIGGER_GLOBALEXPOSURE__DELAYED (default)
DCAMPROP_TRIGGER_GLOBALEXPOSURE__GLOBALRESET
DCAM_IDPROP_TRIGGERPOLARITY
-
R
W
W
W
MODE
DCAMPROP_TRIGGERPOLARITY__NEGATIVE (default)
DCAMPROP_TRIGGERPOLARITY__POSITIVE
DCAM_IDPROP_TRIGGER_CONNECTOR
-
R
-
-
-
MODE
DCAMPROP_TRIGGER_CONNECTOR__BNC
DCAM_IDPROP_TRIGGERTIMES
-
R
W
W
W
LONG
1 to 65536 , step 1 , default 1
DCAM_IDPROP_TRIGGERDELAY
-
R
W
W
W
REAL (Second)
0 to 10.0 , step 0.000001 , default 0 @ DCAMPROP_SENSORMODE__AREA
0 to 0.008119552 , step 0.000012608 , default 0 @ DCAMPROP_SENSORMODE__PROGRESSIVE
Depends on INTERNALLINESPEED and INTERNAL_LINEINTERVAL, OUTPUTTRIGGER_PREHSYNCCOUNT
Sensor cooler
DCAM_IDPROP_SENSORCOOLER (at Water Cooling only)
-
R
W
W
W
MODE
DCAMPROP_SENSORCOOLER__OFF
DCAMPROP_SENSORCOOLER__ON
DCAM_IDPROP_SENSORCOOLERSTATUS
-
R
-
-
-
MODE
DCAMPROP_SENSORCOOLERSTATUS__READY @ Air Cooling
DCAMPROP_SENSORCOOLERSTATUS__OFF @ Water Cooling
Binning and ROI
DCAM_IDPROP_BINNING
-
R
W
-
-
MODE
DCAMPROP_BINNING__1 (default) ALL DCAM_IDPROP_SENSORMODE
DCAMPROP_BINNING__2 @ DCAMPROP_SENSORMODE__AREA
DCAMPROP_BINNING__4 @ DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_SUBARRAYHPOS
-
R
W
-
-
LONG
0 to 4480 , step 128 , default 0
DCAM_IDPROP_SUBARRAYHSIZE
-
R
W
-
-
LONG
128 to 4608 , step 128 , default 4608
DCAM_IDPROP_SUBARRAYVPOS
-
R
W
-
-
LONG
0 to 2588 , step 4 , default 0
DCAM_IDPROP_SUBARRAYVSIZE
-
R
W
-
-
LONG
4 to 2592 , step 4 , default 2592
DCAM_IDPROP_SUBARRAYMODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_FRAMEBUNDLE_MODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON Depends on SUBARRAY properties
DCAM_IDPROP_FRAMEBUNDLE_NUMBER
-
R
W
-
-
LONG
2 to 18662 , step 1 , default 2 Depends on SUBARRAY properties
Feature
DCAM_IDPROP_EXPOSURETIME
-
R
W
W
W
REAL (Second)
0.000012608 to 1.00000352 , step 0.00000001 , default 0.0081952 @ DCAMPROP_SENSORMODE__AREA and DCAMPROP_BITSPERCHANNEL__12
Depends on SUBARRAY properties
0.000050432 to 1.000001613 , step 0.00000001 , default 0.0081952 @ DCAMPROP_SENSORMODE__AREA and DCAMPROP_BITSPERCHANNEL__16
0.000012608 to 0.008169984 , step 0.00000001 , default 0.008169984 @ DCAMPROP_SENSORMODE__PROGRESSIVE
Depends on INTERNALLINESPEED and INTERNAL_LINEINTERVAL, SUBARRAY properties
DCAM_IDPROP_HIGHDYNAMICRANGE_MODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default) Standard Full Well Capacity mode
DCAM_IDPROP_BITSPERCHANNEL will be changed to 12
DCAMPROP_MODE__ON High Full Well Capacity mode
DCAM_IDPROP_BITSPERCHANNEL will be changed to 16
ALU
DCAM_IDPROP_DEFECTCORRECT_MODE
-
R
W
W
W
MODE
DCAMPROP_DEFECTCORRECT_MODE__OFF
DCAMPROP_DEFECTCORRECT_MODE__ON (default)
Output Trigger
DCAM_IDPROP_NUMBEROF_OUTPUTTRIGGERCONNECTOR
-
R
-
-
-
LONG
return 3
DCAM_IDPROP_OUTPUTTRIGGER_SOURCE
-
R
W
W
W
MODE
DCAMPROP_OUTPUTTRIGGER_SOURCE__READOUTEND
DCAMPROP_OUTPUTTRIGGER_SOURCE__VSYNC (default)
DCAMPROP_OUTPUTTRIGGER_SOURCE__HSYNC @ DCAMPROP_SENSORMODE__PROGRESSIVE
DCAM_IDPROP_OUTPUTTRIGGER_POLARITY
-
R
W
W
W
MODE
DCAMPROP_OUTPUTTRIGGER_POLARITY__NEGATIVE (default)
DCAMPROP_OUTPUTTRIGGER_POLARITY__POSITIVE
DCAM_IDPROP_OUTPUTTRIGGER_ACTIVE
-
R
-
-
-
MODE
DCAMPROP_OUTPUTTRIGGER_ACTIVE__EDGE
DCAM_IDPROP_OUTPUTTRIGGER_DELAY
-
R
W
W
W
REAL (Second)
0 to 10.0 , step 0.000001 , default 0
DCAM_IDPROP_OUTPUTTRIGGER_PERIOD
-
R
W
W
W
REAL (Second)
0.000001 to 10.0 , step 0.000001 , default 0.000001
DCAM_IDPROP_OUTPUTTRIGGER_KIND
-
R
W
W
W
MODE
DCAMPROP_OUTPUTTRIGGER_KIND__LOW (default)
DCAMPROP_OUTPUTTRIGGER_KIND__EXPOSURE
DCAMPROP_OUTPUTTRIGGER_KIND__PROGRAMABLE
DCAMPROP_OUTPUTTRIGGER_KIND__TRIGGERREADY
DCAMPROP_OUTPUTTRIGGER_KIND__HIGH
DCAM_IDPROP_OUTPUTTRIGGER_PREHSYNCCOUNT
-
R
W
W
W
LONG
3 to 647 , step 1 , default 3
Synchronous timing
DCAM_IDPROP_TIMING_READOUTTIME
-
R
-
-
-
REAL (Second)
return seconds how long takes to reading out a frame.
DCAM_IDPROP_TIMING_CYCLICTRIGGERPERIOD
-
R
-
-
-
REAL (Second)
return seconds which period cyclic trigger happens in.
DCAM_IDPROP_TIMING_MINTRIGGERBLANKING
-
R
-
-
-
REAL (Second)
return seconds required minimum trigger blanking.
DCAM_IDPROP_TIMING_MINTRIGGERINTERVAL
-
R
-
-
-
REAL (Second)
return seconds required minimum trigger interval.
DCAM_IDPROP_TIMING_GLOBALEXPOSUREDELAY
-
R
-
-
-
REAL (Second)
return seconds how long takes to start global exposure.
DCAM_IDPROP_TIMING_EXPOSURE
-
R
-
-
-
MODE
DCAMPROP_TIMING_EXPOSURE__ROLLING
DCAM_IDPROP_TIMING_INVALIDEXPOSUREPERIOD
-
R
-
-
-
REAL (Second)
return seconds of period which exposure is not started from trigger.
DCAM_IDPROP_INTERNALFRAMERATE
-
R
W
W
W
REAL (Hz)
return number of frames per second in INTERNAL trigger mode. @ DCAMPROP_SENSORMODE__AREA
Read Only when sensor mode is AREA.
40.757821589 to 60.91760431, step 0 @ DCAMPROP_SENSORMODE__PROGRESSIVE
Depends on INTERNALLINESPEED and INTERNAL_LINEINTERVAL
DCAM_IDPROP_INTERNAL_FRAMEINTERVAL
-
R
W
W
W
REAL (Second)
return seconds of interval between frames in INTERNAL trigger mode. @ DCAMPROP_SENSORMODE__AREA
Read Only when sensor mode is AREA.
0.016415616 to 0.024535168, step 0 @ DCAMPROP_SENSORMODE__PROGRESSIVE
Depends on INTERNALLINESPEED and INTERNAL_LINEINTERVAL
DCAM_IDPROP_INTERNALLINESPEED
-
R
W
W
W
REAL (m/s)
return speed on the sensor. @ DCAMPROP_SENSORMODE__AREA
Read Only when sensor mode is AREA.
0.0275 to 0.436230964, step 0.00000088 @ DCAMPROP_SENSORMODE__PROGRESSIVE
DCAM_IDPROP_INTERNAL_LINEINTERVAL
-
R
W
W
W
REAL (Second)
return seconds of interval between two lines timings. @ DCAMPROP_SENSORMODE__AREA
Read Only when sensor mode is AREA.
0.000012608 to 0.0002, step 0.000000006 @ DCAMPROP_SENSORMODE__PROGRESSIVE
System Information
DCAM_IDPROP_COLORTYPE
-
R
-
-
-
MODE
DCAMPROP_COLORTYPE__BW
DCAM_IDPROP_BITSPERCHANNEL
-
R
-
-
-
LONG
12 @ DCAM_IDPROP_HIGHDYNAMICRANGE_MODE is OFF
16 @ DCAM_IDPROP_HIGHDYNAMICRANGE_MODE is ON
DCAM_IDPROP_IMAGE_WIDTH
-
R
-
-
-
LONG
return width pixel of current setting
DCAM_IDPROP_IMAGE_HEIGHT
-
R
-
-
-
LONG
return height line of current setting
DCAM_IDPROP_IMAGE_ROWBYTES
-
R
-
-
-
LONG
return horizontal rowbytes of current setting
DCAM_IDPROP_IMAGE_FRAMEBYTES
-
R
-
-
-
LONG
return bytes per frame of current setting
DCAM_IDPROP_IMAGE_TOPOFFSETBYTES
-
R
-
-
-
LONG
return offset bytes size to point first data in image
DCAM_IDPROP_IMAGE_PIXELTYPE
-
R
W
-
-
MODE
DCAM_PIXELTYPE_MONO16 (default) ALL DCAM_IDPROP_BITSPERCHANNEL
DCAM_PIXELTYPE_MONO12P @ DCAMPROP_BITSPERCHANNEL__12
DCAM_IDPROP_BUFFER_ROWBYTES
4.0
R
-
-
-
LONG
return row byte size of user attached buffer
DCAM_IDPROP_BUFFER_FRAMEBYTES
4.0
R
-
-
-
LONG
return byte size of a frame buffer that should be allocated when you use dcambuf_attach() function
DCAM_IDPROP_BUFFER_TOPOFFSETBYTES
4.0
R
-
-
-
LONG
return unnecessary data size in front of the actual image data
DCAM_IDPROP_BUFFER_PIXELTYPE
4.0
R
-
-
-
MODE
DCAM_PIXELTYPE_MONO16 ALL DCAM_IDPROP_BITSPERCHANNEL
DCAM_PIXELTYPE_MONO12P @ DCAMPROP_BITSPERCHANNEL__12
DCAM_IDPROP_RECORDFIXEDBYTES_PERFILE
4.0
R
-
-
-
LONG
return additional data size per a file
DCAM_IDPROP_RECORDFIXEDBYTES_PERSESSION
4.0
R
-
-
-
LONG
return additional data size per a session
DCAM_IDPROP_RECORDFIXEDBYTES_PERFRAME
4.0
R
-
-
-
LONG
return additional data size per a frame
DCAM_IDPROP_FRAMEBUNDLE_ROWBYTES
-
R
-
-
-
LONG
return horizontal rowbytes of current setting
DCAM_IDPROP_FRAMEBUNDLE_FRAMESTEPBYTES
-
R
-
-
-
LONG
return bytes of gap between two frames in a same frame bundle
DCAM_IDPROP_SYSTEM_ALIVE
-
R
-
-
-
MODE
DCAMPROP_SYSTEM_ALIVE__OFFLINE
DCAMPROP_SYSTEM_ALIVE__ONLINE
DCAM_IDPROP_IMAGEDETECTOR_PIXELWIDTH
4.0
R
-
-
-
REAL (um)
return 5.5
DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT
4.0
R
-
-
-
REAL (um)
return 5.5
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMHORZ
4.0
R
-
-
-
LONG
return 4608
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMVERT
4.0
R
-
-
-
LONG
return 2592
DCAM_IDPROP_TIMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_TIMESTAMP_PRODUCER__IMAGINGDEVICE
DCAM_IDPROP_FRAMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_FRAMESTAMP_PRODUCER__IMAGINGDEVICE

Go to top of this chapter