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 C10000-C01 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
DCAMPROP_SENSORMODE__TDI (default)
DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT
-
R
W
-
-
LONG
8 to 8056 , step 8 , default 256
DCAM_IDPROP_SENSORMODE_TDISTAGE
-
R
W
-
-
LONG
64 to 256 , step 64 , default 256
DCAM_IDPROP_READOUT_DIRECTION
-
R
W
W
W
MODE
DCAMPROP_READOUT_DIRECTION__FORWARD (default)
DCAMPROP_READOUT_DIRECTION__BACKWARD
Trigger
DCAM_IDPROP_TRIGGERSOURCE
-
R
W
W
W
MODE
DCAMPROP_TRIGGERSOURCE__INTERNAL (default) ALL DCAM_IDPROP_SENSORMODE
DCAMPROP_TRIGGERSOURCE__EXTERNAL @ DCAMPROP_SENSORMODE__TDI
DCAM_IDPROP_TRIGGER_MODE
-
R
-
-
-
MODE
DCAMPROP_TRIGGER_MODE__NORMAL
DCAM_IDPROP_TRIGGERACTIVE
-
R
-
-
-
MODE
DCAMPROP_TRIGGERACTIVE__SYNCREADOUT
DCAM_IDPROP_TRIGGERPOLARITY
-
R
W
W
W
MODE
DCAMPROP_TRIGGERPOLARITY__NEGATIVE (default)
DCAMPROP_TRIGGERPOLARITY__POSITIVE
DCAM_IDPROP_TRIGGER_CONNECTOR
-
R
W
W
W
MODE
DCAMPROP_TRIGGER_CONNECTOR__INTERFACE
DCAMPROP_TRIGGER_CONNECTOR__BNC (default)
DCAM_IDPROP_TRIGGERTIMES
-
R
W
W
W
LONG
1 to 10000 , step 1 , default 1
DCAM_IDPROP_TRIGGERENABLE_ACTIVE
-
R
W
W
W
MODE
DCAMPROP_TRIGGERENABLE_ACTIVE__ALWAYS (default)
DCAMPROP_TRIGGERENABLE_ACTIVE__START
DCAMPROP_TRIGGERENABLE_ACTIVE__BURST
DCAM_IDPROP_TRIGGERENABLE_POLARITY
-
R
W
W
W
MODE
DCAMPROP_TRIGGERENABLE_POLARITY__NEGATIVE (default)
DCAMPROP_TRIGGERENABLE_POLARITY__POSITIVE
DCAM_IDPROP_TRIGGERENABLE_BURSTTIMES
-
R
W
W
W
LONG
1 to 10000 , step 1 , default 1
Sensor cooler
DCAM_IDPROP_SENSORTEMPERATURE
-
R
-
-
-
REAL (degrees Celsius)
-50 to 100
DCAM_IDPROP_SENSORTEMPERATURE_STATUS
-
R
-
-
-
MODE
DCAMPROP_SENSORTEMPERATURE_STATUS__NORMAL
DCAMPROP_SENSORTEMPERATURE_STATUS__WARNING
Binning and ROI
DCAM_IDPROP_BINNING
-
R
W
-
-
MODE
DCAMPROP_BINNING__1 (default) ALL DCAM_IDPROP_SENSORMODE
DCAMPROP_BINNING__2 @ DCAMPROP_SENSORMODE__TDI
DCAM_IDPROP_SUBARRAYHPOS
-
R
W
-
-
LONG
0 to 4094 , step 2 , default 0 @ DCAMPROP_SENSORMODE__TDI
0 to 4095 , step 1 , default 0 @ DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_SUBARRAYHSIZE
-
R
W
-
-
LONG
2 to 4096 , step 2 , default 4096 @ DCAMPROP_SENSORMODE__TDI
1 to 4096 , step 1 , default 4096 @ DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_SUBARRAYVPOS
-
R
W
-
-
LONG
0 to 255 , step 1 , default 0
DCAM_IDPROP_SUBARRAYVSIZE
-
R
W
-
-
LONG
1 to 256 , step 1 , default 256
DCAM_IDPROP_SUBARRAYMODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
Feature
DCAM_IDPROP_EXPOSURETIME
-
R
W
W
W
REAL (Second)
0.00256 to 0.52428 , step 0.000008 , default 0.00256 @ DCAMPROP_SENSORMODE__TDI
0.00512 to 1.00096 , step 0.00256 , default 0.00512 @ DCAMPROP_SENSORMODE__AREA
DCAM_IDPROP_CONTRASTGAIN
-
R
W
W
W
LONG
0 to 15 , step 1 , default 0
ALU
DCAM_IDPROP_CAPTUREMODE
-
R
W
W
-
MODE
DCAMPROP_CAPTUREMODE__NORMAL (default) ALL DCAM_IDPROP_SENSORMODE
DCAMPROP_CAPTUREMODE__DARKCALIB @ DCAMPROP_SENSORMODE__TDI
DCAMPROP_CAPTUREMODE__SHADINGCALIB @ DCAMPROP_SENSORMODE__TDI
DCAM_IDPROP_SUBTRACT
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default) ALL DCAM_IDPROP_SENSORMODE
DCAMPROP_MODE__ON @ DCAMPROP_SENSORMODE__TDI
DCAM_IDPROP_SUBTRACTOFFSET
-
R
W
W
W
LONG
0 to 1000 , step 1 , default 0
DCAM_IDPROP_SUBTRACTIMAGEMEMORY
-
R
W
W
-
MODE
1,2,3,4,5,6,7,8
DCAM_IDPROP_DARKCALIB_SAMPLES
-
R
W
W
-
LONG
1 to 65536 , step 1 , default 1024
DCAM_IDPROP_STORESUBTRACTIMAGETOMEMORY
-
-
W
-
-
MODE
1,2,3,4,5,6,7,8
DCAM_IDPROP_SHADINGCORRECTION
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF (default) ALL DCAM_IDPROP_SENSORMODE
DCAMPROP_MODE__ON @ DCAMPROP_SENSORMODE__TDI
DCAM_IDPROP_SHADINGCALIBDATAMEMORY
-
R
W
W
-
MODE
1,2,3,4,5,6,7,8
DCAM_IDPROP_SHADINGCALIB_SAMPLES
-
R
W
W
-
LONG
1 to 65536 , step 1 , default 1024
DCAM_IDPROP_STORESHADINGCALIBDATATOMEMORY
-
-
W
-
-
MODE
1,2,3,4,5,6,7,8
DCAM_IDPROP_INTENSITYLUT_MODE
-
R
W
W
-
MODE
DCAMPROP_INTENSITYLUT_MODE__THROUGH (default)
DCAMPROP_INTENSITYLUT_MODE__PAGE
DCAM_IDPROP_INTENSITYLUT_PAGE
-
R
-
-
-
MODE
1
DCAM_IDPROP_SHADINGCALIB_METHOD
-
R
-
-
-
MODE
DCAMPROP_SHADINGCALIB_METHOD__USETARGET
DCAM_IDPROP_SHADINGCALIB_TARGET
-
R
W
W
-
LONG
1000 to 4095 , step 1 , default 3200
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
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.
DCAM_IDPROP_INTERNALLINERATE
-
R
W
W
W
REAL (Hz)
488.288700694 to 100000.0 , step 0.007450922
DCAM_IDPROP_INTERNALLINESPEED
-
R
W
W
W
REAL (m/s)
0.003418021 to 0.7 , step 0.000000052
System Information
DCAM_IDPROP_COLORTYPE
-
R
-
-
-
MODE
DCAMPROP_COLORTYPE__BW
DCAM_IDPROP_BITSPERCHANNEL
-
R
-
-
-
LONG
return 12
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_MONO8
DCAM_PIXELTYPE_MONO16 (default)
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_MONO8
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_IMAGEDETECTOR_PIXELWIDTH
4.0
R
-
-
-
REAL (um)
return 7.000000
DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT
4.0
R
-
-
-
REAL (um)
return 7.000000
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMHORZ
4.0
R
-
-
-
LONG
return 4096
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMVERT
4.0
R
-
-
-
LONG
return 256
DCAM_IDPROP_TIMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_TIMESTAMP_PRODUCER__CAPTUREDEVICE
DCAM_IDPROP_FRAMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_FRAMESTAMP_PRODUCER__DCAMMODULE

Go to top of this chapter