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 C9100-23B 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
-
-
-
MODE
DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_CCDMODE
-
R
W
-
-
MODE
DCAMPROP_CCDMODE__NORMALCCD
DCAMPROP_CCDMODE__EMCCD (default)
DCAM_IDPROP_EMCCD_CALIBRATIONMODE
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_READOUTSPEED
-
R
W
-
-
LONG
1 to 3 , step 1 , default 3 @ DCAMPROP_CCDMODE__EMCCD
1 to 1 , step 0 , default 1 @ DCAMPROP_CCDMODE__NORMALCCD
Trigger
DCAM_IDPROP_TRIGGERSOURCE
-
R
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)
DCAMPROP_TRIGGERACTIVE__LEVEL
DCAMPROP_TRIGGERACTIVE__SYNCREADOUT
DCAM_IDPROP_TRIGGERPOLARITY
-
R
W
W
W
MODE
DCAMPROP_TRIGGERPOLARITY__NEGATIVE (default)
DCAMPROP_TRIGGERPOLARITY__POSITIVE
DCAM_IDPROP_TRIGGERTIMES
-
R
W
W
W
LONG
1 to 4095 , step 1 , default 1
DCAM_IDPROP_TRIGGERDELAY
-
R
W
W
W
REAL (Second)
0 to 10.0 , step 0.00001 , default 0
DCAM_IDPROP_INTERNALTRIGGER_HANDLING
-
R
W
W
-
MODE
DCAMPROP_INTERNALTRIGGER_HANDLING__SHORTEREXPOSURETIME
DCAMPROP_INTERNALTRIGGER_HANDLING__FASTERFRAMERATE (default)
Sensor cooler
DCAM_IDPROP_SENSORTEMPERATURE
-
R
-
-
-
REAL (degrees Celsius)
-100 to 50
DCAM_IDPROP_SENSORCOOLER (at Air Cooling)
-
R
W
W
W
MODE
DCAMPROP_SENSORCOOLER__ON (default)
DCAMPROP_SENSORCOOLER__MAX
DCAM_IDPROP_SENSORCOOLER (at Water Cooling)
-
R
W
W
W
MODE
DCAMPROP_SENSORCOOLER__OFF (default)
DCAMPROP_SENSORCOOLER__ON
DCAMPROP_SENSORCOOLER__MAX
DCAM_IDPROP_SENSORTEMPERATURETARGET
-
R
-
-
-
REAL (degrees Celsius)
-100 to -65 , step 35 , default -65 @ Air Cooling
-100 to -80 , step 20 , default -80 @ Water Cooling
DCAM_IDPROP_SENSORCOOLERSTATUS
-
R
-
-
-
MODE
DCAMPROP_SENSORCOOLERSTATUS__OFF @ Water Cooling
DCAMPROP_SENSORCOOLERSTATUS__READY
DCAMPROP_SENSORCOOLERSTATUS__BUSY
DCAMPROP_SENSORCOOLERSTATUS__ALWAYS
DCAM_IDPROP_SENSORCOOLERFAN
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF
DCAMPROP_MODE__ON (default)
Sensitivity
DCAM_IDPROP_DIRECTEMGAIN_MODE
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_SENSITIVITYMODE
-
R
-
-
-
MODE
DCAMPROP_SENSITIVITYMODE__ON
DCAM_IDPROP_SENSITIVITY
-
R
W
W
W
REAL
0 to 255.0 , step 1.0 , default 0
DCAM_IDPROP_PHOTONIMAGINGMODE
-
R
W
W
W
MODE
DCAMPROP_PHOTONIMAGINGMODE__0 (default)
DCAMPROP_PHOTONIMAGINGMODE__1
DCAMPROP_PHOTONIMAGINGMODE__2
DCAMPROP_PHOTONIMAGINGMODE__3
DCAM_IDPROP_MEASURED_SENSITIVITY
-
R
-
-
-
REAL
0 to 1200
DCAM_IDPROP_EMGAINWARNING_STATUS
-
R
-
-
-
MODE
DCAMPROP_EMGAINWARNING_STATUS__NORMAL
DCAMPROP_EMGAINWARNING_STATUS__WARNING
DCAMPROP_EMGAINWARNING_STATUS__PROTECTED
DCAM_IDPROP_EMGAINWARNING_LEVEL
-
R
W
W
W
LONG
1 to 3 , step 1 , default 3
DCAM_IDPROP_EMGAINWARNING_ALARM
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_EMGAINPROTECT_MODE
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_EMGAINPROTECT_AFTERFRAMES
-
R
W
W
W
LONG
1 to 255 , step 1 , default 1
Binning and ROI
DCAM_IDPROP_BINNING
-
R
W
-
-
MODE
DCAMPROP_BINNING__1 (default)
DCAMPROP_BINNING__2
DCAMPROP_BINNING__4
DCAMPROP_BINNING__8 M10354-03
DCAMPROP_BINNING__16 M10354-03
DCAM_IDPROP_SUBARRAYHPOS
-
R
W
-
-
LONG
0 to 496 , step 16 , default 0
DCAM_IDPROP_SUBARRAYHSIZE
-
R
W
-
-
LONG
16 to 512 , step 16 , default 512
DCAM_IDPROP_SUBARRAYVPOS
-
R
W
-
-
LONG
0 to 496 , step 16 , default 0
DCAM_IDPROP_SUBARRAYVSIZE
-
R
W
-
-
LONG
16 to 512 , step 16 , default 512
DCAM_IDPROP_SUBARRAYMODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
Feature
DCAM_IDPROP_EXPOSURETIME_CONTROL
-
R
W
W
W
MODE
DCAMPROP_EXPOSURETIME_CONTROL__OFF
DCAMPROP_EXPOSURETIME_CONTROL__NORMAL (default)
DCAM_IDPROP_EXPOSURETIME
-
R
W
W
W
REAL (Second)
0.0139 to 1.0 , step 0.00001 , default 0.0139 @ DCAM_IDPROP_READOUTSPEED = 3
0.02713 to 7200.0 , step 0.00001 , default 0.02713 @ DCAM_IDPROP_READOUTSPEED = 2
0.42147 to 7200.0 , step 0.00001 , default 0.42147 @ DCAM_IDPROP_READOUTSPEED = 1 or DCAMPROP_CCDMODE__NORMALCCD
DCAM_IDPROP_HIGHDYNAMICRANGE_MODE
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default) Cannot change to ON when DCAM_IDPROP_READOUTSPEED = 3 or DCAMPROP_CCDMODE__NORMALCCD
DCAMPROP_MODE__ON
DCAM_IDPROP_DIRECTGAIN_MODE
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_CONTRASTGAIN
-
R
W
W
W
LONG
1 to 5 , step 1 , default 1 @ DCAMPROP_CCDMODE__NORMALCCD
1 to 1 , step 0 , default 1 @ DCAMPROP_CCDMODE__EMCCD
ALU
DCAM_IDPROP_CAPTUREMODE
-
R
W
W
-
MODE
DCAMPROP_CAPTUREMODE__NORMAL (default)
DCAMPROP_CAPTUREMODE__DARKCALIB
DCAMPROP_CAPTUREMODE__SHADINGCALIB
DCAM_IDPROP_INTERFRAMEALU_ENABLE
-
R
W
W
-
MODE
DCAMPROP_INTERFRAMEALU_ENABLE__OFF
DCAMPROP_INTERFRAMEALU_ENABLE__TRIGGERSOURCE_ALL
DCAMPROP_INTERFRAMEALU_ENABLE__TRIGGERSOURCE_INTERNAL (default)
DCAM_IDPROP_FRAMEAVERAGINGMODE
-
R
W
W
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_FRAMEAVERAGINGFRAMES
-
R
W
W
-
MODE
2,4
DCAM_IDPROP_RECURSIVEFILTER
-
R
W
W
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_RECURSIVEFILTERFRAMES
-
R
W
W
-
MODE
DCAMPROP_RECURSIVEFILTERFRAMES__2 (default)
DCAMPROP_RECURSIVEFILTERFRAMES__4
DCAMPROP_RECURSIVEFILTERFRAMES__8
DCAMPROP_RECURSIVEFILTERFRAMES__16
DCAM_IDPROP_SPOTNOISEREDUCER
-
R
W
W
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_SUBTRACT
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_SUBTRACTOFFSET
-
R
W
W
W
LONG
0 to 10000 , step 1 , default 0
DCAM_IDPROP_SUBTRACTIMAGEMEMORY
-
R
W
W
-
MODE
1,2,3,4
DCAM_IDPROP_STORESUBTRACTIMAGETOMEMORY
-
-
W
W
-
MODE
1,2,3,4
DCAM_IDPROP_SHADINGCORRECTION
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_SHADINGCALIBDATAMEMORY
-
R
W
W
-
MODE
1,2,3,4
DCAM_IDPROP_STORESHADINGCALIBDATATOMEMORY
-
-
W
W
-
MODE
1,2,3,4
DCAM_IDPROP_INTENSITYLUT_MODE
-
R
W
W
W
MODE
DCAMPROP_INTENSITYLUT_MODE__THROUGH (default)
DCAMPROP_INTENSITYLUT_MODE__CLIP
DCAM_IDPROP_INTENSITYLUT_WHITECLIP
-
R
W
W
W
LONG
0 to 65535 , step 1 , default 65535
DCAM_IDPROP_INTENSITYLUT_BLACKCLIP
-
R
W
W
W
LONG
0 to 65535 , step 1 , default 0
Output Trigger
DCAM_IDPROP_NUMBEROF_OUTPUTTRIGGERCONNECTOR
-
R
-
-
-
LONG
return 3
DCAM_IDPROP_OUTPUTTRIGGER_SOURCE
-
R
-
-
-
MODE
DCAMPROP_OUTPUTTRIGGER_SOURCE__EXPOSURE
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.00001 , default 0
DCAM_IDPROP_OUTPUTTRIGGER_PERIOD
-
R
W
W
W
REAL (Second)
0.00001 to 7200.0 , step 0.00001 , default 0.001
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
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_EXPOSURE
-
R
-
-
-
MODE
DCAMPROP_TIMING_EXPOSURE__AFTERREADOUT
DCAMPROP_TIMING_EXPOSURE__OVERLAPREADOUT
DCAM_IDPROP_TIMING_INVALIDEXPOSUREPERIOD
-
R
-
-
-
REAL (Second)
return seconds of period which exposure is not started from trigger.
DCAM_IDPROP_INTERNALFRAMERATE
-
R
-
-
-
REAL (Hz)
return number of frames per second in INTERNAL trigger mode.
DCAM_IDPROP_INTERNAL_FRAMEINTERVAL
-
R
-
-
-
REAL (Second)
return seconds of interval between frames in INTERNAL trigger mode.
System Information
DCAM_IDPROP_COLORTYPE
-
R
-
-
-
MODE
DCAMPROP_COLORTYPE__BW
DCAM_IDPROP_BITSPERCHANNEL
-
R
-
-
-
LONG
return 16
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
-
-
-
MODE
DCAM_PIXELTYPE_MONO16
DCAM_IDPROP_IMAGE_CAMERASTAMP
4.0
R
W
-
-
LONG
0 to 65535 , step 1 , default 0
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
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_SYSTEM_ALIVE
-
R
-
-
-
MODE
DCAMPROP_SYSTEM_ALIVE__OFFLINE
DCAMPROP_SYSTEM_ALIVE__ONLINE
DCAM_IDPROP_CONVERSIONFACTOR_COEFF
-
R
-
-
-
REAL
return current conversion factor coefficient
DCAM_IDPROP_CONVERSIONFACTOR_OFFSET
-
R
-
-
-
REAL
return current conversion factor offset
DCAM_IDPROP_IMAGEDETECTOR_PIXELWIDTH
4.0
R
-
-
-
REAL (um)
return 16.0
DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT
4.0
R
-
-
-
REAL (um)
return 16.0
DCAM_IDPROP_TIMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_TIMESTAMP_PRODUCER__IMAGINGDEVICE
DCAM_IDPROP_FRAMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_FRAMESTAMP_PRODUCER__IMAGINGDEVICE
DCAM_IDPROP_CAMERASTATUS_CALIBRATION
-
R
-
-
-
MODE
DCAMPROP_CAMERASTATUS_CALIBRATION__DONE
DCAMPROP_CAMERASTATUS_CALIBRATION__NOTYET

Go to top of this chapter