DCAM_IDPROP_BINNING
Genre Read write mode Type of value Explanation
|
This property allows you to specify the camera's binning mode. The camera may support one or more the following values: |
DCAMPROP_BINNING__1 |
"1x1" |
The binning is 1x1. |
DCAMPROP_BINNING__2 |
"2x2 |
The binning is 2x2. |
DCAMPROP_BINNING__4 |
"4x4" |
The binning is 4x4. |
DCAMPROP_BINNING__8 |
"8x8" |
The binning is 8x8. |
DCAMPROP_BINNING__16 |
"16x16" |
The binning is 16x16. |
DCAMPROP_BINNING__1_2 |
"1x2" |
The binning is 1x2. |
DCAMPROP_BINNING__2_4 |
"2x4" |
The binning is 2x4. |
|
If the DCAM_IDPROP_BINNING_INDEPENDENT property is set to "ON", the value is ignored and the DCAM_IDPROP_BINNING_HORZ and DCAMIDPROP_BINNING_VERT properties are used for the binning settings. |
Reference
DCAM_IDPROP_BINNING_HORZ
Genre Read write mode Type of value Explanation
|
This property allows you to set the horizontal binning. This property is only effective if DCAM_IDPROP_BINNING_INDEPENDENT is available and set to "ON". |
Reference
DCAM_IDPROP_BINNING_INDEPENDENT
DCAM_IDPROP_BINNING_INDEPENDENT
Genre Read write mode Type of value Explanation
|
This property allows you to select binning mode to common or independent. |
DCAMPROP_MODE__OFF |
"OFF" |
The independent binning mode is off. Both values of horizontal and vertical binning are the same and they are specified by DCAM_IDPROP_BINNING. |
DCAMPROP_MODE__ON |
"ON" |
The independent binning mode is on. The values of horizontal and vertical binning are independent and they are specified by DCAM_IDPROP_BINNING_HORZ and DCAM_IDPROP_BINNING_VERT. |
Reference
DCAM_IDPROP_BINNING_VERT
Genre Read write mode Type of value Explanation
|
This property allows you to set the vertical binning. This property is only effective if DCAM_IDPROP_BINNING_INDEPENDENT is available and set to "ON". |
Reference
DCAM_IDPROP_BITSPERCHANNEL
DCAM_IDPROP_BITSPERCHANNEL
Genre Read write mode Type of value Explanation
|
This property allows you to specify the channel bit depth. The device may support one or more the following. |
DCAMPROP_BITSPERCHANNEL__8 |
8 |
The channel data depth is 8 bits. |
DCAMPROP_BITSPERCHANNEL__10 |
10 |
The channel data depth is 10 bits. |
DCAMPROP_BITSPERCHANNEL__12 |
12 |
The channel data depth is 12 bits. |
DCAMPROP_BITSPERCHANNEL__14 |
14 |
The channel data depth is 14 bits. |
DCAMPROP_BITSPERCHANNEL__16 |
16 |
The channel data depth is 16 bits. |
|
This value determines the number of bits per channel, not per pixel. The DCAM_IDPROP_IMAGE_PIXELTYPE property can be used to get the bits per pixel. |
Reference
DCAM_IDPROP_BUFFER_FRAMEBYTES
DCAM_IDPROP_BUFFER_FRAMEBYTES (4.0-)
Genre Read write mode Type of value Explanation
|
This property tells the byte size of a frame buffer that should be allocated when you use dcambuf_attach() function. |
Reference
DCAM_IDPROP_BUFFER_PIXELTYPE
DCAM_IDPROP_BUFFER_PIXELTYPE (4.0-)
Genre Read write mode Type of value Explanation
|
This property tells the pixel data type of user attached buffer. This property does not have meaning before calling dcambuf_attach() function because the pixel data format is fixed in dcambuf_attach() function. |
DCAM_PIXELTYPE_MONO8 |
“MONO8” |
Pixel format is B/W and occupied in a byte. |
DCAM_PIXELTYPE_MONO16 |
“MONO16” |
Pixel format is B/W and occupied in 2 bytes. |
DCAM_PIXELTYPE_MONO12 |
“MONO12” |
Pixel format is BW, 2 pixels are packed, so this occupied in 3 bytes by 2pixels. |
DCAM_PIXELTYPE_RGB24 |
“RGB24” |
Pixel format is RGB and occupied in 3 bytes. |
DCAM_PIXELTYPE_RGB48 |
“RGB48” |
Pixel format is RGB and occupied in 6 bytes. |
DCAM_PIXELTYPE_BGR24 |
“BGR24” |
Pixel format is BGR and occupied in 3 bytes. |
DCAM_PIXELTYPE_BGR48 |
“BGR48” |
Pixel format is BGR and occupied in 6 bytes. |
Reference
DCAM_IDPROP_BUFFER_ROWBYTES
DCAM_IDPROP_BUFFER_ROWBYTES (4.0-)
Genre Read write mode Type of value Explanation
|
This property tells the row byte size of user attached buffer. This property does not have meaning before calling dcambuf_attach() function because the row byte size is fixed in dcambuf_attach() function. |
Reference
DCAM_IDPROP_BUFFER_TOPOFFSETBYTES
DCAM_IDPROP_BUFFER_TOPOFFSETBYTES (4.0-)
Genre Read write mode Type of value Explanation
|
AS using dcambuf_attach() function, there may be “unnecessary data” in front of the actual image data. It is possible know how many bytes is not necessary with this property. |
Reference
DCAM_IDPROP_BURIEDDATA_MODE
DCAM_IDPROP_BURIEDDATA_MODE
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set whether to buried data in the image. |
DCAMPROP_MODE__OFF |
"OFF" |
The data is not buried into a part of image. |
DCAMPROP_MODE__ON |
"ON" |
The data is buried into a part of the image and output. |
Reference
DCAM_IDPROP_CALIBREGION_HPOS
DCAM_IDPROP_CALIBREGION_HPOS
Genre Read write mode Type of value Explanation
|
This property allows you to set a horizontal start address for the regions that will be calibrated. This is an ARRAY. |
Reference
DCAM_IDPROP_CALIBREGION_HSIZE
DCAM_IDPROP_CALIBREGION_HSIZE
Genre Read write mode Type of value Explanation
|
This property allows you to set a horizontal size for the regions that will be calibrated. This is an ARRAY. |
Reference
DCAM_IDPROP_CALIBREGION_MODE
DCAM_IDPROP_CALIBREGION_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to determine which regions you want to calibrate. This property can have one of following values: |
DCAMPROP_MODE__OFF |
“OFF” |
The region is not used for calibration. |
DCAMPROP_MODE__ON |
“ON” |
The region is used for calibration. |
Reference
DCAM_IDPROP_CAMERASTATUS_CALIBRATION
DCAM_IDPROP_CAMERASTATUS_CALIBRATION
Genre Read write mode Type of value Explanation
|
This property shows you current camera status about calibration. This property is only effective during calibration. |
DCAMPROP_CAMERASTATUS_CALIBRATION__DONE |
"DONE" |
Calibration is done. |
DCAMPROP_CAMERASTATUS_CALIBRATION__NOTYET |
"NOT YET" |
Calibration is not completed yet. |
DCAMPROP_CAMERASTATUS_CALIBRATION__NOTRIGGER |
"NO TRIGGER" |
No trigger comes. Please check trigger source and cable connection. |
DCAMPROP_CAMERASTATUS_CALIBRATION__TOOFREQUENTTRIGGER |
"TOO FREQUENT TRIGGER" |
Trigger comes too much. Camera cannot run with current frequent trigger. |
DCAMPROP_CAMERASTATUS_CALIBRATION__OUTOFADJUSTABLERANGE |
"OUT OF ADJUSTABLE RANGE" |
The intensity is output of range for adjustment. Please control light source or speed. |
DCAMPROP_CAMERASTATUS_CALIBRATION__UNSUITABLETABLE |
"UNSUITABLE TABLE" |
Calibration table is unstable. |
Reference
DCAM_IDPROP_CAMERASTATUS_INTENSITY
DCAM_IDPROP_CAMERASTATUS_INTENSITY
Genre Read write mode Type of value Explanation
|
This property shows you current camera status about intensity during calibration. |
DCAMPROP_CAMERASTATUS_INTENSITY__GOOD |
"GOOD" |
Intensity is good. |
DCAMPROP_CAMERASTATUS_INTENSITY__TOODARK |
"TOO DARK" |
Intensity is too dark. |
DCAMPROP_CAMERASTATUS_INTENSITY__TOOBRIGHT |
"TOO BRIGHT" |
Intensity is too bright. |
DCAMPROP_CAMERASTATUS_INTENSITY__UNCARE |
"UNCARE" |
Calibration is not done. |
Reference
DCAM_IDPROP_CCDMODE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the output port of the sensor. This value can be one of the following values: |
DCAMPROP_CCDMODE__NORMALCCD |
" NORMAL CCD" |
Output the image data through the normal readout port. |
DCAMPROP_CCDMODE__EMCCD |
"EM CCD" |
Output the image data through the EM readout port. |
|
If this property is absent, the device only has one readout port. If this property has been set to EM CCD, the value of DCAM_IDPROP_SENSITIVITY will affect the output image. |
Reference
DCAM_IDPROP_CAPTUREMODE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the capture mode of the camera. The following values are defined: |
DCAMPROP_CAPTUREMODE__NORMAL |
“NORMAL” |
The camera will output normal image data. |
DCAMPROP_CAPTUREMODE__DARKCALIB |
“DARK CALIBRATION” |
The camera will output data for dark calibration. |
DCAMPROP_CAPTUREMODE__SHADINGCALIB |
“SHADING CALIBRATION” |
The camera will output data for shading calibration. |
DCAMPROP_CAPTUREMODE__TAPGAINCALIB |
“TAP GAIN CALIBRATION” |
The camera will calibrate gain parameter of each tap. |
DCAMPROP_CAPTUREMODE__BACKFOCUSCALIB |
“BACK FOCUS CALIBRATION” |
The camera will calibrate back focus position. |
|
Changing this value is necessary when using background subtraction, shading correction, tap gain calibration or back focus calibration. It is important to capture in the proper capture mode prior to using certain correction methods. You can wait DCAM_EVENT_CAPTUREEND to detect calibration is finished. If the camera supports tap gain calibration, it is best to use this first. X-ray line and TDI cameras support this. If the camera supports back focus calibration, it is best to use this first. ORCA-D2 supports this. Use dark calibration before storing a new background image. Use shading calibration before storing a new shading image. |
Reference
DCAM_IDPROP_COLORTYPE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the color type of image data. Usually this value is fixed on the system but some camera may support several values. |
DCAMPROP_COLORTYPE__BW |
"BW" |
Color type of data comes from camera is black and white. |
DCAMPROP_COLORTYPE__RGB |
"RGB" |
Color type of data comes from camera is RGB. Color order is R, G then B. |
DCAMPROP_COLORTYPE__BGR |
"BGR" |
Color type of data comes from camera is RGB. Color order is B, G then R. |
Reference
DCAM_IDPROP_CONTRASTGAIN
Genre Read write mode Type of value Explanation
|
This property allows you to specify the contrast gain number. Most cameras which support this feature support as LONG, but if it supports DCAM_IDPROP_DIRECTGAIN, this may be REAL. |
Reference
DCAM_IDPROP_CONTRASTOFFSET
DCAM_IDPROP_CONTRASTOFFSET
Genre Read write mode Type of value Explanation
|
This property allows you to specify the contrast offset value. |
Reference
DCAM_IDPROP_CONVERSIONFACTOR_COEFF
DCAM_IDPROP_CONVERSIONFACTOR_COEFF
Genre Read write mode Type of value Explanation
|
This property returns coefficient value of current conversion factor. |
Reference
DCAM_IDPROP_CONVERSIONFACTOR_OFFSET
DCAM_IDPROP_CONVERSIONFACTOR_OFFSET
Genre Read write mode Type of value Explanation
|
This property returns offset value of current conversion factor. |
Reference
DCAM_IDPROP_DARKCALIB_SAMPLES
DCAM_IDPROP_DARKCALIB_SAMPLES
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the total number of samples for averaging during dark calibration. If the SENSOR type is AREA, sample unit is one frame, if the SENSOR type is LINE/TDI, sample unit is one line. |
Reference
DCAM_IDPROP_DARKCALIB_STABLEMAXINTENSITY
DCAM_IDPROP_DARKCALIB_STABLEMAXINTENSITY
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the maximum acceptable intensity value for dark calibration. If there is a value that exceeds this set value, the dark calibration process will discard the data. |
Reference
DCAM_IDPROP_DARKCALIB_STABLESAMPLES
DCAM_IDPROP_DARKCALIB_STABLESAMPLES
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
No. of times data is confirmed. This property allows you to set the minimum number of stable samples. Stable samples are data that pass all of conditions which are set by other properties, such as the following: DCAM_IDPROP_DARKCALIB_STABLEMAXINTENSITY. If this value is maximum, camera will calibrate with any incoming data.
|
Reference
DCAM_IDPROP_DEFECTCORRECT_HPOS
DCAM_IDPROP_DEFECTCORRECT_HPOS
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the horizontal pixel position which you want to correct the data forcefully. The correct method is specified by DCAM_IDPROP_DEFECTCORRECT_METHOD. This property is an ARRAY. You can make some number of these properties enable by DCAM_IDPROP_NUMBEROF_DEFECTCORRECT.
|
Reference
DCAM_IDPROP_DEFECTCORRECT_METHOD
DCAM_IDPROP_DEFECTCORRECT_METHOD
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the method how to correct the data which is specified by DCAM_IDPROP_DEFECTCORRECT_HPOS. You can choose following methods. |
DEFECTCORRECT_METHOD__CEILING |
"CEILING" |
Output data becomes brightest value. |
DEFECTCORRECT_METHOD__PREVIOUS |
"PREVIOUS " |
Output data is same as previous pixel. |
|
This property is an ARRAY. You can enable some of these properties with DCAM_IDPROP_NUMBEROF_DEFECTCORRECT. |
Reference
DCAM_IDPROP_DEFECTCORRECT_MODE
DCAM_IDPROP_DEFECTCORRECT_MODE
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to enable defect correction. You can choose following values. |
DCAMPROP_MODE__OFF |
"OFF" |
DEFECTCORRECT is disabled. |
DCAMPROP_MODE__ON |
"ON" |
DEFECTCORRECT is enabled. |
|
You can enable several of these properties with DCAM_IDPROP_NUMBEROF_DEFECTCORRECT. |
Reference
DCAM_IDPROP_DEVICEBUFFER_FRAMECOUNTMAX
DCAM_IDPROP_DEVICEBUFFER_FRAMECOUNTMAX
Genre Read write mode Type of value Explanation
|
This property tells the maximum frame count the device can keep in device memory. |
Reference
DCAM_IDPROP_DEVICEBUFFER_MODE
DCAM_IDPROP_DEVICEBUFFER_MODE
Genre Read write mode Type of value Explanation
|
This property specify Device Buffer control. Some cameras have device memory and have a function that automatically retransmits lost frames at the end of capturing with Snap shot. This property can have one of following values: |
DCAMPROP_DEVICEBUFFER_MODE__THRU |
"THRU" |
Device doesn't keep the image in device memory. |
DCAMPROP_DEVICEBUFFER_MODE__SNAPSHOT |
"SNAPSHOT" |
Device keeps the specified number of images in device memory, and automatically retransmits lost frames at the end of capturing with Snap shot. However, if the Snap shot is stopped before the specified number of frames have been captured, the frames that were lost will not be retransmitted. |
DCAMPROP_DEVICEBUFFER_MODE__SNAPSHOTEX |
"SNAPSHOTEX" |
Device keeps the specified number of images in device memory, and automatically retransmits lost frames at the end of capturing with Snap shot. Even if the Snap shot is stopped before the specified number of frames have been captured, any frames that were lost will be retransmitted. |
Reference
DCAM_IDPROP_DIGITALBINNING_HORZ
DCAM_IDPROP_DIGITALBINNING_HORZ
Genre Read write mode Type of value Explanation
|
This property allows you to specify the digital binning mode of the camera. The following values are defined: |
|
1 |
Output data is not compressed. |
|
2 |
Output data is compressed from 2 horizontal pixels to 1. |
|
The compression method is selected by DCAM_IDPROP_DIGITALBINNING_METHOD. |
Reference
DCAM_IDPROP_DIGITALBINNING_METHOD
DCAM_IDPROP_DIGITALBINNING_METHOD
Genre Read write mode Type of value Explanation
|
This property allows you to choose the method of digital binning. Following values are defined: |
DCAMPROP_DIGITALBINNING_METHOD__MINIMUM |
"MINIMUM" |
The output data is lower one. |
DCAMPROP_DIGITALBINNING_METHOD__MAXIMUM |
"MAXIMUM" |
The output data is higher one. |
DCAMPROP_DIGITALBINNING_METHOD__ODD |
"ODD" |
The output data is the data of pixel at odd horizontal address. |
DCAMPROP_DIGITALBINNING_METHOD__EVEN |
"EVEN" |
The output data is the data of pixel at even horizontal address. |
DCAMPROP_DIGITALBINNING_METHOD__SUM |
"SUM" |
The output data is sum of two data. |
DCAMPROP_DIGITALBINNING_METHOD__AVERAGE |
"AVERAGE" |
The output data is average of two data. |
|
This property will be effective if the value of DCAM_IDPROP_DIGITALBINNING_HPOS is larger than 1. |
Reference
DCAM_IDPROP_DIRECTEMGAIN_MODE
DCAM_IDPROP_DIRECTEMGAIN_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to set the values of DCAM_IDPROP_SENSITIVITY as absolute values instead of relative values. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
DCAM_IDPROP_SENSITIVITY is relative value. |
DCAMPROP_MODE__ON |
"ON" |
DCAM_IDPROP_SENSITIVITY is absolute value. |
|
If this property is set to “ON”, the values provided by DCAM_IDPROP_SENSITIVITY will represent the actual EM gain magnification. For example, if the current EM gain magnification is 4x and user wants to 10 times that value, then user can set DCAM_IDPROP_SENSITIVITY to 40 to achieve 40x gain. The minimum and maximum limits of DCAM_IDPROP_SENSITIVITY will also change to the absolute values. |
Reference
DCAM_IDPROP_DIRECTGAIN_MODE
DCAM_IDPROP_DIRECTGAIN_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to set the values of DCAM_IDPROP_CONTRASTGAIN as absolute values instead of relative values. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
DCAM_IDPROP_CONTRASTGAIN is relative value. |
DCAMPROP_MODE__ON |
"ON" |
DCAM_IDPROP_CONTRASTGAIN is absolute value. |
Reference
DCAM_IDPROP_EMCCD_CALIBRATIONMODE
DCAM_IDPROP_EMCCD_CALIBRATIONMODE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the special readout mode for EM-CCD sensor. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
The EM Calibration mode is OFF. |
DCAMPROP_MODE__ON |
"ON" |
The EM Calibration mode is ON. |
|
If this property is set to “ON”, the EM output is not amplified. This is prepared for calibration of EM gain. This means DCAM_IDPROP_SENSITIVITY is not effective. This property is only effective when DCAM_IDPROP_CCDMODE is set to DCAMPROP_CCDMODE__EMCCD if exists. |
Reference
DCAM_IDPROP_EMGAINPROTECT_AFTERFRAMES
DCAM_IDPROP_EMGAINPROTECT_AFTERFRAMES
Genre Read write mode Type of value Explanation
|
This property allows you to specify the number of frames which EM Gain protection will continue to work after EM warning status becomes WARNING. This property is only effective when DCAM_IDPROP_EMGAINPROTECT_MODE is set to ON and DCAM_IDPROP_CCDMODE is DCAMPROP_CCDMODE__EMCCD.
|
Reference
DCAM_IDPROP_EMGAINPROTECT_MODE
DCAM_IDPROP_EMGAINPROTECT_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to turn EM Gain protection on and/or off. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
The EM Gain protection is disabled. |
DCAMPROP_MODE__ON |
"ON" |
The EM Gain protection is enabled. |
|
If this property is set to “ON”, the intensity of output will be 0 when EM Gain protection is working. To recover from this, you have to stop capturing by dcamcap_stop(). |
Reference
DCAM_IDPROP_EMGAINWARNING_ALARM
DCAM_IDPROP_EMGAINWARNING_ALARM
Genre Read write mode Type of value Explanation
|
This property allows you to specify ON and OFF of EM Gain warning alarm. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
The EM Gain warning alarm is OFF. |
DCAMPROP_MODE__ON |
"ON" |
The EM Gain warning alarm is ON. |
|
If this property is set to "ON" and input data overs warning level, the alarm works. The warning level is changed by DCAM_IDPROP_EMGAINWARNING_LEVEL. |
|
This property is only effective when DCAM_IDPROP_EMGAINPROTECT_MODE is set to ON and DCAMPROP_CCDMODE__EMCCD is selected. |
Reference
DCAM_IDPROP_EMGAINWARNING_LEVEL
DCAM_IDPROP_EMGAINWARNING_LEVEL
Genre Read write mode Type of value Explanation
|
This property allows you to specify the level of EM Gain Warning for EM-CCD sensor. If this property value is bigger, less strength of incoming light can warn it. |
|
This property is effective when DCAM_IDPROP_CCDMODE is set to DCAMPROP_CCDMODE__EMCCD if exists. |
Reference
DCAM_IDPROP_EMGAINWARNING_STATUS
DCAM_IDPROP_EMGAINWARNING_STATUS
Genre Read write mode Type of value Explanation
|
This property allows you to get current EM-Gain warning status. Some EM-CCD camera checks strength of incoming light and if it is too strong, it warns by this property value: |
DCAMPRP_EMGAINWARNING_STATUS__NORMAL |
"NORMAL" |
Input light level is enough low. |
DCAMPRP_EMGAINWARNING_STATUS__WARNING |
"WARNING" |
Input light level is too strong but it does not happen contiguously yet. |
DCAMPRP_EMGAINWARNING_STATUS__PROTECTED |
"PROTECTED" |
Input light level was too strong so now EM Gain is protected. |
|
This property is only effective when DCAM_IDRPOP_CCDMODE is set to DCAMPROP_CCDMODE__EMCCD if exists. |
Reference
DCAM_IDPROP_EXPOSURETIME
Genre Read write mode Type of value Explanation
|
This property allows you to specify the exposure time in seconds. |
|
This value may have various steps depending on the camera. For example, C13440-22C CMOS camera has 10us step through the whole range. |
|
This application can use dcamprop_queryvalue() with DCAM_OPTION_NEXT to get accurate value. |
|
Some RGB cameras support this property with cannel. |
Reference
DCAM_IDPROP_EXPOSURETIME_CONTROL
DCAM_IDPROP_EXPOSURETIME_CONTROL
Genre Read write mode Type of value Explanation
|
This property changes control method of exposure time: |
DCAMPROP_MODE__OFF |
"OFF" |
Exposure time becomes the longest period with current frame rate. |
DCAMPROP_MODE__ON |
"ON" |
Exposure time can be controlled by DCAM_IDPROP_EXPOSURE. |
Reference
DCAM_IDPROP_FRAMEAVERAGINGFRAMES
DCAM_IDPROP_FRAMEAVERAGINGFRAMES
Genre Read write mode Type of value Explanation
|
This property is used to set the number of frames to use for the frame averaging function. This property is only effective when DCAM_IDPROP_FRAMEAVERAGINGMODE is set to DCAMPROP_MODE__ON. |
Reference
DCAM_IDPROP_FRAMEAVERAGINGMODE
DCAM_IDPROP_FRAMEAVERAGINGMODE
Genre Read write mode Type of value Explanation
|
This property is used to enable frame averaging mode. |
DCAMPROP_MODE__OFF |
"OFF" |
The FRAME AVERAGING is turned off. |
DCAMPROP_MODE__ON |
"ON" |
The FRAME AVERAGING is turned on. |
|
The number of frame is set by DCAM_IDPROP_FRAMEAVERAGINGFRAMES. |
Reference
DCAM_IDPROP_FRAMEBUNDLE_FRAMESTEPBYTES
DCAM_IDPROP_FRAMEBUNDLE_FRAMESTEPBYTES
Genre Read write mode Type of value Explanation
|
This property returns the offset bytes to skip next frame in bundled frames. |
Reference
DCAM_IDPROP_FRAMEBUNDLE_MODE
DCAM_IDPROP_FRAMEBUNDLE_MODE
Genre Read write mode Type of value Explanation
|
This property is used to enable frame bundle mode. |
DCAMPROP_MODE__OFF |
"OFF" |
The frames are not bundled. |
DCAMPROP_MODE__ON |
"ON" |
The frames are bundled. |
Reference
DCAM_IDPROP_FRAMEBUNDLE_NUMBER
DCAM_IDPROP_FRAMEBUNDLE_NUMBER
Genre Read write mode Type of value Explanation
|
This property allows you to specify how many frames to be bundled. |
Reference
DCAM_IDPROP_FRAMEBUNDLE_ROWBYTES
DCAM_IDPROP_FRAMEBUNDLE_ROWBYTES
Genre Read write mode Type of value Explanation
|
This property returns the rowbytes in a frame. |
Reference
DCAM_IDPROP_FRAMESTAMP_PRODUCER
DCAM_IDPROP_FRAMESTAMP_PRODUCER (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns the source that FRAMESTAMP is produced from. This property can have one of following values: |
DCAMPROP_FRAMESTAMP_PRODUCER__NONE |
"NONE" |
FRAMESTAMP is not supported in the camera or under the current condition. |
DCAMPROP_FRAMESTAMP_PRODUCER__DCAMMODULE |
"DCAMMODULE" |
FRAMESTAMP is produced from DCAM module. |
DCAMPROP_FRAMESTAMP_PRODUCER__KERNELDRIVER |
"KERNELDRIVER" |
FRAMESTAMP is produced from kernel driver. |
DCAMPROP_FRAMESTAMP_PRODUCER__CAPTUREDEVICE |
"CAPTUREDEVICE" |
FRAMESTAMP is produced from Frame Grabber. |
DCAMPROP_FRAMESTAMP_PRODUCER__IMAGINGDEVICE |
"IMAGINGDEVICE" |
FRAMESTAMP is produced from Camera. |
Reference
DCAM_IDPROP_FIRSTTRIGGER_BEHAVIOR
DCAM_IDPROP_FIRSTTRIGGER_BEHAVIOR
Genre Read write mode Type of value Explanation
|
This property is used to get or set behavior of first coming trigger after dcamcap_start(). |
DCAMPROP_FIRSTTRIGGER_BEHAVIOR__STARTEXPOSURE |
"START EXPOSURE" |
Camera starts exposure by first trigger. The first frame starts exposure after receiving the first trigger. |
DCAMPROP_FIRSTTRIGGER_BEHAVIOR__STARTREADOUT |
"START READOUT" |
Camera reads out an image by first trigger. The first image includes expose between dcamcap_start() and the first trigger. |
|
If camera supports this property, it becomes EFFECTIVE in START or SYNCREADOUT trigger. In other trigger mode, this is not EFFECTIVE. |
Reference
DCAM_IDPROP_HIGHDYNAMICRANGE_MODE
DCAM_IDPROP_HIGHDYNAMICRANGE_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to enable or disable high dynamic range mode. When enabled, DCAM_IDPROP_CONTRASTGAIN setting will be ignored. |
DCAMPROP_MODE__OFF |
"OFF" |
The high dynamic range mode is OFF. |
DCAMPROP_MODE__ON |
"ON" |
The high dynamic range mode is ON. |
Reference
DCAM_IDPROP_HOTPIXELCORRECT_LEVEL
DCAM_IDPROP_HOTPIXELCORRECT_LEVEL
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to choose level of defect correction. This property is only effective if DCAM_IDPROP_DEFECTCORRECT_MODE is available and set to "ON". |
DCAMPROP_HOTPIXELCORRECT_LEVEL__STANDARD |
"STANDARD" |
Defect correction level is standard. |
DCAMPROP_HOTPIXELCORRECT_LEVEL__MINIMUM |
"MINIMUM" |
Defect correction level is minimum. The number of pixel judged as hot pixel is small. |
DCAMPROP_HOTPIXELCORRECT_LEVEL__AGGRESSIVE |
"AGGRESSIVE" |
Defect correction level is aggressive. The number of pixel judged as hot pixel is large. |
Reference
DCAM_IDPROP_IMAGEBLOCK_ACTUALXPOS
DCAM_IDPROP_IMAGEBLOCK_ACTUALXPOS
Genre Read write mode Type of value Explanation
|
For a camera with staggered sensors, this property returns the left edge position of sensor in real space in pixels. The value of leftmost sensor is set to 0 and used as the reference. This property is an ARRAY property to get information about each sensor. |
Reference
DCAM_IDPROP_IMAGEBLOCK_ACTUALXSIZE
DCAM_IDPROP_IMAGEBLOCK_ACTUALXSIZE
Genre Read write mode Type of value Explanation
|
For a camera with staggered sensors, this property returns the number of horizontal pixels of sensor. This property is an ARRAY property to get information about each sensor. |
Reference
DCAM_IDPROP_IMAGEBLOCK_ACTUALYPOS
DCAM_IDPROP_IMAGEBLOCK_ACTUALYPOS
Genre Read write mode Type of value Explanation
|
For a camera with staggered sensors, this property returns the position of the first line of sensor in real space in pixels. The value of topmost sensor is set to 0 and used as the reference. This property is an ARRAY property to get information about each sensor. |
Reference
DCAM_IDPROP_IMAGEBLOCK_ACTUALYSIZE
DCAM_IDPROP_IMAGEBLOCK_ACTUALYSIZE
Genre Read write mode Type of value Explanation
|
For a camera with staggered sensors, this property returns the number of vertical pixels of sensor. This property is an ARRAY property to get information about each sensor. |
Reference
DCAM_IDPROP_IMAGEBLOCK_FIRSTBYTESOFFSET
DCAM_IDPROP_IMAGEBLOCK_FIRSTBYTESOFFSET
Genre Read write mode Type of value Explanation
|
For a camera with staggered sensors, this property returns the left edge position of sensor in bytes for output data. This property is an ARRAY property to get information about each sensor. |
Reference
DCAM_IDPROP_IMAGEBLOCK_OVERLAPLEFTSIZE
DCAM_IDPROP_IMAGEBLOCK_OVERLAPLEFTSIZE
Genre Read write mode Type of value Explanation
|
For a camera with staggered sensors, this property returns number of pixels that the left edge of the sensor overlaps with the previous sensor. This property is an ARRAY property to get information about each sensor. |
Reference
DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT
DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns physical vertical size of one pixel on image detector. |
Reference
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMHORZ
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMHORZ (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns number of horizontal pixels on image detector. |
Reference
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMVERT
DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMVERT (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns number of vertical pixels on image detector. |
Reference
DCAM_IDPROP_IMAGEDETECTOR_PIXELWIDTH
DCAM_IDPROP_IMAGEDETECTOR_PIXELWIDTH (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns physical horizontal size of one pixel on image detector. |
Reference
DCAM_IDPROP_IMAGE_CAMERASTAMP
DCAM_IDPROP_IMAGE_CAMERASTAMP (4.0-)
Genre Read write mode Type of value Explanation
|
This property can change the value of CAMERASTAMP in image frame data. The CAMERASTAMP value can be got through DCAMBUF_FRAME structure by "camerastamp member". |
Reference
DCAM_IDPROP_IMAGE_FRAMEBYTES
DCAM_IDPROP_IMAGE_FRAMEBYTES
Genre Read write mode Type of value Explanation
|
This property returns byte size of one image for storing. |
Reference
DCAM_IDPROP_IMAGE_HEIGHT
Genre Read write mode Type of value Explanation
|
This property returns vertical pixel number of the image based on current property setting. |
Reference
DCAM_IDPROP_IMAGE_PIXELTYPE
DCAM_IDPROP_IMAGE_PIXELTYPE
Genre Read write mode Type of value Explanation
|
This property allows you to choose pixel data format. The values are defined as DCAM_PIXELTYPE. |
DCAM_PIXELTYPE_MONO8 |
"MONO8" |
Pixel format is B/W and occupied in a byte. |
DCAM_PIXELTYPE_MONO16 |
"MONO16" |
Pixel format is B/W and occupied in 2 bytes. |
DCAM_PIXELTYPE_RGB24 |
"RGB24" |
Pixel format is RGB and occupied in 3 bytes. |
DCAM_PIXELTYPE_RGB48 |
"RGB48" |
Pixel format is RGB and occupied in 6 bytes. |
DCAM_PIXELTYPE_BGR24 |
"BGR24" |
Pixel format is BGR and occupied in 3 bytes. |
DCAM_PIXELTYPE_BGR48 |
"BGR48" |
Pixel format is BGR and occupied in 6 bytes. |
Reference
DCAM_IDPROP_IMAGE_ROWBYTES
DCAM_IDPROP_IMAGE_ROWBYTES
Genre Read write mode Type of value Explanation
|
This property returns byte size of one horizontal line for accessing next row pixel. |
Reference
DCAM_IDPROP_IMAGE_TOPOFFSETBYTES
DCAM_IDPROP_IMAGE_TOPOFFSETBYTES
Genre Read write mode Type of value Explanation
|
This property returns the offset bytes to point first data image. Usually this is 0. |
Reference
DCAM_IDPROP_IMAGE_WIDTH
Genre Read write mode Type of value Explanation
|
This property returns horizontal pixel number of the image based on current property setting. |
Reference
DCAM_IDPROP_INTENSITYLUT_BLACKCLIP
DCAM_IDPROP_INTENSITYLUT_BLACKCLIP
Genre Read write mode Type of value Explanation
|
This property can specify the lowest level at DCAMPROP_INTENSITYLUT_MODE__CLIP as DCAM_IDPROP_INTENSITYLUT_MODE. If the intensity is lower than this value, then it is raised to this specified value. |
Reference
DCAM_IDPROP_INTENSITYLUT_MODE
DCAM_IDPROP_INTENSITYLUT_MODE
Genre Read write mode Type of value Explanation
|
This property specify INTENSITY LUT condition. |
DCAMPROP_INTENSITYLUT_MODE__THROUGH |
"THROUGH" |
LUT does not work. |
DCAMPROP_INTENSITYLUT_MODE__PAGE |
"PAGE" |
LUT works with the table specified by DCAM_IDPROP_INTENSITYLUT_PAGE. |
DCAMPROP_INTENSITYLUT_MODE__CLIP |
"CLIP" |
Intensity is clipped by DCAM_IDPROP_INTENSITYLUT_BLACKCLIP and WHITECLIP. |
Reference
DCAM_IDPROP_INTENSITYLUT_PAGE
DCAM_IDPROP_INTENSITYLUT_PAGE
Genre Read write mode Type of value Explanation
|
This property allows you to select a page of LUT. This property is only effective if DCAM_IDPROP_INTENSITYLUT_MODE is available and set to "ON". |
Reference
DCAM_IDPROP_INTENSITYLUT_WHITECLIP
DCAM_IDPROP_INTENSITYLUT_WHITECLIP
Genre Read write mode Type of value Explanation
|
This property can specify the highest level at DCAMPROP_INTENSITYLUT_MODE__CLIP as DCAM_IDPROP_INTENSITYLUT_MODE. If the intensity is higher than this value, then it is suppressed to this value. |
Reference
DCAM_IDPROP_INTERFRAMEALU_ENABLE
DCAM_IDPROP_INTERFRAMEALU_ENABLE
Genre Read write mode Type of value Explanation
|
This property allows you to enable or disable inter frame ALU function. This property can have one of following values: |
DCAMPROP_INTERFRAMEALU_ENABLE__OFF |
"OFF" |
The inter frame ALU is disable in any trigger source. |
DCAMPROP_INTERFRAMEALU_ENABLE__TRIGGERSOURCE_ALL |
"TRIGGER SOURCE ALL" |
The inter frame ALU is enable in any trigger source. |
DCAMPROP_INTERFRAMEALU_ENABLE__TRIGGERSOURCE_INTERNAL |
"TRIGGER SOURCE INTERNAL ONLY" |
The inter frame ALU is enable in only trigger source internal. |
Reference
DCAM_IDPROP_INTERNAL_FRAMEINTERVAL
DCAM_IDPROP_INTERNAL_FRAMEINTERVAL
Genre Read write mode Type of value Explanation
|
This property returns the period between the start of two frames. Some devices can set this property. |
Reference
DCAM_IDPROP_INTERNALFRAMERATE
DCAM_IDPROP_INTERNALFRAMERATE
Genre Read write mode Type of value Explanation
|
This property returns the number of frames per second that the camera outputs. Some devices can set this property. |
Reference
DCAM_IDPROP_INTERNALLINERATE
DCAM_IDPROP_INTERNALLINERATE
Genre Read write mode Type of value Explanation
|
This property returns the number of lines per second that are shifted on the sensor. Some devices can set this property. |
Reference
DCAM_IDPROP_INTERNAL_LINEINTERVAL
DCAM_IDPROP_INTERNAL_LINEINTERVAL
Genre Read write mode Type of value Explanation
|
This property returns the period between two lines' timings. At DCAMPROP_SENSORMODE__TDI or DCAMPROP_SENSORMODE__TDI_EXTENDED, this means the period between vertical shifting. At DCAMPROP_SENSORMODE__PROGRESSIVE, this means the period between two lines reading. Some devices can set this property. |
Reference
DCAM_IDPROP_INTERNALLINESPEED
DCAM_IDPROP_INTERNALLINESPEED
Genre Read write mode Type of value Explanation
|
This property returns the speed on the sensor. At DCAMPROP_SENSORMODE__TDI or DCAMPROP_SENSORMODE__TDI_EXTENDED, this means vertical shifting speed. At DCAMPROP_SENSORMODE__PROGRESSIVE, this means vertical speed of reading sensor. Some devices can set this property. |
Reference
DCAM_IDPROP_INTERNALLINERATE_CONTROL
DCAM_IDPROP_INTERNALLINERATE_CONTROL
Genre Read write mode Type of value Explanation
|
This property allows you to set or retrieve the exposure time and line rate behavior of the camera that allows exposure time and line rate to be set independently. |
DCAMPROP_INTERNALLINERATE_CONTROL__SYNC_EXPOSURE |
"SYNC EXPOSURE" |
Exposure time and line rate settings are synchronized. |
DCAMPROP_INTERNALLINERATE_CONTROL__PRIORITIZE_LINERATE |
"PRIORITIZE LINERATE" |
Line rate has higher priority than exposure time. The maximum exposure time is limited by the line rate setting. |
DCAMPROP_INTERNALLINERATE_CONTROL__PRIORITIZE_EXPOSURETIME |
"PRIORITIZE EXPOSURETIME" |
Exposure time has higher priority than line rate. The maximum line rate is limited by the exposure time setting. |
Reference
DCAM_IDPROP_INTERNALTRIGGER_HANDLING
DCAM_IDPROP_INTERNALTRIGGER_HANDLING
Genre Read write mode Type of value Explanation
|
This property can specify the range of exposure and frame handling. Some devices can set this property. |
|
This property allows you to choose behavior of TRIGGER SOURCE INTERNAL mode. This property can have one of following values: |
DCAMPROP_INTERNALTRIGGER_HANDLING__SHORTEREXPOSURETIME |
"SHORTER EXPOSURE TIME" |
Exposure time can be set in shorter than frame readout time but frame rate is slower. |
DCAMPROP_INTERNALTRIGGER_HANDLING__FASTERFRAMERATE |
"FASTER FRAME RATE" |
Frame rate is faster than above mode but exposure time must be equal or longer than frame readout time. |
DCAMPROP_INTERNALTRIGGER_HANDLING__ABANDONWRONGFRAME |
"ABANDON WRONG FRAME" |
If data coming from camera is corrupted, DCAM abandons the frame. |
DCAMPROP_INTERNALTRIGGER_HANDLING__BURSTMODE |
"BURST MODE" |
DCAM just transfer the data coming from camera. |
Reference
DCAM_IDPROP_LIGHTMODE
Genre Read write mode Type of value Explanation
|
This property allows you to specify to switch the sensor working mode between "Low Light" and "High Light": |
DCAMPROP_LIGHTMODE__LOWLIGHT |
LOW LIGHT |
Sensor works for darker signal. |
DCAMPROP_LIGHTMODE__HIGHLIGHT |
"HIGH LIGHT" |
Sensor works for brighter signal. |
Reference
DCAM_IDPROP_MASKREGION_HPOS
DCAM_IDPROP_MASKREGION_HPOS
Genre Read write mode Type of value Explanation
|
This property allows you to set a horizontal start address of a mask region. |
Reference
DCAM_IDPROP_MASKREGION_HSIZE
DCAM_IDPROP_MASKREGION_HSIZE
Genre Read write mode Type of value Explanation
|
This property allows you to set a horizontal size of a mask region. This is an ARRAY. |
Reference
DCAM_IDPROP_MASTERPULSE_BURSTTIMES
DCAM_IDPROP_MASTERPULSE_BURSTTIMES
Genre Read write mode Type of value Explanation
|
This property allows you to set the number of pulse that master pulse outputs by a trigger. This property is only effective if master pulse is effective and DCAM_IDPROP_MASTERPULSE_MODE is "BURST". |
Reference
DCAM_IDPROP_MASTERPULSE_INTERVAL
DCAM_IDPROP_MASTERPULSE_INTERVAL
Genre Read write mode Type of value Explanation
|
This property allows you to set input interval of master pulse in seconds. |
Reference
DCAM_IDPROP_MASTERPULSE_MODE
DCAM_IDPROP_MASTERPULSE_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to choose master pulse mode you use. This property is only effective if DCAM_IDPROP_TRIGGERSOURCE is available and set to "MASTER PULSE". The following values are defined: |
DCAMPROP_MASTERPULSE_MODE__CONTINUOUS |
"CONTINUOUS" |
Master pulse outputs continuously at the start of capturing. |
DCAMPROP_MASTERPULSE_MODE__START |
"START" |
Master pulse outputs continuously from received the trigger. |
DCAMPROP_MASTERPULSE_MODE__BURST |
"BURST" |
Master pulse outputs the number of times you set from received the trigger and waits next trigger. |
Reference
DCAM_IDPROP_MASTERPULSE_TRIGGERSOURCE
DCAM_IDPROP_MASTERPULSE_TRIGGERSOURCE
Genre Read write mode Type of value Explanation
|
This property allows you to choose input trigger of master pulse. |
DCAMPROP_MASTERPULSE_TRIGGERSOURCE__EXTERNAL |
"EXTERNAL" |
Master pulse works with trigger comes from input trigger pin. |
DCAMPROP_MASTERPULSE_TRIGGERSOURCE__SOFTWARE |
"SOFTWARE" |
Master pulse works with trigger fired by software. |
Reference
DCAM_IDPROP_MEASURED_SENSITIVITY
DCAM_IDPROP_MEASURED_SENSITIVITY
Genre Read write mode Type of value Explanation
|
This property returns measured amplification by sensitivity at this moment. To get this value, some conditions are required: |
|
In case of C9100-23B, DCAM_IDPROP_CCDMODE has to be DCAMPROP_CCDMODE__EMCCD (EMCCD Mode) and Intensity has to be not too dark and no saturation. The value is updated after capturing image, so please get this value at that time. |
|
If this value is 0, the camera condition for checking was not good. |
Reference
DCAM_IDPROP_NUMBEROF_CALIBREGION
DCAM_IDPROP_NUMBEROF_CALIBREGION
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the region to judge the brightness when brightness correction data is acquired. |
|
The judgment range can be specified in up to four separate sections. Data is transmitted in the following order: first the command name, then the quantity, then the first pixel value on the front side, then the first pixel value on the back side, then the next pixel on the front side, then the next pixel value on the back side. When data is transmitted, the pixels should be specified in order beginning with the smallest, and there should be no duplication of pixels. |
|
The default value is one for the measurement range, so that the entire element field is targeted. The maximum value on the back side differs depending on the model, so this should be determined based on the data for the X-ray line sensor camera being used.
|
Reference
DCAM_IDPROP_NUMBEROF_CHANNEL
DCAM_IDPROP_NUMBEROF_CHANNEL
Genre Read write mode Type of value Explanation
|
This property returns how many channels exist. In case of B/W image, this is 1, and in case of RGB color image, this is 3. |
Reference
DCAM_IDPROP_NUMBEROF_DEFECTCORRECT
DCAM_IDPROP_NUMBEROF_DEFECTCORRECT
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the number how many you correct the data which is on a specified position. When this value is 0, no data is corrected. |
Reference
DCAM_IDPROP_NUMBEROF_IMAGEBLOCK
DCAM_IDPROP_NUMBEROF_IMAGEBLOCK
Genre Read write mode Type of value Explanation
|
For a camera with staggered sensors, this property returns the number of sensors. |
Reference
DCAM_IDPROP_NUMBEROF_MASKREGION
DCAM_IDPROP_NUMBEROF_MASKREGION
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the number how many you select region for filling data 0 instead of intensity. The default value is 0, so that the entire element field will be output. |
Reference
DCAM_IDPROP_NUMBEROF_OUTPUTTRIGGERCONNECTOR
DCAM_IDPROP_NUMBEROF_OUTPUTTRIGGERCONNECTOR
Genre Read write mode Type of value Explanation
|
This property allows you to get the number how many output trigger connectors the camera has. |
|
If this property is 2 or larger, output trigger properties support array. |
|
If this property does not exist or the value is 1, output trigger properties do not support array. |
Reference
DCAM_IDPROP_NUMBEROF_TAPCALIB
DCAM_IDPROP_NUMBEROF_TAPCALIB
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the A/D gain table. You can set the A/D table for each tap individually, or for all elements. To set the table for all elements, specify an element count. To set the table for an individual element, specify an element number. When setting a gain table, calibration is required. |
Reference
DCAM_IDPROP_NUMBEROF_VIEW
DCAM_IDPROP_NUMBEROF_VIEW
Genre Read write mode Type of value Explanation
|
This property returns how many views exist. In case of ORCA-D2 (C11254-10B), this is 2. In almost other cases, this is 1. |
Reference
DCAM_IDPROP_OUTPUT_INTENSITY
DCAM_IDPROP_OUTPUT_INTENSITY
Genre Read write mode Type of value Explanation
|
This property allows you to specify the output intensity of the camera. The following values are defined: |
DCAMPROP_OUTPUT_INTENSITY__NORMAL |
"NORMAL" |
The camera will output normal intensity data. |
DCAMPROP_OUTPUT_INTENSITY__TESTPATTERN |
"TEST PATTERN" |
The camera will output test pattern data. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_ACTIVE
DCAM_IDPROP_OUTPUTTRIGGER_ACTIVE
Genre Read write mode Type of value Explanation
|
Some devices support output trigger. This property allows you to select the output trigger from one of following values: |
DCAMPROP_OUTPUTTRIGGER_ACTIVE__EDGE |
"EDGE" |
The trigger shape is edge. The trigger starts from the binning of specified period and the output trigger period is specified by DCAM_IDPROP_OUTPUTTRIGGER_PERIOD. |
DCAMPROP_OUTPUTTRIGGER_ACTIVE__LEVEL |
"LEVEL" |
The trigger shape is level. The period is same as specified period. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_BASESENSOR
DCAM_IDPROP_OUTPUTTRIGGER_BASESENSOR
Genre Read write mode Type of value Explanation
|
Some camera has some view is set individual exposure time. This property allows you to select the target of output trigger based exposure. |
DCAMPROP_OUTPUTTRIGGER_BASESENSOR__VIEW1 |
"VIEW 1" |
Output trigger level becomes active during global exposure period of view1. |
DCAMPROP_OUTPUTTRIGGER_BASESENSOR__VIEW2 |
"VIEW 2" |
Output trigger level becomes active during global exposure period of view2. |
DCAMPROP_OUTPUTTRIGGER_BASESENSOR__ANYVIEW |
"ANY VIEW" |
Output trigger level becomes active when some view does global exposure. |
DCAMPROP_OUTPUTTRIGGER_BASESENSOR__ALLVIEWS |
"ALL VIEWS" |
Output trigger level becomes active when all views do global exposure. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_CHANNELSYNC
DCAM_IDPROP_OUTPUTTRIGGER_CHANNELSYNC
Genre Read write mode Type of value Explanation
|
Some devices support thinning output trigger signal. |
|
If you chose DCAMPROP_OUTPUTTRIGGER_CHANNELSYNC__2CHANNELS, Output trigger 1 and 2 connectors become exclusive. |
|
If you chose DCAMPROP_OUTPUTTRIGGER_CHANNELSYNC__3CHANNELS, Output trigger 1, 2 and 3 connectors become exclusive. |
|
This property allows you to select one of following values: |
DCAMPROP_OUTPUTTRIGGER_CHANNELSYNC__1CHANNEL |
"1 CHANNEL" |
Output trigger works as same as standard. All frames output same output trigger. |
DCAMPROP_OUTPUTTRIGGER_CHANNELSYNC__2CHANNELS |
"2 CHANNELS" |
Output trigger 1 will be output at odd frames and Output trigger 2 will be done at eve frames. Output trigger 3 is output for all frames. |
DCAMPROP_OUTPUTTRIGGER_CHANNELSYNC__3CHANNELS |
"3 CHANNELS" |
Output trigger 1 outputs signal in 1, 4, 7, … frames. Output trigger 2 outputs at 2, 5, 8, … frames. Output trigger 3 output at 3, 6, 9, … frames. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_DELAY
DCAM_IDPROP_OUTPUTTRIGGER_DELAY
Genre Read write mode Type of value Explanation
|
Some devices support output trigger. This property allows you to specify the delay of output trigger if DCAM_IDPROP_OUTPUTTRIGGER_ACTIVE is set to "EDGE". |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_KIND
DCAM_IDPROP_OUTPUTTRIGGER_KIND
Genre Read write mode Type of value Explanation
|
Some devices allow changing signal kind from output trigger pin. |
|
This property allows you to select the output trigger property from one of following values: |
DCAMPROP_OUTPUTTRIGGER_KIND__LOW |
"LOW" |
Output trigger level is LOW. |
DCAMPROP_OUTPUTTRIGGER_KIND__HIGH |
"HIGH" |
Output trigger level is HIGH. |
DCAMPROP_OUTPUTTRIGGER_KIND__GLOBALEXPOSURE |
"EXPOSURE" |
Output trigger level becomes active during global exposure period. |
DCAMPROP_OUTPUTTRIGGER_KIND__ANYROWEXPOSURE |
"ANYROW EXPOSURE" |
Output trigger level becomes active during any row of sensor is exposed. |
DCAMPROP_OUTPUTTRIGGER_KIND__TRIGGERREADY |
"TRIGGERREADY" |
Output trigger level becomes active during input trigger is acceptable. |
DCAMPROP_OUTPUTTRIGGER_KIND__PROGRAMABLE |
"PROGRAMABLE" |
Output trigger is programmable. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_PERIOD
DCAM_IDPROP_OUTPUTTRIGGER_PERIOD
Genre Read write mode Type of value Explanation
|
Some devices support output trigger. This property allows you to specify the output trigger period if DCAM_IDPROP_OUTPUTTRIGGER_ACTIVE is set to "EDGE". |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_POLARITY
DCAM_IDPROP_OUTPUTTRIGGER_POLARITY
Genre Read write mode Type of value Explanation
|
Some devices support output trigger. This property allows you to select the output trigger polarity from one of following values: |
DCAMPROP_OUTPUTTRIGGER_POLARITY__NEGATIVE |
"NEGATIVE" |
The trigger polarity is negative. The output trigger is low active. |
DCAMPROP_OUTPUTTRIGGER_POLARITY__POSITIVE |
"POSITIVE" |
The trigger polarity is positive. The output trigger is high active. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_PREHSYNCCOUNT
DCAM_IDPROP_OUTPUTTRIGGER_PREHSYNCCOUNT
Genre Read write mode Type of value Explanation
|
In DCAMPROP_SENSORMODE__PROGRESSIVE, DCAMPROP_OUTPUTTRIGGER_SOURCE__HSYNC is available. This can output triggers based on HSYNC timing. This property allows camera fires additional triggers before starting exposure. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_PROGRAMABLESTART
DCAM_IDPROP_OUTPUTTRIGGER_PROGRAMABLESTART
Genre Read write mode Type of value Explanation
|
Some devices support output trigger but starting timing can be different. This property allows you to select the first programmable output trigger timing. Choose from one of following values: |
DCAMPROP_OUTPUTTRIGGER_PROGRAMABLESTART__FIRSTEXPOSURE |
"FIRST EXPOSURE" |
The output trigger is signaled from first exposing period. |
DCAMPROP_OUTPUTTRIGGER_PROGRAMABLESTART__FIRSTREADOUT |
"FIRST READOUT" |
The output trigger is signaled from first reading period. |
Reference
DCAM_IDPROP_OUTPUTTRIGGER_SOURCE
DCAM_IDPROP_OUTPUTTRIGGER_SOURCE
Genre Read write mode Type of value Explanation
|
Some devices allow changing basic timing for programmable trigger. |
|
This property allows you to select the basic timing from one of following values: |
DCAMPROP_OUTPUTTRIGGER_SOURCE__EXPOSURE |
"EXPOSURE" |
Origin is at rise of global exposure period. |
DCAMPROP_OUTPUTTRIGGER_SOURCE__READOUTEND |
"READOUT END" |
Origin is at end of sensor reading. |
DCAMPROP_OUTPUTTRIGGER_SOURCE__VSYNC |
"VSYNC" |
Origin is at start of VSYNC signal. |
DCAMPROP_OUTPUTTRIGGER_SOURCE__HSYNC |
"HSYNC" |
Origin is at start of HSYNC signal. |
DCAMPROP_OUTPUTTRIGGER_SOURCE__TRIGGER |
"TRIGGER" |
Origin is at rise of input trigger. |
Reference
DCAM_IDPROP_PHOTONIMAGINGMODE
DCAM_IDPROP_PHOTONIMAGINGMODE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the value of the photon imaging mode which is useful in a low light image field. This property is independent from DCAM_IDPROP_SENSITIVITYMODE. This property can have one of the following values: |
DCAMPROP_PHOTONIMAGINGMODE__0 |
"0" |
Photon imaging mode is disabled. |
DCAMPROP_PHOTONIMAGINGMODE__1 |
"1" |
Photon imaging mode is enabled to mode 1. |
DCAMPROP_PHOTONIMAGINGMODE__2 |
"2" |
Photon imaging mode is enabled to mode 2. |
DCAMPROP_PHOTONIMAGINGMODE__3 |
"3" |
Photon imaging mode is enabled to mode 3. |
Reference
DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES
DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES
Genre Read write mode Type of value Explanation
|
This property specifies the amount of memory to use for the primary buffer to receive images from the interface driver. When the value is set to 0, it is disable and will be controlled by the standard process. |
|
The unit is Bytes, and the maximum value is basically 2000000 (2GB). However, depending on the interface driver, the number of frames may be limited, so it may be less than 2GB. In that case, the maximum value will change depending on the size output from the camera changed by Binning or/and Subarray settings. |
|
A similar property is DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES_MB, which can be specified in units of MB. They do not function simultaneously, and this property is only valid if DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES_MB is 0. |
Reference
DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES_MB
DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES_MB
Genre Read write mode Type of value Explanation
|
This property specifies the amount of memory to use for the primary buffer to receive images from the interface driver. When the value is set to 0, it is disable and behavior is determined by the setting of DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES. |
|
The unit is MB, and the maximum value is determined by the memory size. However, if the interface driver limits the number of frames, the maximum value will be the maximum number of frames multiplied by the image size output from the camera. |
|
A similar property is DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES, which can be specified in unit of Byte. They do not function simultaneously, and the setting of this property takes precedence. |
Reference
DCAM_IDPROP_READOUT_DIRECTION
DCAM_IDPROP_READOUT_DIRECTION
Genre Read write mode Type of value Explanation
|
This property allows you to change sensor reading direction. This property is available under some condition, e.g. DCAM_IDPROP_SENSORMODE is DCAMPROP_SENSORMODE__TDI or DCAMPROP_SENSORMODE__PROGRESSIVE. |
DCAMPROP_READOUT_DIRECTION__FORWARD |
"FORWARD" |
Readout direction is forward. |
DCAMPROP_READOUT_DIRECTION__BACKWARD |
"BACKWARD" |
Readout direction is backward. |
DCAMPROP_READOUT_DIRECTION__BYTRIGGER |
"BY TRIGGER" |
External trigger can change direction. This function is supported by a few cameras. Please see camera manual. |
DCAMPROP_READOUT_DIRECTION__DIVERGE |
"DIVERGE" |
Readout direction spreads up and down from center line. |
DCAMPROP_READOUT_DIRECTION__FORWARDBIDIRECTION |
"FORWARD BIDIRECTION" |
Initial Readout direction is FORWARD. After that, readout direction switches between BACKWARD and FORWARD for each frame. |
DCAMPROP_READOUT_DIRECTION__REVERSEBIDIRECTION |
"REVERSE BIDIRECTION" |
Initial Readout direction is BACKWARD. After that, readout direction switches between FORWARD and BACKWARD for each frame. |
Reference
DCAM_IDPROP_READOUTSPEED
Genre Read write mode Type of value Explanation
|
This property allows you to specify the speed of reading out sensor. Usually slower speed has better signal noise ratio (SNR). |
|
Smaller values mean slower speeds and larger values do faster. |
|
There are several special property values are predefined DCAMPROP_READOUTSPEED__SLOWEST can select slowest speed and DCAMPROP_READOUTSPEED__FASTEST can do fastest. The supported values depend on the camera. These values are for setting so it may be changed when application software reads back. |
DCAMPROP_READOUTSPEED__SLOWEST |
(no text) |
Use slowest readout speed. |
DCAMPROP_READOUTSPEED__FASTEST |
(no text) |
Use fastest readout speed. |
Reference
DCAM_IDPROP_RECORDFIXEDBYTES_PERFILE
DCAM_IDPROP_RECORDFIXEDBYTES_PERFILE (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns additional data size per a file when application records images by camera dcamcap_record() and dcamrec_*() functions. By using this property with DCAM_IDPROP_RECORDFIXEDBYTES_PERFRAME and DCAM_IDPROP_RECORDFIXEDBYTES_PERSESSION, you can calculate how many bytes the recorded file will be. |
Reference
DCAM_IDPROP_RECORDFIXEDBYTES_PERFRAME
DCAM_IDPROP_RECORDFIXEDBYTES_PERFRAME (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns additional data size per a file when application records images by camera dcamcap_record() and dcamrec_*() functions. By using this property with DCAM_IDPROP_RECORDFIXEDBYTES_PERFILE and DCAM_IDPROP_RECORDFIXEDBYTES_PERSESSION, you can calculate how many bytes the recorded file will be. |
Reference
DCAM_IDPROP_RECORDFIXEDBYTES_PERSESSION
DCAM_IDPROP_RECORDFIXEDBYTES_PERSESSION (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns additional data size per a file when application records images by camera dcamcap_record() and dcamrec_*() functions. By using this property with DCAM_IDPROP_RECORDFIXEDBYTES_PERFILE and DCAM_IDPROP_RECORDFIXEDBYTES_PERFRAME, you can calculate how many bytes the recorded file will be. |
Reference
DCAM_IDPROP_RECURSIVEFILTER
DCAM_IDPROP_RECURSIVEFILTER
Genre Read write mode Type of value Explanation
|
This property allows you to specify the recursive filter mode. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
The recursive filter function is turned off. |
DCAMPROP_MODE__ON |
"ON" |
The recursive filter function is turned on. |
Reference
DCAM_IDPROP_RECURSIVEFILTERFRAMES
DCAM_IDPROP_RECURSIVEFILTERFRAMES
Genre Read write mode Type of value Explanation
|
This property allows you to specify the number of recursive frames. This is effective when the property DCAM_IDPROP_RECURSIVEFILTER is set to “ON”. |
|
The value can be 2, 4, 8 or 16 if camera supports. |
Reference
DCAM_IDPROP_SENSITIVITY
Genre Read write mode Type of value Explanation
|
This property allows you to specify intensity amplifier level by sensitivity. Sensitivity means amplifier method before outputting intensity data from sensor. |
|
Typical function of Sensitivity is EM-Gain of EM-CCD cameras. |
|
The value of this property is usually relative value but in case of EM-CCD camera and DCAM_IDPROP_DIRECTEMGAIN_MODE is ON, then this value becomes REAL value and it shows magnification number from fixed table inside DCAM. The number is not measured in real time but it is good enough if EM-Gain is adjusted. |
Reference
DCAM_IDPROP_SENSITIVITYMODE
DCAM_IDPROP_SENSITIVITYMODE
Genre Read write mode Type of value Explanation
|
This property is prepared for future extension for sensitivity control At this moment this value is fixed if camera supports Sensitivity. |
DCAMPROP_SENSITIVITYMODE__ON |
"ON" |
Sensitivity is available. |
Reference
DCAM_IDPROP_SENSORCOOLER
Genre Read write mode Type of value Explanation
|
This property allows you to specify the sensor-cooling mode. This property can have one of following values: |
DCAMPROP_SENSORCOOLER__OFF |
"OFF" |
The sensor cooling is turned off. |
DCAMPROP_SENSORCOOLER__ON |
"ON" |
The sensor is cooled up to the cooling temperature target. |
DCAMPROP_SENSORCOOLER__MAX |
"MAX" |
The sensor is as cooled as possible. |
Reference
DCAM_IDPROP_SENSORCOOLERFAN
DCAM_IDPROP_SENSORCOOLERFAN
Genre Read write mode Type of value Explanation
|
This property allows you to turn the sensor-cooler fan on or off. This property can have one of following values: |
DCAMPROP_MODE__ON |
"ON" |
Fan is turning. |
DCAMPROP_MODE__OFF |
"OFF" |
Fan is stopped. |
Reference
DCAM_IDPROP_SENSORCOOLERSTATUS
DCAM_IDPROP_SENSORCOOLERSTATUS
Genre Read write mode Type of value Explanation
|
This property returns the sensor cooler status. This property can have one of following values: |
DCAMPROP_SENSORCOOLERSTATUS__NONE |
"NONE" |
Sensor cooler status is not reportable. The reason can be the device does not support this capability, or current condition does not allow to report. |
DCAMPROP_SENSORCOOLERSTATUS__OFF |
"OFF" |
Sensor cooler is not working now. |
DCAMPROP_SENSORCOOLERSTATUS__READY |
"READY" |
Sensor cooler controls sensor temperature well. |
DCAMPROP_SENSORCOOLERSTATUS__BUSY |
"BUSY" |
Sensor cooler is now progressive to make sensor temperature stable. |
DCAMPROP_SENSORCOOLERSTATUS__ALWAYS |
"ALWAYS" |
Sensor cooler is always working and no stability control. |
Reference
DCAM_IDPROP_SENSORMODE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the sensor mode of the camera. The following values are defined: |
DCAMPROP_SENSORMODE__AREA |
"AREA" |
The camera will output area image. |
DCAMPROP_SENSORMODE__LINE |
"LINE" |
The camera will output line image merged by DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT. |
DCAMPROP_SENSORMODE__TDI |
"TDI" |
The camera will output line image with TDI technology merged by DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT. |
DCAMPROP_SENSORMODE__TDI_EXTENDED |
"TDI EXTENDED" |
The mode is almost same as “TDI” but some cameras have 2 different LINE INTERVAL ranges. This mode has longer interval than “TDI”. |
DCAMPROP_SENSORMODE__PROGRESSIVE |
"PROGRESSIVE" |
The camera will output line image from top to bottom, or bottom to top with line speed control. |
DCAMPROP_SENSORMODE__PHOTONNUMBERRESOLVING |
"PHOTON NUMBER RESOLVING" |
The camera will output the digital data as photon number (one digital number per one photoelectron) by quantifying the output digital data from AD converter to photon number with read time image processing. |
DCAMPROP_SENSORMODE__PARTIALAREA |
"PARTIAL AREA" |
The sensor outputs the image of 2x2 binning to fixed angle of view that is smaller than full angle of view for AREA. |
DCAMPROP_SENSORMODE__PANORAMIC |
"PANORAMIC" |
The sensor outputs a fixed landscape image whose horizontal size is same as AREA and whose vertical size is smaller than AREA. |
|
In “AREA” sensor mode, the camera sets it sensor to AREA mode so the output data will be an area image. |
|
In “LINE” sensor mode, the camera sets it sensor to LINE mode even if it is an AREA sensor. The output data will be an area image which is merged by the number specified by DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT. |
|
In “TDI” sensor mode, the camera exposes and reads out with TDI technology and the output data will be an area image which is merged by the number specified by DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT. |
|
In “PROGRESSIVE” sensor mode, the camera exposes and reads out sensor from top to bottom or from bottom to top progressively. This feature is mainly supported by camera with rolling shutter sensor. In this sensor mode, the vertical scanning speed is also controllable and they are controlled by DCAM_IDPROP_INTERNALLINESPEED and/or DCAM_IDPROP_INTERNAL_LINEINTERVAL. |
Reference
DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT
DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT
Genre Read write mode Type of value Explanation
|
This property allows you to set the number of lines to bundle when SENSORMODE is LINE or TDI. This number is used to merge the line type output image to be used as frame. |
Reference
DCAM_IDPROP_SENSORMODE_PANORAMICSTARTV
DCAM_IDPROP_SENSORMODE_PANORAMICSTARTV
Genre Read write mode Type of value Explanation
|
This property allows you to set the vertical offset number of readout start position when SENSORMODE is PANORAMIC. |
Reference
DCAM_IDPROP_SENSORMODE_TDISTAGE
DCAM_IDPROP_SENSORMODE_TDISTAGE
Genre Read write mode Type of value Explanation
|
This property allows you to set the number of TDI stages to use. In AREA mode, it corresponds to the number of vertical pixels of the output image. |
Reference
DCAM_IDPROP_SENSORTEMPERATURE
DCAM_IDPROP_SENSORTEMPERATURE
Genre Read write mode Type of value Explanation
|
This property reports the temperature of the image sensor in Celsius. |
Reference
DCAM_IDPROP_SENSORTEMPERATURETARGET
DCAM_IDPROP_SENSORTEMPERATURETARGET
Genre Read write mode Type of value Explanation
|
This property allows you to specify the target temperature of the image sensor in Celsius. |
Reference
DCAM_IDPROP_SHADINGCALIBDATAMEMORY
DCAM_IDPROP_SHADINGCALIBDATAMEMORY
Genre Read write mode Type of value Explanation
|
This property allows you to specify the image page to use for shading correction. When the application sets the number into this property, the camera will use the specified image for shading correction. If DCAM_IDPROP_SHADINGCORRECTION is “ON”, this value is effective. |
Reference
DCAM_IDPROP_SHADINGCALIB_METHOD
DCAM_IDPROP_SHADINGCALIB_METHOD
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to choose the method of shading calibration. The following values are defined: |
DCAMPROP_SHADINGCALIB_METHOD__AVERAGE |
"AVERAGE" |
The target value of data correction is the average of all pixel data. |
DCAMPROP_SHADINGCALIB_METHOD__MAXIMUM |
"MAXIMUM" |
The target value of data correction is the maximum number in all pixel data. |
DCAMPROP_SHADINGCALIB_METHOD__USETARGET |
"USE TARGET" |
The target value of data correction is set by DCAM_IDPROP_SHADINGCALIB_TARGET. |
Reference
DCAM_IDPROP_SHADINGCALIB_SAMPLES
DCAM_IDPROP_SHADINGCALIB_SAMPLES
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the total number of samples for averaging during shading calibration. |
|
If the SENSOR type is AREA, sample unit is one frame, if the SENSOR type is LINE/TDI, sample unit is one line. |
Reference
DCAM_IDPROP_SHADINGCALIB_STABLEMAXERRORPERCENT
DCAM_IDPROP_SHADINGCALIB_STABLEMAXERRORPERCENT
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the percentage of disparity of the data during sensitivity calibration. The average brightness value is taken as the reference value, and when the disparity of the brightness data that has been specified for the brightness data confirmation range command drops below this set value, sensitivity correction data is acquired. This set value has the same value on both the positive and negative sides. If the set value is 0, only the disparity % is confirmed. |
Reference
DCAM_IDPROP_SHADINGCALIB_STABLEMININTENSITY
DCAM_IDPROP_SHADINGCALIB_STABLEMININTENSITY
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the minimum brightness judgment value for taking when correction data bright conditions. If any pixel data is lower than this value, camera does not use the all data for calibration. If such condition happens, calibration will not finish. |
Reference
DCAM_IDPROP_SHADINGCALIB_STABLESAMPLES
DCAM_IDPROP_SHADINGCALIB_STABLESAMPLES
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the minimum number of stable frames. Stable frames are frames that pass all of conditions which are set by other properties, such as the following: |
|
DCAM_IDPROP_SHADINGCALIB_STABLEMININTENSITY |
|
DCAM_IDPROP_SHADINGCALIB_STABLEMAXERRORPERCENT |
|
If this value is 0, camera will calibrate with any incoming data. |
Reference
DCAM_IDPROP_SHADINGCALIB_TARGET
DCAM_IDPROP_SHADINGCALIB_TARGET
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the target value for calibration. |
Reference
DCAM_IDPROP_SHADINGCORRECTION
DCAM_IDPROP_SHADINGCORRECTION
Genre Read write mode Type of value Explanation
|
This property allows you to enable the shading correction function. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
The shading correction function is turned off. |
DCAMPROP_MODE__ON |
"ON" |
The shading correction function is available with another image which is specified by DCAM_IDPROP_SHADINGCALIBDATAMEMORY. |
Reference
DCAM_IDPROP_SHUTTER_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to set the shutter mode of CMOS sensor. |
DCAMPROP_SHUTTER_MODE__GLOBAL |
GLOBAL |
CMOS shutter mode is Global. |
DCAMPROP_SHUTTER_MODE__ROLLING |
ROLLING |
CMOS shutter mode is Rolling. |
Reference
DCAM_IDPROP_SPOTNOISEREDUCER
DCAM_IDPROP_SPOTNOISEREDUCER
Genre Read write mode Type of value Explanation
|
This property allows you to enable the spot noise reduce function. This property can have one of following values: |
DCAMPROP_MODE__OFF |
"OFF" |
The spot noise reduce is turned off. |
DCAMPROP_MODE__ON |
"ON" |
The spot noise reduce is turned on. |
Reference
DCAM_IDPROP_STORESHADINGCALIBDATATOMEMORY
DCAM_IDPROP_STORESHADINGCALIBDATATOMEMORY
Genre Read write mode Type of value Explanation
|
This property is used to set the shading calibration image. When the application sets the number into this property, the camera will capture the shading calibration image to specify the page by the number. This property can be set in any state. |
Reference
DCAM_IDPROP_STORESUBTRACTIMAGETOMEMORY
DCAM_IDPROP_STORESUBTRACTIMAGETOMEMORY
Genre Read write mode Type of value Explanation
|
This property is used to set the subtract image. When the application sets the number into this property, the camera will capture the subtract image to specified the page by the number. This property can be set in any state. |
Reference
DCAM_IDPROP_STORETAPCALIBDATATOMEMORY
DCAM_IDPROP_STORETAPCALIBDATATOMEMORY
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to store the calibration data into memory. This property can be set in any state. |
Reference
DCAM_IDPROP_SUBARRAYHPOS
Genre Read write mode Type of value Explanation
|
This property allows you to specify the left position of capturing area. This property is effective if DCAM_IDPROP_SUBARRAYMODE is set to DCAMPROP_MODE__ON. |
Reference
DCAM_IDPROP_SUBARRAYHSIZE
DCAM_IDPROP_SUBARRAYHSIZE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the horizontal width of capturing area. This property is effective if DCAM_IDPROP_SUBARRAYMODE is set to DCAMPROP_MODE__ON. |
Reference
DCAM_IDPROP_SUBARRAYMODE
Genre Read write mode Type of value Explanation
|
This property allows you to enable the SUBARRAY settings. Enabling this property will make all of the SUBARRAY properties effective. |
Reference
DCAM_IDPROP_SUBARRAYVPOS
Genre Read write mode Type of value Explanation
|
This property allows you to specify the top position of capturing area. This property is effective if DCAM_IDPROP_SUBARRAYMODE is set to DCAMPROP_MODE__ON. |
Reference
DCAM_IDPROP_SUBARRAYVSIZE
DCAM_IDPROP_SUBARRAYVSIZE
Genre Read write mode Type of value Explanation
|
This property allows you to specify the vertical width of capturing area. This property is effective if DCAM_IDPROP_SUBARRAYMODE is set to DCAMPROP_MODE__ON. |
Reference
DCAM_IDPROP_SUBTRACT
Genre Read write mode Type of value Explanation
This property allows you to specify the background subtraction mode. This property can have one of following values:
DCAMPROP_MODE__OFF |
"OFF" |
The background subtraction function is turned off. |
DCAMPROP_MODE__ON |
"ON" |
The background subtraction function is available with another image which is specified by DCAM_IDPROP_SUBTRACTIMAGEMEMORY. |
Reference
DCAM_IDPROP_SUBTRACTIMAGEMEMORY
DCAM_IDPROP_SUBTRACTIMAGEMEMORY
Genre Read write mode Type of value Explanation
This property allows you to specify the image page to subtract. When the application sets a number into this property, the camera will use the subtract image to specified the page by the number. The application can set this property during any state. This value is used if DCAM_IDPROP_SUBTRACT is set to “ON”.
Reference
DCAM_IDPROP_SUBTRACTOFFSET
DCAM_IDPROP_SUBTRACTOFFSET
Genre Read write mode Type of value Explanation
|
This property allows you to specify the offset value of background subtraction. This value is used if DCAM_IDPROP_SUBTRACT is “OFFSET” or “IMAGE”. |
Reference
DCAM_IDPROP_SYNCREADOUT_SYSTEMBLANK
DCAM_IDPROP_SYNCREADOUT_SYSTEMBLANK
Genre Read write mode Type of value Explanation
|
This property allows you to select the blank of syncreadout. |
DCAMPROP_SYNCREADOUT_SYSTEMBLANK__STANDARD |
"STANDARD" |
The blank of syncreadout trigger is standard. |
DCAMPROP_SYNCREADOUT_SYSTEMBLANK__MINIMUM |
"MINIMUM" |
The blank of syncreadout trigger is minimum. |
Reference
DCAM_IDPROP_SYSTEM_ALIVE
Genre Read write mode Type of value Explanation
|
This property returns the online status of the device. This property can have one of following values: |
DCAMPROP_SYSTEM_ALIVE__OFFLINE |
"OFFLINE" |
The system is offline. |
DCAMPROP_SYSTEM_ALIVE__ONLINE |
"ONLINE" |
The system is online. |
DCAMPROP_SYSTEM_ALIVE__ERROR |
"ERROR" |
The system is online, but there is a hardware trouble. |
Reference
DCAM_IDPROP_TAPCALIB_BASEDATAMEMORY
DCAM_IDPROP_TAPCALIB_BASEDATAMEMORY
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the base data for calibration. This value from specified index memory is used for first value of calibration. |
Reference
DCAM_IDPROP_TAPCALIBDATAMEMORY
DCAM_IDPROP_TAPCALIBDATAMEMORY
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the number of tap calibration data memory. When you set this value, camera load from the data from specified memory. |
Reference
DCAM_IDPROP_TAPCALIB_GAIN
DCAM_IDPROP_TAPCALIB_GAIN
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the number of gain table. |
|
This property is an ARRAY. |
Reference
DCAM_IDPROP_TAPGAINCALIB_METHOD
DCAM_IDPROP_TAPGAINCALIB_METHOD
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to choose the method of tap gain calibration. This property can have one of following values: |
DCAMPROP_TAPGAINCALIB_METHOD__AVE |
"AVERAGE" |
Use average. |
DCAMPROP_TAPGAINCALIB_METHOD__MAX |
"MAX" |
Use maximum. |
DCAMPROP_TAPGAINCALIB_METHOD__MIN |
"MIN" |
Use minimum. |
Reference
DCAM_IDPROP_TESTPATTERN_KIND
DCAM_IDPROP_TESTPATTERN_KIND
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to choose test pattern. This property is effective if DCAM_IDPROP_OUTPUT_INTENSITY is DCAMPROP_OUTPUT_INTENSITY__TESTPATTERN. This property can have one of following values: |
DCAMPROP_TESTPATTERN_KIND__HORZGRADATION |
"HORZ GRADATION" |
The camera will output horizontal gradation data. |
DCAMPROP_TESTPATTERN_KIND__IHORZGRADATION |
"INVERT HORZ GRADATION" |
The camera will output horizontal inverted gradation data. |
DCAMPROP_TESTPATTERN_KIND__VERTGRADATION |
"VERT GRADATION" |
The camera will output vertical gradation data. |
DCAMPROP_TESTPATTERN_KIND__IVERTGRADATION |
"INVERT VERT GRADATION" |
The camera will output vertical inverted gradation data. |
DCAMPROP_TESTPATTERN_KIND__LINE |
"LINE" |
The camera will output line pattern data. The line is white and the background is black. |
DCAMPROP_TESTPATTERN_KIND__ILINE |
"LINE" |
The camera will output line pattern data. The line is black and the background is white. |
DCAMPROP_TESTPATTERN_KIND__FLAT |
"FLAT" |
The camera will output constant brightness pattern data. |
DCAMPROP_TESTPATTERN_KIND__DIAGONAL |
"DIAGONAL" |
The camera will output diagonal line pattern data. |
DCAMPROP_TESTPATTERN_KIND__IDIAGONAL |
"DIAGONAL" |
The camera will output diagonal line pattern data. The brightness is inverted as DIAGONAL. |
Reference
DCAM_IDPROP_TESTPATTERN_OPTION
DCAM_IDPROP_TESTPATTERN_OPTION
Genre
|
Calibration and correction |
Read write mode Type of value Explanation
|
This property allows you to set the option parameter for TESTPATTERN. |
Reference
DCAM_IDPROP_TIMESTAMP_PRODUCER
DCAM_IDPROP_TIMESTAMP_PRODUCER (4.0-)
Genre Read write mode Type of value Explanation
|
This property returns the source that TIMESTAMP is produced from. The property can have one of following values: |
DCAMPROP_TIMESTAMP_PRODUCER__NONE |
"NONE" |
TIMESTAMP is not supported in the camera or under the current condition. |
DCAMPROP_TIMESTAMP_PRODUCER__DCAMMODULE |
"DCAMMODULE" |
TIMESTAMP is produced from DCAM. |
DCAMPROP_TIMESTAMP_PRODUCER__KERNELDRIVER |
"KERNELDRIVER" |
TIMESTAMP is produced from kernel driver. |
DCAMPROP_TIMESTAMP_PRODUCER__CAPTUREDEVICE |
"CAPTUREDEVICE" |
TIMESTAMP is produced from Frame Grabber. |
DCAMPROP_TIMESTAMP_PRODUCER__IMAGINGDEVICE |
"IMAGINGDEVICE" |
TIMESTAMP is produced from Camera. |
Reference
DCAM_IDPROP_TIMING_CYCLICTRIGGERPERIOD
DCAM_IDPROP_TIMING_CYCLICTRIGGERPERIOD
Genre Read write mode Type of value Explanation
|
This property returns the cycle trigger period. If value is positive, the next trigger is cyclic trigger fired from end of exposure to next this period. If this value is 0, the camera does not support cyclic trigger. |
Reference
DCAM_IDPROP_TIMING_EXPOSURE
DCAM_IDPROP_TIMING_EXPOSURE
Genre Read write mode Type of value Explanation
|
This property returns the timing of exposure. This property can have one of following values: |
DCAMPROP_TIMING_EXPOSURE__AFTERREADOUT |
"AFTER READOUT" |
The exposure starts after reading previous the frame completely. |
DCAMPROP_TIMING_EXPOSURE__OVERLAPREADOUT |
"OVERLAR READOUT" |
The exposure starts during reading the previous frame. |
DCAMPROP_TIMING_EXPOSURE__ROLLING |
"ROLLING" |
The exposure starts at each pixel after reading it at the previous frame. |
DCAMPROP_TIMING_EXPOSURE__ALWAYS |
"ALWAYS" |
The sensor is exposed always, even in reading out period. |
DCAMPROP_TIMING_EXPOSURE__TDI |
"TDI" |
The sensor is running as TDI sensor. |
Reference
DCAM_IDPROP_TIMING_GLOBALEXPOSUREDELAY
DCAM_IDPROP_TIMING_GLOBALEXPOSUREDELAY
Genre Read write mode Type of value Explanation
|
If the sensor does not have GLOBAL SHUTTER capability, GLOBAL EXPOSURE timing, which means all pixels on the sensor is exposed, is delayed. This property returns how long GLOBAL EXPOSURE is delayed from beginning of EXPOSURE sensor itself. |
|
This is useful with light source control system, e.g. strobe. |
|
This property is EFFECTIVE when DCAM_IDPROP_TRIGGER_GLOBAL_EXPOSURE is DCAMPROP_TRIGGER_GLOBALEXPOSURE__DELAYED. |
Reference
DCAM_IDPROP_TIMING_INVALIDEXPOSUREPERIOD
DCAM_IDPROP_TIMING_INVALIDEXPOSUREPERIOD
Genre Read write mode Type of value Explanation
|
This value shows how long takes starting exposure from input trigger. Because of its structure, some sensors cannot start exposure immediately. There are various reasons but this property just tells how long it is. |
|
This value does not include jitter of input trigger. |
Reference
DCAM_IDPROP_TIMING_MINTRIGGERBLANKING
DCAM_IDPROP_TIMING_MINTRIGGERBLANKING
Genre Read write mode Type of value Explanation
|
This property returns the period from the end of exposure to trigger ready. |
Reference
DCAM_IDPROP_TIMING_MINTRIGGERINTERVAL
DCAM_IDPROP_TIMING_MINTRIGGERINTERVAL
Genre Read write mode Type of value Explanation
|
This property returns the period from receiving input trigger to trigger ready. |
Reference
DCAM_IDPROP_TIMING_READOUTTIME
DCAM_IDPROP_TIMING_READOUTTIME
Genre Read write mode Type of value Explanation
|
This property returns frame read out time in seconds. |
Reference
DCAM_IDPROP_TRANSFERINFO_FRAMECOUNT
DCAM_IDPROP_TRANSFERINFO_FRAMECOUNT
Genre Read write mode Type of value Explanation
|
This property tells the frame count of last capturing. Some cameras only supports this property. |
Reference
DCAM_IDPROP_TRANSFERINFO_LOSTCOUNT
DCAM_IDPROP_TRANSFERINFO_LOSTCOUNT
Genre Read write mode Type of value Explanation
|
This property tells the lost frame count of last capturing. Some cameras only supports this property. |
Reference
DCAM_IDPROP_TRIGGERACTIVE
DCAM_IDPROP_TRIGGERACTIVE
Genre Read write mode Type of value Explanation
|
This property allows you to choose trigger sequence. The following values are defined: |
DCAMPROP_TRIGGERACTIVE__EDGE |
"EDGE" |
Exposure starts at raising or falling edge. |
DCAMPROP_TRIGGERACTIVE__LEVEL |
"LEVEL" |
Exposure during trigger is high or low. |
DCAMPROP_TRIGGERACTIVE__SYNCREADOUT |
"SYNCREADOUT" |
Exposure between two pulses. |
Reference
DCAM_IDPROP_TRIGGER_CONNECTOR
DCAM_IDPROP_TRIGGER_CONNECTOR
Genre Read write mode Type of value Explanation
|
This property allows you to choose input trigger connector. |
DCAMPROP_TRIGGER_CONNECTOR__BNC |
"BNC" |
Input trigger pin is BNC connector. |
DCAMPROP_TRIGGER_CONNECTOR__INTERFACE |
"INTERFACE" |
Input trigger pin is inside interface cable. Almost cameras of Camera Link or LVDS type support this. But usually this is used from inside of DCAM at SOFTWARE trigger. |
DCAMPROP_TRIGGER_CONNECTOR__MULTI |
"MULTI" |
Input trigger pin is Multi I/O pin. |
Reference
DCAM_IDPROP_TRIGGERDELAY
Genre Read write mode Type of value Explanation
|
This property can set delay time for using this timing inside of camera. |
Reference
DCAM_IDPROP_TRIGGERENABLE_ACTIVE
DCAM_IDPROP_TRIGGERENABLE_ACTIVE
Genre Read write mode Type of value Explanation
|
This property allows you to choose how trigger enable effects. You can input trigger enable signal to the camera if the camera supports this property. Trigger enable signal can make trigger enable as following: |
DCAMPROP_TRIGGERENABLE_ACTIVE__ALWAYS |
"ALWAYS" |
Trigger is always enabled independently from Trigger enable signal. |
DCAMPROP_TRIGGERENABLE_ACTIVE__LEVEL |
"LEVEL" |
Trigger is enabled during trigger enable is high or low. |
DCAMPROP_TRIGGERENABLE_ACTIVE__START |
"START" |
Trigger becomes enabling after falling or rising edge of trigger enable. |
DCAMPROP_TRIGGERENABLE_ACTIVE__BURST |
"BURST" |
Trigger becomes enabling the configured number of times after falling or rising edge of trigger enable. |
Reference
DCAM_IDPROP_TRIGGERENABLE_POLARITY
DCAM_IDPROP_TRIGGERENABLE_POLARITY
Genre Read write mode Type of value Explanation
|
This property allows you to choose trigger enable polarity. The following values are defined: |
DCAMPROP_TRIGGERENABLE_POLARITY__NEGATIVE |
"NEGATIVE" |
Falling edge or LOW level. |
DCAMPROP_TRIGGERENABLE_POLARITY__POSITIVE |
"POSITIVE" |
Rising edge or HIGH level. |
Reference
DCAM_IDPROP_TRIGGERENABLE_SOURCE
DCAM_IDPROP_TRIGGERENABLE_SOURCE
Genre Read write mode Type of value Explanation
|
This property allows you to choose trigger enable connector. The following values are defined: |
DCAMPROP_TRIGGERENABLE_SOURCE__MULTI |
"MULTI" |
Input trigger pin is Multi I/O pin. |
DCAMPROP_TRIGGERENABLE_SOURCE__SMA |
"SMA" |
Input trigger pin is SMA connector. |
Reference
DCAM_IDPROP_TRIGGERENABLE_BURSTTIMES
DCAM_IDPROP_TRIGGERENABLE_BURSTTIMES
Genre Read write mode Type of value Explanation
|
This property allows you to set the number of triggers accepted after inputting the trigger enable signal. |
|
This property is only effective if DCAM_IDPROP_TRIGGERENABLE_ACTIVE is effective and value is "BURST". |
Reference
DCAM_IDPROP_TRIGGER_FIRSTEXPOSURE
DCAM_IDPROP_TRIGGER_FIRSTEXPOSURE
Genre Read write mode Type of value Explanation
|
This property allows you to determine whether exposure of the DCAM captured data will be done before the trigger or after the trigger. The property can have one of following values: |
DCAMPROP_TRIGGER_FIRSTEXPOSURE__NEW |
"NEW" |
The captured data starts exposure after the trigger. |
DCAMPROP_TRIGGER_FIRSTEXPOSURE__CURRENT |
"CURRENT" |
The captured data starts exposure before the trigger. |
Reference
DCAM_IDPROP_TRIGGER_GLOBALEXPOSURE
DCAM_IDPROP_TRIGGER_GLOBALEXPOSURE
Genre Read write mode Type of value Explanation
|
This property allows you to choose GLOBAL EXPOSURE option in some trigger modes. The following values are defined: |
DCAMPROP_TRIGGER_GLOBALEXPOSURE__ALWAYS |
"ALWAYS" |
The sensor exposes globally during all exposure period. In this case, sensor is CCD or CMOS with global shutter. |
DCAMPROP_TRIGGER_GLOBALEXPOSURE__DELAYED |
"DELAYED" |
Global exposure is delayed from beginning of sensor exposure. In this case, sensor is CMOS with rolling shutter. |
DCAMPROP_TRIGGER_GLOBALEXPOSURE__EMULATE |
"EMULATE" |
Global exposure is emulated. In this case, sensor is CMOS with rolling shutter, but adding two frames at trigger. So the light source can illuminate with very short period, this mode can emulate global shutter with rolling shutter mode. |
DCAMPROP_TRIGGER_GLOBALEXPOSURE__GLOBALRESET |
"GLOBAL RESET" |
Global reset is used. In this case, sensor is CMOS with rolling shutter, but reset timing is globally same. So the light source can illuminate very soon after trigger without waiting sensor reset time. |
Reference
DCAM_IDPROP_TRIGGER_MODE
Genre Read write mode Type of value Explanation
|
This property allows you to choose trigger mode to use. The following values are defined: |
DCAMPROP_TRIGGER_MODE__NORMAL |
"NORMAL" |
Standard trigger mode. DCAM_IDPORP_TRIGGERACTIVE is effective. |
DCAMPROP_TRIGGER_MODE__PIV |
"PIV" |
Trigger makes PIV action. The first frame exposure is selected by DCAM_IDPROP_TRIGGERACTIVE. |
DCAMPROP_TRIGGER_MODE__START |
"START" |
Trigger starts internal trigger mode. |
Reference
DCAM_IDPROP_TRIGGERPOLARITY
DCAM_IDPROP_TRIGGERPOLARITY
Genre Read write mode Type of value Explanation
|
This property allows you to choose trigger polarity. The following values are defined: |
DCAMPROP_TRIGGERPOLARITY__NEGATIVE |
"NEGATIVE" |
Falling edge or LOW level. |
DCAMPROP_TRIGGERPOLARITY__POSITIVE |
"POSITIVE" |
Rising edge or HIGH level. |
Reference
DCAM_IDPROP_TRIGGERSOURCE
DCAM_IDPROP_TRIGGERSOURCE
Genre Read write mode Type of value Explanation
|
This property allows you to choose which trigger source you use. The following values are defined: |
DCAMPROP_TRIGGERSOURCE__INTERNAL |
"INTERNAL" |
Camera uses its own timing. |
DCAMPROP_TRIGGERSOURCE__EXTERNAL |
"EXTERNAL" |
Camera works with trigger comes from input trigger pin. |
DCAMPROP_TRIGGERSOURCE__SOFTWARE |
"SOFTWARE" |
Camera works with trigger fired by software. |
DCAMPROP_TRIGGERSOURCE__MASTERPULSE |
"MASTER PULSE" |
Camera works with trigger comes from own pulse generator. |
Reference
DCAM_IDPROP_TRIGGERTIMES
Genre Read write mode Type of value Explanation
|
This property allows you to set the number of trigger times. When in synchronous readout trigger mode. The camera will readout the current exposure and begins a new exposure once the number of triggers specified by this property has been received. |
Reference
|