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 C15853-02 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__LINE
DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT
-
R
W
-
-
LONG
8 to 128 , step 1 , default 128
DCAM_IDPROP_READOUTSPEED
-
R
-
-
-
LONG
return 2
DCAM_IDPROP_READOUT_FREQUENCY
4.0
R
-
-
-
REAL (Hz)
return 15000000.000000
Trigger
DCAM_IDPROP_TRIGGERSOURCE
-
R
W
W
-
MODE
DCAMPROP_TRIGGERSOURCE__INTERNAL (default)
DCAMPROP_TRIGGERSOURCE__EXTERNAL
DCAMPROP_TRIGGERSOURCE__SOFTWARE
DCAM_IDPROP_TRIGGER_MODE
-
R
-
-
-
MODE
DCAMPROP_TRIGGER_MODE__NORMAL
DCAM_IDPROP_TRIGGERACTIVE
-
R
-
-
-
MODE
DCAMPROP_TRIGGERACTIVE__EDGE
DCAM_IDPROP_TRIGGERPOLARITY
-
R
W
W
W
MODE
DCAMPROP_TRIGGERPOLARITY__NEGATIVE
DCAMPROP_TRIGGERPOLARITY__POSITIVE (default)
DCAM_IDPROP_TRIGGER_CONNECTOR
-
R
-
-
-
MODE
DCAMPROP_TRIGGER_CONNECTOR__BNC
DCAM_IDPROP_TRIGGERTIMES
-
R
W
W
W
LONG
0 to 0 , step 1 , default 0
DCAM_IDPROP_TRIGGERDELAY
-
R
W
W
W
REAL (Second)
0.0 to 0.0 , step 1.0 , default 0.0
Sensor cooler
DCAM_IDPROP_SENSORTEMPERATURE
-
R
-
-
-
REAL (degrees Celsius)
9.7 to 291.7
DCAM_IDPROP_SENSORCOOLER
-
R
-
-
-
MODE
DCAMPROP_SENSORCOOLER__OFF
DCAM_IDPROP_SENSORTEMPERATURETARGET
-
R
-
-
-
REAL (degrees Celsius)
return 0.000000
DCAM_IDPROP_SENSORCOOLERSTATUS
-
R
-
-
-
MODE
DCAMPROP_SENSORCOOLERSTATUS__OFF
DCAM_IDPROP_SENSORCOOLERFAN
-
R
W
W
W
MODE
DCAMPROP_MODE__OFF
Binning and ROI
DCAM_IDPROP_BINNING
-
R
-
-
-
MODE
DCAMPROP_BINNING__1
DCAM_IDPROP_SUBARRAYHPOS
-
R
W
-
-
LONG
0 to 1023 , step 1 , default 0
DCAM_IDPROP_SUBARRAYHSIZE
-
R
W
-
-
LONG
1 to 1024 , step 1 , default 1024
DCAM_IDPROP_SUBARRAYVPOS
-
R
-
-
-
LONG
0 to 127
DCAM_IDPROP_SUBARRAYVSIZE
-
R
-
-
-
LONG
1 to 128
DCAM_IDPROP_SUBARRAYMODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
Feature
DCAM_IDPROP_EXPOSURETIME
-
R
W
W
W
REAL (Second)
0.000021 to 5.0 , step 0.000001 , default 0.000021
DCAM_IDPROP_CONTRASTGAIN
-
R
W
W
W
LONG
0 to 3 , step 1 , default 0
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.
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_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 0.000000
DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT
4.0
R
-
-
-
REAL (um)
return 0.000000
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMHORZ
4.0
R
-
-
-
LONG
return 1024
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMVERT
4.0
R
-
-
-
LONG
return 1
DCAM_IDPROP_TIMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_TIMESTAMP_PRODUCER__DCAMMODULE
DCAM_IDPROP_FRAMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_FRAMESTAMP_PRODUCER__IMAGINGDEVICE

Go to top of this chapter