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 C10650-321 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
1 to 7167 , step 1 , default 1
DCAM_IDPROP_OUTPUT_INTENSITY
-
R
W
-
-
MODE
DCAMPROP_OUTPUT_INTENSITY__NORMAL (default)
DCAMPROP_OUTPUT_INTENSITY__TESTPATTERN
DCAM_IDPROP_TESTPATTERN_KIND
-
R
W
-
-
MODE
DCAMPROP_TESTPATTERN_KIND__FLAT (default)
DCAMPROP_TESTPATTERN_KIND__IFLAT
DCAMPROP_TESTPATTERN_KIND__HORZGRADATION
DCAMPROP_TESTPATTERN_KIND__IHORZGRADATION
DCAMPROP_TESTPATTERN_KIND__VERTGRADATION
DCAMPROP_TESTPATTERN_KIND__IVERTGRADATION
DCAMPROP_TESTPATTERN_KIND__LINE
DCAMPROP_TESTPATTERN_KIND__ILINE
DCAMPROP_TESTPATTERN_KIND__DIAGONAL
DCAMPROP_TESTPATTERN_KIND__IDIAGONAL
DCAM_IDPROP_TESTPATTERN_OPTION
-
R
W
-
-
LONG
0 to n , step 1 , default 0 @ DCAM_IDPROP_TESTPATTERN_KIND,
DCAMPROP_TESTPATTERN_KIND__FLAT(IFLAT), n = 255
DCAMPROP_TESTPATTERN_KIND__HORZGRADATION(IHORZGRADATION), n = 9
DCAMPROP_TESTPATTERN_KIND__VERTGRADATION(IVERTGRADATION), n = 9
DCAMPROP_TESTPATTERN_KIND__LINE(ILINE), n = 8
Trigger
DCAM_IDPROP_TRIGGERSOURCE
-
R
W
W
W
MODE
DCAMPROP_TRIGGERSOURCE__INTERNAL (default)
DCAMPROP_TRIGGERSOURCE__EXTERNAL
DCAM_IDPROP_TRIGGER_MODE
-
R
-
-
-
MODE
DCAMPROP_TRIGGER_MODE__NORMAL
DCAM_IDPROP_TRIGGERACTIVE
-
R
W
W
W
MODE
DCAMPROP_TRIGGERACTIVE__EDGE (default)
DCAMPROP_TRIGGERACTIVE__SYNCREADOUT
DCAM_IDPROP_TRIGGERPOLARITY
-
R
-
-
-
MODE
DCAMPROP_TRIGGERPOLARITY__NEGATIVE
DCAM_IDPROP_TRIGGERENABLE_ACTIVE
-
R
W
W
W
MODE
DCAMPROP_TRIGGERENABLE_ACTIVE__ALWAYS (default)
DCAMPROP_TRIGGERENABLE_ACTIVE__START
DCAM_IDPROP_TRIGGERENABLE_POLARITY
-
R
-
-
-
MODE
DCAMPROP_TRIGGERENABLE_POLARITY__NEGATIVE
Binning and ROI
DCAM_IDPROP_BINNING
-
R
W
-
-
MODE
DCAMPROP_BINNING__1 (default)
DCAMPROP_BINNING__2
DCAM_IDPROP_SUBARRAYHPOS
-
R
W
-
-
LONG
0 to 4606 , step 2 , default 0
DCAM_IDPROP_SUBARRAYHSIZE
-
R
W
-
-
LONG
2 to 4608 , step 2 , default 4608
DCAM_IDPROP_SUBARRAYVPOS
-
R
W
-
-
LONG
0 to 127 , step 1 , default 0
DCAM_IDPROP_SUBARRAYVSIZE
-
R
W
-
-
LONG
1 to 128 , step 1 , default 128
DCAM_IDPROP_SUBARRAYMODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_BINNING_INDEPENDENT
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_BINNING_HORZ
-
R
W
-
-
LONG
1 to 2 , step 1 , default 1
DCAM_IDPROP_BINNING_VERT
-
R
W
-
-
LONG
1 to 2 , step 1 , default 1
Feature
DCAM_IDPROP_EXPOSURETIME
-
R
W
W
W
REAL (Second)
0.060672 to 2.064512 , step 0.000128 , default 0.060672 @ DCAM_IDPROP_BINNING, DCAMPROP_BINNING__1
0.034432 to 1.03226 , step 0.000102 , default 0.034432 @ DCAM_IDPROP_BINNING, DCAMPROP_BINNING__2
0.064 to 16.32 , step 0.064 , default 0.064 @ DCAM_IDPROP_SENSORMODE, DCAMPROP_SENSORMODE__AREA
ALU
DCAM_IDPROP_CAPTUREMODE
-
R
W
W
-
MODE
DCAMPROP_CAPTUREMODE__NORMAL (default)
DCAMPROP_CAPTUREMODE__DARKCALIB
DCAMPROP_CAPTUREMODE__SHADINGCALIB @ DCAM_IDPROP_SUBTRACT, DCAMPROP_MODE__ON
To use after dark correction
DCAMPROP_CAPTUREMODE__TAPGAINCALIB
DCAM_IDPROP_SUBTRACT
-
R
W
W
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_SUBTRACTIMAGEMEMORY
-
R
W
W
-
MODE
0 to 7 , step 1 , default 0
DCAM_IDPROP_STORESUBTRACTIMAGETOMEMORY
-
R
W
W
-
MODE
0 to 7 , step 1 , default 0
DCAM_IDPROP_SHADINGCORRECTION
-
R
W
W
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_SHADINGCALIBDATAMEMORY
-
R
W
W
-
MODE
0 to 7 , step 1 , default 0
DCAM_IDPROP_SHADINGCALIB_SAMPLES
-
R
W
W
-
LONG
1 to 1024 , step 1 , default 32
DCAM_IDPROP_STORESHADINGCALIBDATATOMEMORY
-
R
W
W
-
MODE
0 to 7 , step 1 , default 0
DCAM_IDPROP_SHADINGCALIB_METHOD
-
R
W
W
-
MODE
DCAMPROP_SHADINGCALIB_METHOD__AVERAGE (default)
DCAMPROP_SHADINGCALIB_METHOD__MAXIMUM
DCAMPROP_SHADINGCALIB_METHOD__USETARGET
DCAM_IDPROP_SHADINGCALIB_TARGET
-
R
W
W
-
LONG
1024 to 4095 , step 1 , default 1024
DCAM_IDPROP_SHADINGCALIB_STABLEMININTENSITY
-
R
W
W
-
LONG
256 to 4095 , step 1 , default 512
DCAM_IDPROP_DARKCALIB_STABLEMAXINTENSITY
-
R
W
W
-
LONG
32 to 4095 , step 1 , default 511
DCAM_IDPROP_SHADINGCALIB_STABLESAMPLES
-
R
W
W
-
LONG
0 to 100 , step 1 , default 10
DCAM_IDPROP_SHADINGCALIB_STABLEMAXERRORPERCENT
-
R
W
W
-
LONG
0 to 200 , step 1 , default 50
DCAM_IDPROP_TAPGAINCALIB_METHOD
-
R
W
-
-
MODE
DCAMPROP_TAPGAINCALIB_METHOD__AVE (default)
DCAMPROP_TAPGAINCALIB_METHOD__MAX
DCAMPROP_TAPGAINCALIB_METHOD__MIN
DCAM_IDPROP_TAPCALIB_BASEDATAMEMORY
-
R
W
-
-
MODE
0 to 63 , step 1 , default 0
DCAM_IDPROP_STORETAPCALIBDATATOMEMORY
-
R
W
-
-
MODE
1 to 3 , step 1 , default 1
DCAM_IDPROP_TAPCALIBDATAMEMORY
-
R
W
-
-
MODE
0 to 3 , step 1 , default 0
DCAM_IDPROP_NUMBEROF_TAPCALIB
-
R
-
-
-
LONG
return 3
DCAM_IDPROP_TAPCALIB_GAIN
-
R
W
-
-
LONG
0 to 63 , step 1 , default 0
Synchronous timing
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)
62.0 to 2109.0 , step 0.001 , default 2109.0 @ DCAM_IDPROP_BINNING, DCAMPROP_BINNING__1
62.0 to 1858.0 , step 0.001 , default 1858.0 @ DCAM_IDPROP_BINNING, DCAMPROP_BINNING__2
DCAM_IDPROP_INTERNALLINESPEED
-
R
W
W
W
REAL (m/s)
0.002967 to 0.101217 , step 0.000017 , default 0.101217 @ DCAM_IDPROP_BINNING, DCAMPROP_BINNING__1
0.005952 to 0.178368 , step 0.000017 , default 0.178368 @ DCAM_IDPROP_BINNING, DCAMPROP_BINNING__2
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
-
-
-
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_IMAGEDETECTOR_PIXELWIDTH
4.0
R
-
-
-
REAL (um)
return 48.0
DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT
4.0
R
-
-
-
REAL (um)
return 48.0
DCAM_IDPROP_TIMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_TIMESTAMP_PRODUCER__DCAMMODULE
DCAM_IDPROP_FRAMESTAMP_PRODUCER
4.0
R
-
-
-
MODE
DCAMPROP_FRAMESTAMP_PRODUCER__DCAMMODULE
DCAM_IDPROP_CAMERASTATUS_INTENSITY
-
R
-
-
-
MODE
DCAMPROP_CAMERASTATUS_INTENSITY__GOOD
DCAMPROP_CAMERASTATUS_INTENSITY__TOODARK
DCAMPROP_CAMERASTATUS_INTENSITY__TOOBRIGHT
DCAMPROP_CAMERASTATUS_INTENSITY__UNCARE
DCAM_IDPROP_CAMERASTATUS_INPUTTRIGGER
-
R
-
-
-
MODE
DCAMPROP_CAMERASTATUS_INPUTTRIGGER__GOOD
DCAMPROP_CAMERASTATUS_INPUTTRIGGER__NONE
DCAMPROP_CAMERASTATUS_INPUTTRIGGER__TOOFREQUENT
DCAM_IDPROP_CAMERASTATUS_CALIBRATION
-
R
-
-
-
MODE
DCAMPROP_CAMERASTATUS_CALIBRATION__DONE
DCAMPROP_CAMERASTATUS_CALIBRATION__NOTYET
DCAMPROP_CAMERASTATUS_CALIBRATION__NOTRIGGER
DCAMPROP_CAMERASTATUS_CALIBRATION__TOOFREQUENTTRIGGER
DCAMPROP_CAMERASTATUS_CALIBRATION__OUTOFADJUSTABLERANGE
DCAMPROP_CAMERASTATUS_CALIBRATION__UNSUITABLETABLE
DCAM_IDPROP_CALIBREGION_MODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_NUMBEROF_CALIBREGION
-
R
W
-
-
LONG
1 to 4 , step 1 , default 1
DCAM_IDPROP_CALIBREGION_HPOS
-
R
W
-
-
LONG
0 to 4606 , step 2 , default 0
DCAM_IDPROP_CALIBREGION_HSIZE
-
R
W
-
-
LONG
0 to 4608 , step 2 , default 0
DCAM_IDPROP_MASKREGION_MODE
-
R
W
-
-
MODE
DCAMPROP_MODE__OFF (default)
DCAMPROP_MODE__ON
DCAM_IDPROP_NUMBEROF_MASKREGION
-
R
W
-
-
LONG
1 to 4 , step 1 , default 1
DCAM_IDPROP_MASKREGION_HPOS
-
R
W
-
-
LONG
0 to 4606 , step 2 , default 0
DCAM_IDPROP_MASKREGION_HSIZE
-
R
W
-
-
LONG
0 to 4608 , step 2 , default 0

Go to top of this chapter