v24.9.6861

Contents


- Overview
DCAM-API "Property"
Value Types
Attributes
Property Group(TBD:future)
Functions
- Value
Maximum, Minimum, Step and Default
- Attributes - Basic
READABLE, WRITABLE, read-only, write-only
AUTOROUNDING
STEPPING_INCONSISTENT
VOLATILE
DCAMSTREAM
ACCESSREADY
ACCESSBUSY
- Attributes - Advance
UPDATED
CHANNEL
VIEW
ARRAY
INITIALIZE IMPROPER
- Function
Value text
Enumeration
- Property - Group
Trigger properties
Advanced Trigger properties
Exposure time properties
Anti-blooming properties
Sensitivity properties
Sensor temperature properties
Contrast enhancement properties
ALU properties
Data Reduction properties
Output Trigger properties
Master Pulse properties
Readout properties
Binning and sub-array properties
Timing information properties
Output data type properties
Frame bundle properties
System properties
- Technology
SENSOR MODE TDI

Go to top of this chapter


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


Introduction


This manual describes the DCAM-API specification used to operate digital cameras manufactured by HAMAMATSU (hereafter referred to simply as "digital cameras"). The DCAM-API software development kit is referred to as the "SDK". The DCAM-API driver that controls the digital cameras is referred to as the "module".
The SDK consists of source code for sample applications that show how to access DCAM-API. SDK users are free to use this software in any way they like, such as partially modifying source codes and creating completely separate programs.
This SDK is designed to be particularly easy to understand. For this reason, the number of function has been limited to a minimum, and the function calling formats are written in the C programming language.
This text shows how to use the properties that control the functions of digital camera.
Numeric values appearing in this text may differ depending on the digital camera used to capture images. Numeric values should be regarded simply as guides, and not as exact values.

Go to top of this chapter


Overview


DCAM-API "Property"
Several functions have been added for property in DCAM-API for version 3.0. The word "property" refers to a device parameter. Your application software programs can get, set and/or query device parameters with these new functions.
Each property has a unique ID and every property value is handled as double floating value even if it is an integer on the device.
Each property has its own attributes, minimum, maximum, stepping and/or default values and their own name. Some properties are enumerative types and their values also have associated text. We call such text as value text.

Value Types
There are three types of property values: MODE, LONG and REAL. These values are operated with 64bit double float variables. However, LONG and MODE are regarded as 32bit signed integer internally where as REAL is regarded as a 64bit float decimal. The LONG and REAL types are numerical values. The MODE type is not a numerical value but DCAM-API regards it as integer with unique IDs. Every MODE has text for each assigned value. Some LONG and REAL properties also have text.

DCAM-API defines the following flags
Type ID
MODE DCAMPROP_TYPE_MODE
LONG DCAMPROP_TYPE_LONG
REAL DCAMPROP_TYPE_REAL

The application can distinguish each value type with DCAMPROP_TYPE_MASK from the attribute member of DCAMPROP_ATTR structure. The application can also distinguish which property has the value text by using the DCAMPROP_ATTR_HASVALUETEXT flag.

For example,
DCAM_IDPROP_BINNING property is DCAMPROP_TYPE_MODE.
DCAM_IDPROP_TRIGGERTIMES property is DCAMPROP_TYPE_LONG.
DCAM_IDPROP_EXPOSURETIME property is DCAMPROP_TYPE_REAL.

Every property value on the device is associated with one of these three types. However, the property value type maybe changed in a future version of DCAM-API. The application should not assume the property value type and it should check the attribute member of DCAMPROP_ATTR structure for the value type to ensure compatibility.
The application can check the default value and range of each property. These are also included in DCAMPROP_ATTR structure.

Attributes
Each property has attributes. Each attribute indicates the characteristic of the property.

You can see following attributes in attribute member of DCAMPROP_ATTR structure.
Attribute Explanation
READABLE This value of this property can be read by the application.
WRITABLE The value of this property can be changed by the application.
AUTOROUNDING The property value will be changed if application does not set an accurate value. The module will usually round-up to the next valid value or round-down if the value is bigger than maximum. A MODE property wills never this attribute.
SETPPING_INCONSISTENT The stepping value of this property is not consistent throughout its range.
VOLATILE The value of this property may be changed manually and/or automatically by the device.
DATASTREAM Changing the value of this property will affect the data stream.
ACCESSREADY The value of this property may be read or changed during READY status. If the property does not have this attribute and you access it during BUSY state, DCAM returns the error DCAMERR_ACCESSDENY.
ACCESSBUSY The value of this property may be read or changed during BUSY state. If the property doesn't have this attribute and you access it during BUSY state, DCAM returns the error DCAMERR_ACCEESDENY.

You can see following attributes in attribute2 member of DCAMPROP_ATTR structure.
Attribute2 Explanation
ARRAYBASE Some parameters are plural. For example some cameras have some connector of output trigger, so each connector is set several parameters. DCAM calls such mechanism as ARRAY. The top of element in an ARRAY has ARRAYBASE flag.
ARRAYELEMENT When the property is one of element of ARRAY, it has ARRAYELEMENT flag.
INITIALIZEIMPROPER When the property isn't initialized on dcamdev_open, it has INITIALIZEIMPROPER flag. For example, the property to control temperature has.

The application can get these attributes by using the dcamprop_getattr() function with DCAMPROP_ATTR structure. DCAM-API defines following flags.

In attribute member,
Attribute ID
READABLE DCAMPROP_ATTR_READABLE
WRITABLE DCAMPROP_ATTR_WRITABLE
VOLATILE DCAMPROP_ATTR_VOLATILE
INFLUENTIAL DCAMPROP_ATTR_INFLUENTIAL
STEPPING_INCONSISTENT DCAMPROP_ATTR_STEPPING_INCONSISTENT
AUTOROUNDING DCAMPROP_ATTR_AUTOROUNDING
DATASTREAM DCAMPROP_ATTR_DATASTREAM
ACCESSREADY DCAMPROP_ATTR_ACCESSREADY
ACCESSBUSY DCAMPROP_ATTR_ACCESSBUSY

In attribute2 member,
Attribute2 ID
ARRAYBASE DCAMPROP_ATTR2_ARRAYBASE
ARRAYELLEMENT DCAMPROP_ATTR2_ARRAYELLEMENT
INITIALIZEIMPROPER DCAMPROP_ATTR2_INITIALIZEIMPROPER

Property attributes are usually independent from the device but some devices may have different attributes from others. The application should never assume that a property attribute is the same between different camera models. For example, DCAM_IDPROP_SENSORTEMPERATURETARGET is readable and writable in some cameras, but in other cameras, this property is read-only.

Property Group(TBD:future)
DCAM-API has many properties and this sometimes makes it hard to find out the properties which users want to control. This situation can also be a problem for the application developer.
DCAM-API categorizes all properties into several groups. Neither the application nor the user needs to regards for these property groups, but they can be useful to understand each property and their relationship. The property groups are especially useful for applications that use enumerating functions.
DCAM-API currently defines following groups and will expand this list when new devices with new property groups are developed.
Name ID
SENSOR MODE DCAMPROP_GROUP_SENSORMODE
TRIGGER DCAMPROP_GROUP_TRIGGER
MECHANICAL SHUTTER DCAMPROP_GROUP_MSHUTTER
EXPOSURE DCAMPROP_GROUP_EXPOSURE
LIGHT MODE DCAMPROP_GROUP_LIGHTMODE
SENSITIVITY DCAMPROP_GROUP_SENSITIVITY
SENSOR COOLER DCAMPROP_GROUP_SENSORCOOLER
READOUT SPEED DCAMPROP_GROUP_READOUTSPEED
READOUT AREA DCAMPROP_GROUP_READOUTAREA
CONTRAST ENHANCE DCAMPROP_GROUP_CONTRASTENHANCE
COLOR BALANCE DCAMPROP_GROUP_COLORBLANCE
ALU DCAMPROP_GROUP_ALU
FRAME BUNDLE DCAMPROP_GROUP_FRAMEBUNDLE
OUTPUT TRIGGER DCAMPROP_OUTPUTTRIGGER
TIMING INFORMATION DCAMPROP_GROUP_SYNCTIMING
IMAGE INFORMATON DCAMAPROP_GROUP_IMAGEINFO
SYSTEM DCAMPROP_GROUP_SYSTEM

Functions
There are eight functions for property. The dcamprop_getattr() function gives the information of a property with DCAMPROP_ATTR structure. The dcamprop_getvalue() and dcamprop_setvalue() functions get and set the value of the property. The dcamprop_setgetvalue() function sets a value then gets the actual value of property. The dcamprop_queryvalue() function can return the value without setting the property when the application sets the value. And also it can get the next and prior value from a value. The dcamprop_getnextid() function gives all property IDs that the device support. This can also enumerate properties that are updates with a property are changed. The dcamprop_getname() function gives the text of a property. And the dcamprop_getvaluetext() function with DCAMPROP_VALUETEXT structure gives the text of a specified value of property.

Go to top of this chapter


VALUE


Maximum, Minimum, Step and Default
Most properties have default values and value range limitations. The DCAMPROP_ATTR_HASRANGE flag in the attribute member of the DCAMPROP_ATTR structure indicates that valuemax and valuemin are valid member. The DCAMPROP_ATTR_HASSTEP flag indicates valuestep is a valid member and the DCAMPROP_ATTR_HASDEFAULT flag indicates value default is a valid member.
The valuemax and valuemin member determine the minimum and maximum values that the property can be set to. These values affect the range of the values that can be read and the range that the property can be set
The valuestep member is the value between two settable values. For example, if the property value can be set 3200 and 5100, the valuestep will be 1900.
The value default member indicates the value which is set at initialization.

Go to top of this chapter


ATTRIBUTE - BASIC


READABLE, WRITABLE, read-only, write-only
Every property has its own readable and/or writable attributes. These attributes are indicated by the DCAMRPOP_ATTR_READABLE and DCAMPROP_ATTR_WRITABLE flags in the attribute member of the DCAMPROP_ATTR structure.
If the attribute member has both DCAMPROP_ATTR_READABLE and DCAMPROP_ATTR_WRITABLE flags, the dcamprop_getvalue(), dcamprop_setvalue(), dcamprop_setgetvalue() and dcamprop_queryvalue() functions can be used with this property.
If the attribute member has only DCAMPROP_ATTR_READABLE flag, the property can use the dcamprop_getvalue() function.
If the attribute member has only DCAMPROP_ATTR_WRITABLE flag, the property can use the dcamprop_setvalue() function.

AUTOROUNDING
Some properties allow the application to set inaccurate values, for example DCAM_IDPROP_EXPOSURETIME. In these cases, the DCAM module automatically rounds up to the next available value. If the value is greater than the maximum value, the maximum value will be set. The dcamprop_getvalue() function can be called after setting an auto-rounding value to confirm the new value. The dcamprop_setgetvalue() function can also be used to set a new value and then get the actual set value the property was set to.
The dcamprop_queryvalue() function is also useful to get the actual set values without setting the new value.

STEPPING_INCONSISTENT
Some properties do not have a consistent stepping for its full range. In these cases, the application can get next or previous value by using the dcamprop_queryvalue() function. This function can return the next value without setting a new value. If the property does not have the AUTOROUNDING attribute, the application has to use an accurate value when setting a new value otherwise an error will be generated.
For example, some devices support DCAM_IDPROP_BINNING_HORZ and can be set to 1, 2, 4, or 8. The valuestep member of the DCAMPROP_ATTR structure is set to 1 even through 1 is not the stepping value throughout the binning value range. The value represents the minimum possible stepping throughout the range. The DCAMPROP_ATTR_STEPPING_INCONSISTENT flag is included in the attribute member to notify the application of this inconsistency.

VOLATILE
Some properties may be changed unexpectedly, e.g. DCAM_IDPROP_TRIGGERSOURCE. Some camera supports Start Trigger function that is set DCAMPROP_TRIGGERSOURCE__EXTERNAL as DCAM_IDPROP_TRIGGERSOUCE and DCAMPROP_TRIGGER_MODE__START as DCAM_IDPROP_TRIGGER_MODE. On this mode, the camera changes to Internal mode when the camera receives the trigger. The DCAM_IDPROP_TRIGGERSOURCE property will be DCAMPROP_TRIGGERSOURCE__INTERNAL automatically.
DCAM-API currently has no way to notify when this happens so the application should use care when using VOLATILE properties.

DATASTREAM
Some properties affect the data stream e.g. DCAM_IDPROP_BINNING, DCAM_IDPROP_SUBARRAYMODE, DCAM_IDPROP_BITSPERCHANNEL, etc. Any property that affects the data stream will likely change the data size and/or type. Be sure to check these values after changing these properties.

ACCESSREADY
Some properties cannot be accessed during READY state, e.g. DCAM_IDPROP_BINNING, DCAM_IDPROP_SUBARRAYMODE, DCAM_IDPROP_BITSPERCHANNEL, etc. A property with the ACCESSREADY flag can be read or changed during READY state. If the application attempts to access properties that do not have the ACCESSREADY flag during READY state, DCAM will return a DCAMERR_ACCESSDENY error.

ACCESSBUSY
Some properties cannot be accessed during BUSY state, e.g. DCAM_IDPROP_SYSTEM_ALIVE. A property with the ACCESSBUSY flag can be read or changed during BUSY state. If the application attempts to access properties that do not have the ACCESSBUSY flag during BUSY state, DCAM will return a DCAMERR_ACCESSDENY error.

Go to top of this chapter


ATTRIBUTE - ADVANCED


UPDATED
Some properties may be changed when other properties are changed. For example, DCAM_IDPROP_EXPOSURETIME may be changed when DCAM_IDPROP_BINNING is changed. In this case, the application would have to check the value if necessary, but this kind of relation is different between each devices. So DCAM-API provides how to enumerate the updated properties.
This flag will be set not only minimum, maximum, step, attributes and so on.
See Sample - Enumerate value of UPDATED properties.

CHANNEL
Properties with this feature have DCAMPROP_ATTR_HASCHANNEL attributes of the property. Originally, the concept of channels was created to get, set, and inquire about the values of parameters controlled by each RGB of the color camera. The specification has now been extended and is also used to control each condition with a camera that retrieves images under different conditions at once. Properties related to the low energy, high energy and confocal microscope sub-units of dual energy cameras are covered. Because the number of channels varies from camera to camera, the number of channels is obtained from the nMaxChannel or Property DCAM_IDPROP_NUMBEROF_CHANNEL of the attribute structure. An example of how to control a channel is a color camera that is easy to image. For color cameras, RGB is assigned to channels 1, 2, and 3.

dcamprop_setvalue( hdcam, DCAM_IDPROP_EXPOSURETIME + 1 * DCAM_IDPROP__CHANNEL, r ); // red channel
dcamprop_setvalue( hdcam, DCAM_IDPROP_EXPOSURETIME + 2 * DCAM_IDPROP__CHANNEL, g ); // green channel
dcamprop_setvalue( hdcam, DCAM_IDPROP_EXPOSURETIME + 3 * DCAM_IDPROP__CHANNEL, b ); // blue channel

If you access Property with a BASE ID, the target is all channels. If you set a value, you set the same value for all channels, and if you get a value, you check the value of all channels. When it comes to retrieving values, you cannot return values unless the values of all channels are the same, so if the values are different DCAMERR_CHANNELDEPENDENTVALUE returns a different error.
Color cameras have a set of image formats, but dual energy cameras and confocal microscopes do not have a set image format, and data is output by element. The angle of view information returned by DCAM shows the entire image data, and some angle of view-related properties also have a channel function so that you can access the data for each element. Typically, GENERAL IDs and CHANNEL IDs do not change property attributes, but they are different and are flagged as DCAMPROP_ATTR2_CHANNELSEPARATEDDATA special channel properties. Also, for some cameras, you can control the on/off of the output for each element's data, so properties that would not normally be 0, such as DCAM_IDPROP_IMAGE_WIDTH, may return 0 for channel IDs. Here is an example with a confocal microscope to explain how to return a value. The figure below shows the image of four sub-units when the output of the second sub-unit is turned off.
The image by each sub-unit is side-by-side, and in the property that returns the angle of view information, DCAM_IDPROP_IMAGE_WIDTH and DCAM_IDPROP_IMAGE_TOPOFFSETBYTES are flagged as CHANNELSEPARATEDDATA, and the following values are returned.
DCAM_IDPROP_IMAGE_WIDTH Min Max Value
BASE ID any(>0) Sensor Size * 4 Sensor Size * 3
CHANNEL1 ID 0 Sensor Size Sensor Size
CHANNEL2 ID 0 Sensor Size 0
CHANNEL3 ID 0 Sensor Size Sensor Size
CHANNEL4 ID 0 Sensor Size Sensor Size

DCAM_IDPROP_IMAGE_TOPOFFSETBYTES Min Max Value
BASE ID any(>0) Sensor Size * 4 * Pixel Bytes 0
CHANNEL1 ID 0 Sensor Size * 1 * Pixel Bytes 0
CHANNEL2 ID 0 Sensor Size * 2 * Pixel Bytes 0
CHANNEL3 ID 0 Sensor Size * 3 * Pixel Bytes Sensor Size * 1 * Pixel Bytes
CHANNEL4 ID 0 Sensor Size * 4 * Pixel Bytes Sensor Size * 2 * Pixel Bytes

VIEW
DCAM-API defines the word VIEW which represents the image area that is able to set the individual timing. If the device has more than one image area, DCAM_IDPROP_NUMBEROF_VIEW will have the value of number of image area available.
The application can control individual views similar to how it controls individual channels. If the device has both multiple channels and views, the channel has priority and the index is packed. The following are theoretical examples.

Sample. ORCA-Flash 4.0 V3 has dual image area when the sensor mode is SPLITVIEW.
DCAM_IDPROP_EXPOSURETIME
This controls all exposure time
DCAM_IDPROP_EXPOSURETIME + DCAM_IDPROP__VIEW * 1
This controls exposure time of first image area
DCAM_IDPROP_EXPOSURETIME + DCAM_IDPROP__VIEW * 2
This controls exposure time of second image area

When setting new value, VIEW IDs are superior to PLANE IDs, CHANNELD IDs area superior VIEW IDs, and GENERAL IDs are superior to VIEW IDs. Following table is a sample sequence of setting and result.
Property ID to set Value View1 View2
Before setting - n/a n/a
DCAM_IDPROP_EXPOSURETIME 0.11 0.11 0.11
DCAM_IDPROP_EXPOSURETIME + DCAM_IDPROP__VIEW * 1 0.12 0.12 0.11
DCAM_IDPROP_EXPOSURETIME + DCAM_IDPROP__VIEW * 2 0.13 0.12 0.13
DCAM_IDPROP_EXPOSURETIME 0.14 0.14 0.14

ARRAY
Some devices have plural similar parameters. For example, output trigger parameters are possible to set for each connector. These parameters are, KIND, DELAY, PERIOD, etc. And there is a property which indicates the number of enable connector. DCAM calls such mechanism as ARRAY.
DCAM calls each member of the property of ARRAY as ELEMENT. The property id of ELEMENT can be calculated by following equation.

iProp_ArrayBase + iPropStep_Element * N

iProp_ArrayBase and iPropStep_Element are the member of DCAMPROP_ATTR structure. You can get these values by the dcamprop_getattr() function.
And you can get the property id which is ARRAYBASE by the dcamprop_getnextid() function but not which has only ELEMENT attribute.
The property which indicates the number of enabled ELEMENT, it has HASARRAY attribute. This property should have READABLE attribute at least. If the device can control this number, this property also has WRIABLE attribute.

INITIALIZE IMPROPER
Almost properties are initialized which default value at dcamdev_open() function. But there are some exceptions. For example, sensor cooling parameters are not changed because come devices require a few minutes to reach stable sensor temperature. The DCAM application should not set values into these properties unconsciously.
To know which one is so, DCAMPROP_ATTR2_INITIALIZEIMPROPER is defined. This value is set in attribute2 member in DCAMPROP_ATTR structure. We recommend your application checks this flag and if exist, does not set any value unconsciously.

Go to top of this chapter


FUNCTION


Value text
Some properties have text for each value of property. All MODE properties and some LONG and REAL properties use text for each value. These properties have the DCAMPROP_ATTR_HASVALUETEXT flag in the attribute member of DCAMPROP_ATTR structure.

See Sample - Enumerate Value Text

Enumeration
An application program generally would use fixed properties. However, some applications would want to support every available property for each device even if the details of the properties are unknown.
DCAM-API provides the functionality to dynamically determine all of the supported properties for applications that require this level of control. The dcamprop_getnextid() function provides the way to enumerate all supported, updated and/or volatile property IDs. It can also enumerate all property IDs that it may be affected before changing the property value.
These are two enumeration methods. The first method is used for enumeration of supported, updated or volatile properties. You call the dcamprop_getnextid() function with property ID 0 with the option DCAMPROP_OPTION_SUPPORT, DCAMPROP_OPTION_UPDATED or DCAMPROP_OPTION_VOLATILE. This function will return with the next property ID you requested. If the dcamprop_getnextid() function fails or return 0 property, then there are no more property IDs.
The other enumeration method is used for influential and alternative properties. This method uses a loop with DCAMPROP_OPTION_NEXT multiplied by index. In the loop, you have to set original property ID before calling the dcamprop_getnextid() function every time.

Please see following samples
Enumerate supported properties
Enumerate value of VOLATILE properties
Enumerate value of UPDATED properties
Enumerate value of INFLUENTIAL properties

Go to top of this chapter


PROPERTY GROUP


Trigger properties
Trigger properties control the synchronization for capturing images.
The trigger source can be set by the DCAM_IDPROP_TRIGGERSOURCE property. DCAMPROP_TRIGGERSOURCE__INTERNAL refers to the camera free-run mode. Setting the source to DCAMPROP_TRIGGERSOURCE__EXTERNAL allows you to set synchronization from an external trigger source. DCAMPROP_TRIGGERSOURCE__SOFTWARE refers to a third mode where the application can fire the trigger from the software to control synchronization.
There are three types of triggers: Edge, Level, and Syncreadout. In Edge trigger mode, the trigger timing specifies the beginning of an exposure. In Level trigger mode, the device uses the trigger active period to determine the length of the exposure. In Syncreadout trigger mode, the active period is the time between two or more triggers. These trigger types can be selected using the DCAM_IDPROP_TRIGGERACTIVE property.
The DCAM_IDPROP_TRIGGERPOLARITY property can be used to choose the active level of an external trigger. The DCAM_IDPROP_TRIGGER_CONNECTOR property can be used to choose the external trigger input connector.
HAMAMATSU prepares several trigger modes. The DCAM_IDPROP_TRIGGER_MODE property can be used to choose following modes.

NORMAL DCAMPROP_TRIGGER_MODE__NORMAL
PIV DCAMPROP_TRIGGER_MODE__PIV
START DCAMPROP_TRIGGER_MODE__START: In this mode, the device waits a trigger and after detecting of the trigger, the device will run as Internal Trigger mode but this property keeps "START" value.

The DCAM_IDPROP_TRIGGERTIMES property that is necessary for some modes.

TRIGGER SOURCE Internal Software External
TRIGGER ACTIVE - Edge Level Pulse Edge Level Pulse
TRIGGER MODE NORMAL OK OK OK Few OK OK Few
PIV NG OK None None OK None None
START NG OK NG NG OK NG NG
OK: The combination is supported.
NG: The combination is not defined in DCAM-API
Few: The combination is defined but a few cameras support.
None: The combination can be defined but no cameras support it.

Advanced Trigger properties
DCAM supports not only GLOBAL SHUTTER sensor but also ROLLING SHUTTER one. GLOBAL SHUTTER means the timing of starting and stopping EXPOSURE for all sensor pixels are same timing. ROLLING SHUTTER means the timing is vertically rolling. CCD always has GLOBAL SHUTTER. Some CMOS sensors have both timing and others only have ROLLING SHUTTER.
When a camera with ROLLING SHUTTER type of sensor supports trigger mode, a trigger can start EXPOSURE or READOUT but it is for the top line on the sensor. The timing for second and lower lines is following. So if you set EDGE trigger mode, then fire a trigger, the top line will start soon but the bottom line will start with one frame reading out time delay. DCAM_IDPROP_TRIGGER_GLOBALEXPOSURE indicates this difference between GLOBAL and ROLLING SHUTTER type. If the sensor is running with GLOBAL SHUTTER, the value is DCAMPROP_TRIGGER_GLOBALEXPOSURE__ALWAYS and in case of ROLLING, the value is DCAMPROP_TRIGGER_GLOBALEXPOSURE__DELAYED.
You can know when GLOBAL EXPOSURE starts on ROLLING SHUTTER type of sensor with DCAM_IDPROP_TIMING_GLOBALEXPOSUREDELAY. The value unit is second.
On the other hand, some camera supports advanced trigger feature. When you choose this mode, camera is running in fastest speed internally and remembers the last image. When a trigger comes, then stops reading after current frame, and starts reading again after user selected time, then output data with summing these two readouts. In this case, the output data include the exposure before coming trigger, but surely all pixels are exposed from trigger coming timing. So if you are using a camera with a strobe then this feature is useful. DCAM calls this functionality as GLOBAL EXPOSURE EMULATION. To choose this mode, you set DCAMPROP_TRIGGER_GLOBALEXPOSURE__EMULATE to DCAM_IDPROP_TRIGGER_GLOBALEXPOSURE.
And one more thing this situation can also happen in SYNCREADOUT and START trigger mode. From the specification, GLOBAL EXPOSURE EMULATION is not useful. Therefore DCAM_IDPROP_TRIGGER_GLOBALEXPOSURE is not EFFECTIVE in these trigger mode. But the first trigger is not different from others. In case of SYNCREADOUT trigger mode, usually the first trigger will abandon exposure before trigger. But user may want to get the image exposed between dcamcap_start() to the first trigger. To get such image, DCAM_IDPROP_FIRSTTRIGGER_BEHAVIOR is defined. When this value is DCAMPROP_FIRSTTRIGGER_BEHAVIOR__STARTEXPOSE, the camera starts EXPOSURE, and it is DCAMPROP_FIRSTTRIGGER_BEHAVIOR__STARTREADOUT, camera starts READOUT by the first trigger. This property is also EFFECTIVE for START trigger mode if the camera supports.
Above two properties are optional so you can set them independently from other trigger properties. These two properties automatically become EFFECTIVE.

Exposure time properties
The DCAM_IDPROP_EXPOSURETIME property controls exposure time of the camera. For cameras that have multiple channels, the exposure for each channel can be controlled individually with DCAM_IDPROP__CHANNEL. See CHANNEL chapter.

Anti-blooming properties
Some device supports the ability to enable and disable anti-blooming. It can be controlled using the DCAM_IDPROP_LIGHTMODE property. When set to DCAMPROP_LIGHTMODE__HIGHLIGHT, the anti-blooming function is enabled. When it is DCAMPROP_LIGHTMODE__LOWLIGHT, anti-blooming function is disabled.

Sensitivity properties
The DCAM_IDPROP_SENSITIVITY property can refer to the amplifier on the image sensor. EM-CCD camera has the capability to control the amplifier on the image sensor.
DCAM_IDPROP_PHOTONIMAGING is another sensitivity property that is useful in low light imaging.

Sensor temperature properties
HPK provides many types of cooled CCD cameras. These include air-cooled, water-cooled, liquid nitrogen cooled, etc. The DCAM_IDPROP_SENSORCOOLER property can enable or disable the cooler function. The default value will vary for each cooling system so this value should be checked at initialization. Some cameras support the DCAM_IDPROP_SENSORTEMPERATURE property that reports the current temperature of the image sensor. This property is read-only. Some cameras support the DCAM_IDPROP_SENSORTEMPERATURETARGET property that controls the target temperature of cooling. These properties are supported by many HAMAMATSU cameras however if a digital camera supports one of these temperature properties, that does not guarantee the camera will support any of the other temperature properties.

Contrast enhancement properties
There are two major properties for contrast enhancement. One is DCAM_IDPROP_CONTRASTGAIN and the other is DCAM_IDPROP_CONTRASTOFFSET. Some devices may have the VOLATILE attribute associated with these properties. Color cameras also support CHANNEL if it is controllable individually.

ALU properties
Some cameras support ALU functionality. The "Recursive" function, sometimes called "averaging", is controlled by the DCAM_IDPROP_RECURSIVEFILTER property. When this property is OFF, the output data will be raw. When this property is ON, the output data will be averaged in the number of frames which is specified by DCAM_IDPROP_RECURSIVEFILTERFRAMES property.
The "Spot Noise Reducer" function is controlled by DCAM_IDPROP_SPOTNOISEREDUCER property. When this property is ON, the "Spot noise" which is produced on the sensor will be reduced but intensity is also darker than normal output.
The "Subtract" function is controlled by the DCAM_IDPROP_SUBTRACT property. When this property is OFF, the output data will be raw. When this property is ON, the output data is subtracted. The subtractive image is captured by the setting the DCAM_IDPROP_STORESUBTRACTIMAGETOMEMORY property. This property is write-only.

Data Reduction properties
Some cameras support function to reduce data size that camera outputs. The camera encodes the data by selected method. DCAM returns the decoded data when the application calls DCAM function to get image data. DCAM recording function records the encoded data, so recorded data size is smaller. Some camera outputs faster too.

Output Trigger properties
Some cameras can output several trigger. You can select trigger kind by DCAM_IDPROP_OUTPUTTRIGER_KIND. When the camera outputs pulse, the polarity is set by DCAM_IDPROP_OUTPUTTRIGGER_POLARITY. When you select DCAMPROP_OUTPUTTRIGGER_KIND__PROGRAMABLE, you can control the pulse by the following properties.
DCAM_IDPROP_OUTPUTTRIGGER_SOURCE Basic timing of programmable trigger.
DCAM_IDPROP_OUTPUTTRIGGER_ACTIVE Trigger shape.
DCAM_IDPROP_OUTPUTTRIGGER_DELAY Delay of output trigger when trigger shape is "EDGE".
DCAM_IDPROP_OUTPUTTRIGGER_PERIOD Width of output triggers pulse when trigger shape is "EDGE".

Master Pulse properties
Some cameras have master pulse function to synchronize other device. When you set DCAMPROP_TRIGGERSOURCE__MASTERPULSE to DCAM_IDPROP_TRIGGERSOURCE, the camera makes pulses and uses it as external trigger. You can get the timing of trigger the camera receives from output trigger when output trigger is programmable trigger and output trigger source is trigger. You can select mode from 3 mode is Continuous, Start and Burst. Continuous is that master pulse outputs continuously at the start of capturing. Other mode is that master pulse outputs from received trigger that you set by DCAM_IDPROP_MASTERPULSE_TRIGGERSOURCE. Start outputs continuously. Burst stops after output the number of times you set by DCAM_IDPROP_MASTERPULSE_BURSTTIMES and waits next trigger.

Readout properties
Some cameras have some readout modes. The DCAM_IDPROP_READOUTSPEED property can control the readout speed. If the application sets the readout with DCAMPROP_READOUTSPEED__SLOWEST, the readout speed will be set to the slowest readout mode. If the application sets the readout with DCAMPROP_REASOUTSPEED__FASTEST, the readout speed will be set to the fastest readout mode. The readout value after changing this value will be different. This value will be the actual value for the digital camera.

Binning and sub-array properties
The DCAM_IDPROP_BINNING property is used to control the binning of the camera. This MODE value determines the horizontal and vertical binning sizes that are set. Some devices also support independent binning mode. The DCAM_IDPROP_BINNING_HORZ property controls the horizontal binning while the DCAM_IDPROP_BINNING_VERT property controls the vertical binning. The DCAM_IDPROP_BINNING_INDEPENDENT property must be set ON in order for independent binning values to be used.
Four properties are used to control subarray:
The DCAM_IDPROP_SUBARRAYHPOS property controls the horizontal offset.
The DCAM_IDPROP_SUBARRAYHSIZE property controls the horizontal size.
The DCAM_IDPROP_SUBARRAYVPOS property controls the vertical offset.
The DCAM_IDPROP_SUBARRAYVSIZE property controls the vertical size.
The DCAM_IDPROP_SUBARRAYHPOS and DCAM_IDPROP_SUBARRAYVPOS properties can be changed during any state including BUSY status as they do not affect the data stream. The DCAM_IDPROP_SUBARRAYHSIZE and DCAM_IDPROP_SUBARRAYVSIZE properties can only the changed during UNSTABLE or STABLE state. These values are specified by sensor pixel unit therefore properties such as binning will not affect this value.
When setting subarray, there are two rules. The DCAM_IDPROP_SUBARRAYHPOS value plus the DCAM_IDPROP_SUBARRAYHSIZE value must be equal or smaller than the horizontal sensor size. And the DCAM_IDPROP_SUBARRAYVPOS value plus the DCAM_IDPROP_SUBARRAYVSIZE value must be equal or smaller than vertical sensor size.
If the DCAM_IDPROP_SUBARRAYMODE property is OFF, these rules are not checked when changing each value. However, these rules are checked when the DCAM_IDPROP_SUBARRAYMODE is set to ON. If these properties break these rules, dcamprop_setvalue(DCAM_IDPROP_SUBARRAYMODE) fails.

Timing information properties
The DCAM_IDPROP_TIMING_READOUTTIME property gives the duration time of the frame readout. DCAM_IDPROP_INTERNAL_FRAMEINTERVAL property gives the duration time between two frame starts.
The DCAM_IDPROP_TIMING_CYCLICTRIGGERPERIOD property gives the time after and of readout that the camera works cyclic trigger in external or software trigger mode. If the next trigger is later than this cyclic trigger period, the trigger works immediately. But if the next trigger is during this period, the trigger will have jitter and cam overlap exposure to readout.
The DCAM_IDPROP_TIMING_MINTRIGGERBLANKING property gives the minimum period between frame readout end and next valid trigger.

Tc is DCAM_IDPROP_TIMING_CYCLICTRIGGERPERIOD.
MinTB is DCAM_IDPROP_TIMING_MINTRIGGERBLANKING.
Tx is next exposure time.
Ti is trigger interval.
Tb is trigger blanking period. It is from end of previous exposure to next trigger.

Following condition has to be approved.
// Ti=Tx+Tb. //This is a definition
if( Tx<Tc )
{
(Tb>Tc-Tx)AND(Tb>=MinTB)
}
else
{
Tb>=MinTB
}

Output data type properties
The application can choose output data format with the DCAM_IDPROP_IMAGE_PIXELTYPE property. This value can be one of DCAM_PIXELTYPE values. For example, DCAM_PIXELTYPE_MONO16 means B/W and 2 bytes per pixel, DCAM_PIXELTYPE_RGB24 means RGB and 3 bytes per pixel.
Depending on the digital camera, the application can get bits per channel information and set a new value if camera supports. The values are predefined from DCAMPROP_BITSPERCHANNEL__8 to DCAMPROP_BITSPERCHANNEL__16.

Frame bundle properties
"Frame bundle" is a way to pack the output image data from the camera to reduce the number of EXPOSUREEND, TRANSFERRED and FRAMEREADY events during capture. This is useful when events are occurring faster than the computer can process and the application cannot lose any frames.
The DCAM_IDPROP_FRAMEBUNDLE_MODE property enables or disable frame bundle mode. The DCAM_IDPROP_FRAMEBUNDLR_NUMBER property specifies how may frames are bundled.
Frame bundle mode may include the dummy data in either horizontal or vertical or both. The application can get the actual row bytes by DCAM_IDPROP_FRAMEBUNDLE_ROWBYTES and the offset bytes of next frame by DCAM_IDPROP_FRAMEBUNDLE_FRAMESTEPBYTES.

System properties
Some cameras support the DCAM_IDPROP_SYSTEM_ALIVE property. This is useful to check the status of camera connection. However, this may access the camera, so frequent access may affect the capturing.

Go to top of this chapter


TECHNOLOGY


SENSOR MODE TDI
When using TDI mode, the application needs to set several properties. The most common mode is when the TDI is synchronized to the trigger pulse. For this mode, DCAM_IDPROP_SENSORMODE should be DCAMPROP_SENSORMODE__TDI or DCAMPROP_SENSORMODE__TDI_EXTENDED. If the TDI can control the exposure time from trigger timing, DCAM_IDPROP_TROGGERSOURCE should be DCAMPROP_TRIGGERSOURCE__EXTERNAL. Both modes should set DCAMPROP_TRIGGER_MODE__TDI to DCAM_IDPROP_TRIGGER_MODE.
In TDI mode, the camera outputs the image the same way as line sensor camera but the line rate is usually too high to capture each line into PC. So the application must set the number of bundle lines by DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT and access to line bundled image.

Go to top of this chapter


PROPERTY REFERENCE


Sensor mode

DCAM_IDPROP_SENSORMODE

R/W MODE

DCAM_IDPROP_SENSORMODE_LINEBUNDLEHEIGHT

R/W LONG

DCAM_IDPROP_SENSORMODE_PANORAMICSTARTV

R/W LONG

DCAM_IDPROP_SENSORMODE_TDISTAGE

R/W LONG

DCAM_IDPROP_CCDMODE

R/W MODE

DCAM_IDPROP_EMCCD_CALIBRATIONMODE

R/W MODE
Readout Speed

DCAM_IDPROP_READOUTSPEED

R/W LONG

DCAM_IDPROP_READOUT_DIRECTION

R/W MODE
Shutter Mode

DCAM_IDPROP_SHUTTER_MODE

R/W MODE
Trigger

DCAM_IDPROP_FIRSTTRIGGER_BEHAVIOR

R/W MODE

DCAM_IDPROP_SYNCREADOUT_SYSTEMBLANK

R/W MODE

DCAM_IDPROP_TRIGGER_FIRSTEXPOSURE

R/W MODE

DCAM_IDPROP_TRIGGERSOURCE

R/W MODE

DCAM_IDPROP_TRIGGER_MODE

R/W MODE

DCAM_IDPROP_TRIGGERDELAY

R/W SECOND

DCAM_IDPROP_TRIGGERACTIVE

R/W MODE

DCAM_IDPROP_TRIGGER_GLOBALEXPOSURE

R/W MODE

DCAM_IDPROP_TRIGGERPOLARITY

R/W MODE

DCAM_IDPROP_TRIGGERTIMES

R/W LONG

DCAM_IDPROP_TRIGGER_CONNECTOR

R/W MODE

DCAM_IDPROP_INTERNALTRIGGER_HANDLING

R/W MODE

DCAM_IDPROP_TRIGGERENABLE_ACTIVE

R/W MODE

DCAM_IDPROP_TRIGGERENABLE_POLARITY

R/W MODE

DCAM_IDPROP_TRIGGERENABLE_SOURCE

R/W MODE

DCAM_IDPROP_TRIGGERENABLE_BURSTTIMES

R/W LONG
Sensor cooler

DCAM_IDPROP_SENSORCOOLER

R/W MODE

DCAM_IDPROP_SENSORTEMPERATURE

R/O REAL, Celsius

DCAM_IDPROP_SENSORTEMPERATURETARGET

R/W REAL, Celsius

DCAM_IDPROP_SENSORCOOLERFAN

R/W MODE

DCAM_IDPROP_SENSORCOOLERSTATUS

R/O MODE
Sensitivity

DCAM_IDPROP_SENSITIVITY

R/W REAL, LONG

DCAM_IDPROP_SENSITIVITYMODE

R/W MODE

DCAM_IDPROP_DIRECTEMGAIN_MODE

R/W MODE

DCAM_IDPROP_EMGAINPROTECT_MODE

R/W MODE

DCAM_IDPROP_EMGAINPROTECT_AFTERFRAMES

R/W LONG

DCAM_IDPROP_EMGAINWARNING_ALARM

R/W MODE

DCAM_IDPROP_EMGAINWARNING_LEVEL

R/W LONG

DCAM_IDPROP_EMGAINWARNING_STATUS

R/O MODE

DCAM_IDPROP_PHOTONIMAGINGMODE

R/W MODE

DCAM_IDPROP_MEASURED_SENSITIVITY

R/O REAL
Feature

DCAM_IDPROP_LIGHTMODE

R/W MODE

DCAM_IDPROP_EXPOSURETIME

R/W REAL, SECOND

DCAM_IDPROP_EXPOSURETIME_CONTROL

R/W MODE

DCAM_IDPROP_CONTRASTGAIN

R/W REAL, LONG

DCAM_IDPROP_CONTRASTOFFSET

R/W LONG

DCAM_IDPROP_DIRECTGAIN_MODE

R/W LONG
Contrast enhance

DCAM_IDPROP_HIGHDYNAMICRANGE_MODE

R/W MODE
Binning and subarray

DCAM_IDPROP_BINNING

R/W MODE

DCAM_IDPROP_BINNING_HORZ

R/W LONG

DCAM_IDPROP_BINNING_INDEPENDENT

R/W MODE

DCAM_IDPROP_BINNING_VERT

R/W LONG

DCAM_IDPROP_SUBARRAYHPOS

R/W LONG

DCAM_IDPROP_SUBARRAYHSIZE

R/W LONG

DCAM_IDPROP_SUBARRAYVPOS

R/W LONG

DCAM_IDPROP_SUBARRAYVSIZE

R/W LONG

DCAM_IDPROP_SUBARRAYMODE

R/W MODE

DCAM_IDPROP_DIGITALBINNING_METHOD

R/W MODE

DCAM_IDPROP_DIGITALBINNING_HORZ

R/W LONG
ALU

DCAM_IDPROP_CAPTUREMODE

R/W MODE

DCAM_IDPROP_SUBTRACT

R/W MODE

DCAM_IDPROP_SUBTRACTOFFSET

R/W LONG

DCAM_IDPROP_SUBTRACTIMAGEMEMORY

R/W MODE

DCAM_IDPROP_STORESUBTRACTIMAGETOMEMORY

W/O MODE

DCAM_IDPROP_SHADINGCORRECTION

R/W MODE

DCAM_IDPROP_SHADINGCALIBDATAMEMORY

R/W MODE

DCAM_IDPROP_STORESHADINGCALIBDATATOMEMORY

W/O MODE

DCAM_IDPROP_SPOTNOISEREDUCER

R/W MODE

DCAM_IDPROP_RECURSIVEFILTER

R/W MODE

DCAM_IDPROP_RECURSIVEFILTERFRAMES

R/W LONG

DCAM_IDPROP_INTERFRAMEALU_ENABLE

R/W MODE

DCAM_IDPROP_FRAMEAVERAGINGMODE

R/W MODE

DCAM_IDPROP_FRAMEAVERAGINGFRAMES

R/W LONG

DCAM_IDPROP_INTENSITYLUT_MODE

R/W MODE

DCAM_IDPROP_INTENSITYLUT_BLACKCLIP

R/W LONG

DCAM_IDPROP_INTENSITYLUT_WHITECLIP

R/W LONG

DCAM_IDPROP_INTENSITYLUT_PAGE

R/W LONG
Calibration and correction

DCAM_IDPROP_DARKCALIB_STABLEMAXINTENSITY

R/W LONG

DCAM_IDPROP_DARKCALIB_STABLESAMPLES

R/W LONG

DCAM_IDPROP_DARKCALIB_SAMPLES

R/W LONG

DCAM_IDPROP_SHADINGCALIB_STABLEMININTENSITY

R/W LONG

DCAM_IDPROP_SHADINGCALIB_STABLEMAXERRORPERCENT

R/W LONG

DCAM_IDPROP_SHADINGCALIB_STABLESAMPLES

R/W LONG

DCAM_IDPROP_SHADINGCALIB_SAMPLES

R/W LONG

DCAM_IDPROP_SHADINGCALIB_METHOD

R/W MODE

DCAM_IDPROP_SHADINGCALIB_TARGET

R/W LONG

DCAM_IDPROP_TAPCALIB_BASEDATAMEMORY

R/W MODE

DCAM_IDPROP_STORETAPCALIBDATATOMEMORY

W/O MODE

DCAM_IDPROP_TAPCALIBDATAMEMORY

W/O MODE

DCAM_IDPROP_TAPCALIB_GAIN

R/W MODE

DCAM_IDPROP_TAPGAINCALIB_METHOD

R/W MODE

DCAM_IDPROP_TESTPATTERN_KIND

R/W MODE

DCAM_IDPROP_TESTPATTERN_OPTION

W/O MODE

DCAM_IDPROP_BURIEDDATA_MODE

R/W MODE

DCAM_IDPROP_NUMBEROF_TAPCALIB

R/W LONG

DCAM_IDPROP_CALIBREGION_MODE

R/W MODE [ARRAY]

DCAM_IDPROP_CALIBREGION_HPOS

R/W LONG [ARRAY]

DCAM_IDPROP_CALIBREGION_HSIZE

R/W LONG [ARRAY]

DCAM_IDPROP_NUMBEROF_CALIBREGION

R/W LONG

DCAM_IDPROP_MASKREGION_HPOS

R/W LONG [ARRAY]

DCAM_IDPROP_MASKREGION_HSIZE

R/W LONG [ARRAY]

DCAM_IDPROP_NUMBEROF_MASKREGION

R/W LONG

DCAM_IDPROP_DEFECTCORRECT_HPOS

R/W LONG [ARRAY]

DCAM_IDPROP_DEFECTCORRECT_METHOD

R/W MODE [ARRAY]

DCAM_IDPROP_DEFECTCORRECT_MODE

R/W MODE

DCAM_IDPROP_NUMBEROF_DEFECTCORRECT

R/W LONG

DCAM_IDPROP_HOTPIXELCORRECT_LEVEL

R/W MODE
Output intensity

DCAM_IDPROP_OUTPUT_INTENSITY

R/W MODE
Data Reduction

DCAM_IDPROP_EXTRACTION_MODE

R/W MODE 4.0
Output Trigger

DCAM_IDPROP_NUMBEROF_OUTPUTTRIGGERCONNECTOR

R/O LONG

DCAM_IDPROP_OUTPUTTRIGGER_KIND

R/W MODE

DCAM_IDPROP_OUTPUTTRIGGER_SOURCE

R/W MODE

DCAM_IDPROP_OUTPUTTRIGGER_POLARITY

R/W MODE

DCAM_IDPROP_OUTPUTTRIGGER_ACTIVE

R/W MODE

DCAM_IDPROP_OUTPUTTRIGGER_DELAY

R/W REAL, SECOND

DCAM_IDPROP_OUTPUTTRIGGER_PERIOD

R/W REAL, SECOND

DCAM_IDPROP_OUTPUTTRIGGER_PREHSYNCCOUNT

R/W MODE

DCAM_IDPROP_OUTPUTTRIGGER_CHANNELSYNC

R/W MODE

DCAM_IDPROP_OUTPUTTRIGGER_PROGRAMABLESTART

R/W MODE

DCAM_IDPROP_OUTPUTTRIGGER_BASESENSOR

R/W MODE
Master Pulse

DCAM_IDPROP_MASTERPULSE_BURSTTIMES

R/W LONG

DCAM_IDPROP_MASTERPULSE_INTERVAL

R/W REAL, SECOND

DCAM_IDPROP_MASTERPULSE_MODE

R/W MODE

DCAM_IDPROP_MASTERPULSE_TRIGGERSOURCE

R/W MODE
Synchronous timing

DCAM_IDPROP_INTERNALFRAMERATE

R/W REAL, 1/SECOND

DCAM_IDPROP_INTERNALLINERATE

R/W REAL, 1/SECOND

DCAM_IDPROP_INTERNALLINESPEED

R/W REAL, METER/SECOND

DCAM_IDPROP_INTERNAL_FRAMEINTERVAL

R/W REAL, SECOND

DCAM_IDPROP_INTERNAL_LINEINTERVAL

R/W REAL, SECOND

DCAM_IDPROP_INTERNALLINERATE_CONTROL

R/W MODE

DCAM_IDPROP_TIMING_CYCLICTRIGGERPERIOD

R/O SECOND

DCAM_IDPROP_TIMING_EXPOSURE

R/O MODE

DCAM_IDPROP_TIMING_GLOBALEXPOSUREDELAY

R/O SECOND

DCAM_IDPROP_TIMING_INVALIDEXPOSUREPERIOD

R/O SECOND

DCAM_IDPROP_TIMING_MINTRIGGERBLANKING

R/O SECOND

DCAM_IDPROP_TIMING_MINTRIGGERINTERVAL

R/O SECOND

DCAM_IDPROP_TIMING_READOUTTIME

R/O SECOND
Frame bundle

DCAM_IDPROP_FRAMEBUNDLE_MODE

R/W MODE

DCAM_IDPROP_FRAMEBUNDLE_NUMBER

R/W LONG

DCAM_IDPROP_FRAMEBUNDLE_ROWBYTES

R/O LONG

DCAM_IDPROP_FRAMEBUNDLE_FRAMESTEPBYTES

R/O LONG
Device Buffer

DCAM_IDPROP_DEVICEBUFFER_MODE

R/W MODE

DCAM_IDPROP_DEVICEBUFFER_FRAMECOUNTMAX

R/O LONG
Camera status

DCAM_IDPROP_CAMERASTATUS_INPUTTRIGGER

R/O MODE

DCAM_IDPROP_CAMERASTATUS_INTENSITY

R/O MODE

DCAM_IDPROP_CAMERASTATUS_CALIBRATION

R/O MODE
System information

DCAM_IDPROP_COLORTYPE

R/O MODE

DCAM_IDPROP_BITSPERCHANNEL

R/W LONG

DCAM_IDPROP_BUFFER_ROWBYTES

R/O LONG 4.0

DCAM_IDPROP_BUFFER_FRAMEBYTES

R/O LONG 4.0

DCAM_IDPROP_BUFFER_TOPOFFSETBYTES

R/O LONG 4.0

DCAM_IDPROP_BUFFER_PIXELTYPE

R/O MODE 4.0

DCAM_IDPROP_CONVERSIONFACTOR_COEFF

R/O REAL

DCAM_IDPROP_CONVERSIONFACTOR_OFFSET

R/O REAL

DCAM_IDPROP_FRAMESTAMP_PRODUCER

R/O MODE 4.0

DCAM_IDPROP_IMAGEBLOCK_ACTUALXPOS

R/O LONG [ARRAY]

DCAM_IDPROP_IMAGEBLOCK_ACTUALXSIZE

R/O LONG [ARRAY]

DCAM_IDPROP_IMAGEBLOCK_ACTUALYPOS

R/O LONG [ARRAY]

DCAM_IDPROP_IMAGEBLOCK_ACTUALYSIZE

R/O LONG [ARRAY]

DCAM_IDPROP_IMAGEBLOCK_FIRSTBYTESOFFSET

R/O LONG [ARRAY]

DCAM_IDPROP_IMAGEBLOCK_OVERLAPLEFTSIZE

R/O LONG [ARRAY]

DCAM_IDPROP_IMAGEDETECTOR_PIXELHEIGHT

R/O REAL, Micro-meter 4.0

DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMHORZ

R/O LONG 4.0

DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMVERT

R/O LONG 4.0

DCAM_IDPROP_IMAGEDETECTOR_PIXELWIDTH

R/O REAL, Micro-meter 4.0

DCAM_IDPROP_IMAGE_CAMERASTAMP

R/W LONG 4.0

DCAM_IDPROP_IMAGE_FRAMEBYTES

R/O LONG

DCAM_IDPROP_IMAGE_WIDTH

R/O LONG

DCAM_IDPROP_IMAGE_HEIGHT

R/O LONG

DCAM_IDPROP_IMAGE_PIXELTYPE

R/W MODE

DCAM_IDPROP_IMAGE_ROWBYTES

R/O LONG

DCAM_IDPROP_IMAGE_TOPOFFSETBYTES

R/O LONG

DCAM_IDPROP_NUMBEROF_CHANNEL

R/O LONG

DCAM_IDPROP_NUMBEROF_IMAGEBLOCK

R/O LONG

DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES

R/W LONG

DCAM_IDPROP_PRIMARYBUFFER_TOTALBYTES_MB

R/W LONG

DCAM_IDPROP_RECORDFIXEDBYTES_PERFILE

R/O LONG 4.0

DCAM_IDPROP_RECORDFIXEDBYTES_PERSESSION

R/O LONG 4.0

DCAM_IDPROP_RECORDFIXEDBYTES_PERFRAME

R/O LONG 4.0

DCAM_IDPROP_NUMBEROF_VIEW

R/O LONG

DCAM_IDPROP_SYSTEM_ALIVE

R/O MODE

DCAM_IDPROP_TIMESTAMP_PRODUCER

R/O MODE 4.0

DCAM_IDPROP_BINNING
Genre
Binning and subarray
Read write mode
R/W
Type of value
MODE
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
Binning and subarray
Read write mode
R/W
Type of value
LONG
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
Genre
Binning and subarray
Read write mode
R/W
Type of value
MODE
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
Binning and subarray
Read write mode
R/W
Type of value
LONG
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
Genre
Readout
Read write mode
R/W
Type of value
LONG
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 (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
LONG
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 (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
MODE, DCAM_PIXELTYPE
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 (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
LONG
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 (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
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
Genre
Binning and ROI
Read write mode
R/W
Type of value
LONG [ARRAY]
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
Genre
Binning and ROI
Read write mode
R/W
Type of value
LONG [ARRAY]
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
Genre
Binning and ROI
Read write mode
R/W
Type of value
MODE
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.
This is an ARRAY.
Reference

DCAM_IDPROP_CAMERASTATUS_CALIBRATION
Genre
Camera Status
Read write mode
R/O
Type of value
MODE
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_INPUTTRIGGER
Genre
Camera Status
Read write mode
R/O
Type of value
MODE
Explanation
This property shows you current camera status about input trigger.
DCAMPROP_CAMERASTATUS_INPUTTRIGGER__GOOD
"GOOD" Input trigger is good.
DCAMPROP_CAMERASTATUS_INPUTTRIGGER__NONE
"NONE" No triggers come.
DCAMPROP_CAMERASTATUS_INPUTTRIGGER__TOOFREQUENT
"TOO FREQUENT" Too many triggers come in.
Reference

DCAM_IDPROP_CAMERASTATUS_INTENSITY
Genre
Camera Status
Read write mode
R/O
Type of value
MODE
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
Readout
Read write mode
R/W
Type of value
MODE
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
ALU
Read write mode
R/W
Type of value
MODE
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
System information
Read write mode
R/O
Type of value
MODE
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
Feature
Read write mode
R/W
Type of value
LONG
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
Genre
Feature
Read write mode
R/W
Type of value
LONG
Explanation
This property allows you to specify the contrast offset value.
Reference

DCAM_IDPROP_CONVERSIONFACTOR_COEFF
Genre
System information
Read write mode
R/O
Type of value
REAL
Explanation
This property returns coefficient value of current conversion factor.
Reference

DCAM_IDPROP_CONVERSIONFACTOR_OFFSET
Genre
System information
Read write mode
R/O
Type of value
REAL
Explanation
This property returns offset value of current conversion factor.
Reference

DCAM_IDPROP_DARKCALIB_SAMPLES
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG [ARRAY]
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE [ARRAY]
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
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
Genre
Device buffer
Read write mode
R/O
Type of value
LONG
Explanation
This property tells the maximum frame count the device can keep in device memory.
Reference

DCAM_IDPROP_DEVICEBUFFER_MODE
Genre
Device buffer
Read write mode
R/W
Type of value
MODE
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
Genre
Binning and ROI
Read write mode
R/W
Type of value
LONG
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
Genre
Binning and ROI
Read write mode
R/W
Type of value
MODE
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
Genre
Sensitivity
Read write mode
R/W
Type of value
MODE
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
Genre
Feature
Read write mode
R/W
Type of value
MODE
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
Genre
Readout
Read write mode
R/W
Type of value
MODE
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
Genre
Sensitivity
Read write mode
R/W
Type of value
LONG
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
Genre
Sensitivity
Read write mode
R/W
Type of value
MODE
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
Genre
Sensitivity
Read write mode
R/W
Type of value
MODE
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
Genre
Sensitivity
Read write mode
R/W
Type of value
LONG
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
Genre
Sensitivity
Read write mode
R/O
Type of value
MODE
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
Features
Read write mode
R/W
Type of value
REAL, SECOND
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
Genre
Features
Read write mode
R/W
Type of value
MODE
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_EXTRACTION_MODE (4.0-)
Genre
Data Reduction
Read write mode
R/W
Type of value
MODE
Explanation
This property allows you to specify data extraction mode. The camera outputs encoded data with data mask you set when this property is "ON". This property can have one of following values:
DCAMPROP_MODE__OFF
"OFF" The camera outputs raw data.
DCAMPROP_MODE__ON
"ON" The camera outputs extraction data.
Reference

DCAM_IDPROP_FRAMEAVERAGINGFRAMES
Genre
ALU
Read write mode
R/W
Type of value
LONG
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
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
Frame bundle
Read write mode
R/O
Type of value
LONG
Explanation
This property returns the offset bytes to skip next frame in bundled frames.
Reference

DCAM_IDPROP_FRAMEBUNDLE_MODE
Genre
Frame bundle
Read write mode
R/W
Type of value
MODE
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
Genre
Frame bundle
Read write mode
R/W
Type of value
LONG
Explanation
This property allows you to specify how many frames to be bundled.
Reference

DCAM_IDPROP_FRAMEBUNDLE_ROWBYTES
Genre
Frame bundle
Read write mode
R/O
Type of value
LONG
Explanation
This property returns the rowbytes in a frame.
Reference

DCAM_IDPROP_FRAMESTAMP_PRODUCER (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Contrast enhance
Read write mode
R/W
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
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
Genre
System Information
Read write mode
R/O
Type of value
LONG [ARRAY]
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
Genre
System Information
Read write mode
R/O
Type of value
LONG [ARRAY]
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
Genre
System Information
Read write mode
R/O
Type of value
LONG [ARRAY]
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
Genre
System Information
Read write mode
R/O
Type of value
LONG [ARRAY]
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
Genre
System Information
Read write mode
R/O
Type of value
LONG [ARRAY]
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
Genre
System Information
Read write mode
R/O
Type of value
LONG [ARRAY]
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 (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
Micro-meter
Explanation
This property returns physical vertical size of one pixel on image detector.
Reference

DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMHORZ (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
LONG
Explanation
This property returns number of horizontal pixels on image detector.
Reference

DCAM_IDPROP_IMAGEDETECTOR_PIXELNUMVERT (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
LONG
Explanation
This property returns number of vertical pixels on image detector.
Reference

DCAM_IDPROP_IMAGEDETECTOR_PIXELWIDTH (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
Micro-meter
Explanation
This property returns physical horizontal size of one pixel on image detector.
Reference

DCAM_IDPROP_IMAGE_CAMERASTAMP (4.0-)
Genre
System information
Read write mode
R/W
Type of value
LONG
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
Genre
System information
Read write mode
R/O
Type of value
LONG
Explanation
This property returns byte size of one image for storing.
Reference

DCAM_IDPROP_IMAGE_HEIGHT
Genre
System information
Read write mode
R/O
Type of value
LONG
Explanation
This property returns vertical pixel number of the image based on current property setting.
Reference

DCAM_IDPROP_IMAGE_PIXELTYPE
Genre
System information
Read write mode
R/W
Type of value
MODE, DCAM_PIXELTYPE
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
Genre
System information
Read write mode
R/O
Type of value
LONG
Explanation
This property returns byte size of one horizontal line for accessing next row pixel.
Reference

DCAM_IDPROP_IMAGE_TOPOFFSETBYTES
Genre
System information
Read write mode
R/O
Type of value
LONG
Explanation
This property returns the offset bytes to point first data image. Usually this is 0.
Reference

DCAM_IDPROP_IMAGE_WIDTH
Genre
System information
Read write mode
R/O
Type of value
LONG
Explanation
This property returns horizontal pixel number of the image based on current property setting.
Reference

DCAM_IDPROP_INTENSITYLUT_BLACKCLIP
Genre
ALU
Read write mode
R/W
Type of value
LONG
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
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
ALU
Read write mode
R/W
Type of value
LONG
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
Genre
ALU
Read write mode
R/W
Type of value
LONG
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
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
Synchronous timing
Read write mode
R/W
Type of value
Real, SECOND
Explanation
This property returns the period between the start of two frames. Some devices can set this property.
Reference

DCAM_IDPROP_INTERNALFRAMERATE
Genre
Synchronous timing
Read write mode
R/W
Type of value
Real, 1/SECOND
Explanation
This property returns the number of frames per second that the camera outputs. Some devices can set this property.
Reference

DCAM_IDPROP_INTERNALLINERATE
Genre
Synchronous timing
Read write mode
R/W
Type of value
Real, 1/SECOND
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
Genre
Synchronous timing
Read write mode
R/W
Type of value
REAL, SECOND
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
Genre
Synchronous timing
Read write mode
R/W
Type of value
REAL, METER/SECOND
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
Genre
Synchronous timing
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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.
or
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
Feature
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
LONG [ARRAY]
Explanation
This property allows you to set a horizontal start address of a mask region.
Reference

DCAM_IDPROP_MASKREGION_HSIZE
Genre
Binning and ROI
Read write mode
R/W
Type of value
LONG [ARRAY]
Explanation
This property allows you to set a horizontal size of a mask region. This is an ARRAY.
Reference

DCAM_IDPROP_MASTERPULSE_BURSTTIMES
Genre
Master Pulse
Read write mode
R/W
Type of value
LONG
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
Genre
Master Pulse
Read write mode
R/W
Type of value
REAL, SECOND
Explanation
This property allows you to set input interval of master pulse in seconds.
Reference

DCAM_IDPROP_MASTERPULSE_MODE
Genre
Master Pulse
Read write mode
R/W
Type of value
MODE
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
Genre
Master Pulse
Read write mode
R/W
Type of value
MODE
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
Genre
Sensitivity
Read write mode
R/O
Type of value
REAL
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
System information
Read write mode
R/O
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
System Information
Read write mode
R/O
Type of value
LONG
Explanation
For a camera with staggered sensors, this property returns the number of sensors.
Reference

DCAM_IDPROP_NUMBEROF_MASKREGION
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Output Trigger
Read write mode
R/O
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/O
Type of value
LONG
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
Genre
System information
Read write mode
R/O
Type of value
LONG
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
Genre
Output intensity
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
REAL, SECOND
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
REAL, SECOND
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Output Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Sensitivity
Read write mode
R/W
Type of value
MODE
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
Genre
System Information
Read write mode
R/W
Type of value
LONG
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
Genre
System Information
Read write mode
R/W
Type of value
LONG
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
Genre
Sensor mode
Read write mode
R/W
Type of value
MODE
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
Sensor mode
Read write mode
R/W
Type of value
LONG
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 (4.0-)
Genre
System information
Read write mode
R/O
Type of value
LONG
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 (4.0-)
Genre
System information
Read write mode
R/O
Type of value
LONG
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 (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
LONG
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
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
ALU
Read write mode
R/W
Type of value
LONG
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
Sensitivity
Read write mode
R/W
Type of value
REAL
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
Genre
Sensitivity
Read write mode
R/O
Type of value
MODE
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
Sensor cooler
Read write mode
R/W
Type of value
MODE
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
Genre
Sensor cooler
Read write mode
R/W
Type of value
MODE
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
Genre
Sensor cooler
Read write mode
R/O
Type of value
MODE
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
Readout
Read write mode
R/W
Type of value
MODE
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
Genre
Readout
Read write mode
R/W
Type of value
LONG
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
Genre
Readout
Read write mode
R/W
Type of value
LONG
Explanation
This property allows you to set the vertical offset number of readout start position when SENSORMODE is PANORAMIC.
Reference

DCAM_IDPROP_SENSORMODE_TDISTAGE
Genre
Readout
Read write mode
R/W
Type of value
LONG
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
Genre
Sensor cooler
Read write mode
R/O
Type of value
REAL Celsius
Explanation
This property reports the temperature of the image sensor in Celsius.
Reference

DCAM_IDPROP_SENSORTEMPERATURETARGET
Genre
Sensor cooler
Read write mode
R/W
Type of value
REAL Celsius
Explanation
This property allows you to specify the target temperature of the image sensor in Celsius.
Reference

DCAM_IDPROP_SHADINGCALIBDATAMEMORY
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
LONG
Explanation
This property allows you to set the target value for calibration.
Reference

DCAM_IDPROP_SHADINGCORRECTION
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Readout
Read write mode
R/W
Type of value
MODE
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
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
ALU
Read write mode
W/O
Type of value
MODE
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
Genre
ALU
Read write mode
W/O
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
W/O
Type of value
MODE
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
Binning and Subarray
Read write mode
R/W
Type of value
LONG
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
Genre
Binning and Subarray
Read write mode
R/W
Type of value
LONG
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
Binning and Subarray
Read write mode
R/W
Type of value
LONG
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
Binning and Subarray
Read write mode
R/W
Type of value
LONG
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
Genre
Binning and Subarray
Read write mode
R/W
Type of value
LONG
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
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
ALU
Read write mode
R/W
Type of value
MODE
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
Genre
ALU
Read write mode
R/W
Type of value
LONG
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
System information
Read write mode
R/O
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
W/O
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
Explanation
This property allows you to set the number of gain table.
This property is an ARRAY.
Reference

DCAM_IDPROP_TAPGAINCALIB_METHOD
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
R/W
Type of value
MODE
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
Genre
Calibration and correction
Read write mode
W/O
Type of value
MODE
Explanation
This property allows you to set the option parameter for TESTPATTERN.
Reference

DCAM_IDPROP_TIMESTAMP_PRODUCER (4.0-)
Genre
System Information
Read write mode
R/O
Type of value
MODE
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
Genre
Synchronous timing
Read write mode
R/O
Type of value
SECOND
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
Genre
Synchronous timing
Read write mode
R/O
Type of value
MODE
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
Genre
Synchronous timing
Read write mode
R/O
Type of value
SECOND
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
Genre
Synchronous timing
Read write mode
R/O
Type of value
SECOND
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
Genre
Synchronous timing
Read write mode
R/O
Type of value
SECOND
Explanation
This property returns the period from the end of exposure to trigger ready.
Reference

DCAM_IDPROP_TIMING_MINTRIGGERINTERVAL
Genre
Synchronous timing
Read write mode
R/O
Type of value
SECOND
Explanation
This property returns the period from receiving input trigger to trigger ready.
Reference

DCAM_IDPROP_TIMING_READOUTTIME
Genre
Synchronous timing
Read write mode
R/O
Type of value
SECOND
Explanation
This property returns frame read out time in seconds.
Reference

DCAM_IDPROP_TRANSFERINFO_FRAMECOUNT
Genre
System information
Read write mode
R/O
Type of value
LONG
Explanation
This property tells the frame count of last capturing. Some cameras only supports this property.
Reference

DCAM_IDPROP_TRANSFERINFO_LOSTCOUNT
Genre
System information
Read write mode
R/O
Type of value
LONG
Explanation
This property tells the lost frame count of last capturing. Some cameras only supports this property.
Reference

DCAM_IDPROP_TRIGGERACTIVE
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Trigger
Read write mode
R/W
Type of value
SECOND
Explanation
This property can set delay time for using this timing inside of camera.
Reference

DCAM_IDPROP_TRIGGERENABLE_ACTIVE
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
LONG
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Genre
Trigger
Read write mode
R/W
Type of value
MODE
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
Trigger
Read write mode
R/W
Type of value
LONG
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

Go to top of this chapter


PROGRAMMING


Enumerate supported properties
Show attribute of a property
Enumerate Value Text
Enumerate value of VOLATILE properties
Enumerate value of INFLUENTIAL properties
Enumerate value of UPDATED properties

Enumerate supported properties
void enumerate_supported_properties(
HDCAM hdcam /* DCAM handle */
) {
int32 iProp; /* property ID */

iProp = 0;
DCAMERR err;
err = dcamprop_getnextid( hdcam, &iProp, DCAMPROP_OPTION_SUPPORT );
while( !failed(err) && iProp != 0 )
{
/* The iProp value is a property ID that the device supports */

/* Getting property attribute. */
DCAMPROP_ATTR attr;
char name[ 64 ];

memset( &attr, 0, sizeof(attr) );
attr.iProp = iProp;
err = dcamprop_getattr( hdcam, &attr );
if( failed(err) )
break;

/* Getting property name. */
err = dcamprop_getname( hdcam, iProp, name, sizeof(name) );
if( failed(err) )
break;

printf( "%s property is supported\n", name );

err = dcamprop_getnextid( hdcam, &iProp, DCAMPROP_OPTION_SUPPORT );
}
}

Show attribute of a property
void show_property_type(
HDCAM hdcam, /* DCAM handle */
int32 iProp /* property ID */
) {
DCAMPROP_ATTR attr;
char name[ 64 ];
int32 type;

/* Getting property name */
dcamprop_getname( hdcam, iProp, name, sizeof( name ) );

/* Getting property attribute */
memset( &attr, 0, sizeof( attr ) );
attr.iProp = iProp;
dcamprop_getattr( hdcam, &attr );

type = ( attr.attribute & DCAMPROP_TYPE_MASK );
switch( type )
{
case DCAMPROP_TYPE_MODE:
printf( "%s is MODE type.\n", name );
break;
case DCAMPROP_TYPE_LONG:
printf( "%s is LONG type.\n", name );
break;
case DCAMPROP_TYPE_REAL:
printf( "%s is REAL type.\n", name );
break;
default:
printf( "%s is unknown type(0x%02X).\n", name, type );
break;
}
}

Enumerate Value Text
BOOL enumerate_valuetext(
HDCAM hdcam, /* DCAM handle */
int32 iProp /* property ID */
) {
DCAMPROP_ATTR attr;
char text[ 64 ];
double v;

/* Getting property attribute */
memset( &attr, 0, sizeof( attr ) );
attr.iProp = iProp;

if( ! dcamprop_getattr( hdcam, &attr ) )
{
/* The property ID may not be supported */
return FALSE;
}

/* Checking the property has value text or not */
if( ! ( attr.attribute & DCAMPROP_ATTR_HASVALUETEXT ) )
{
/* This property does not have value text */
return FALSE;
}

dcamprop_getname( hdcam, iProp, text, sizeof( text ) );

printf( "%s property has following values.\n", text );

/* Getting value text */
for( v = attr.valuemin; v <= attr.valuemax; )
{
DCAMPROP_VALUETEXT valuetext;
memset( &valuetext, 0, sizeof( valuetext ) );
valuetext.iProp = iProp;
valuetext.value = v;
valuetext.text = text;
valuetext.textbytes = sizeof( text );

if( dcamprop_getvaluetext( hdcam, &valuetext ) )
{
/* The property has the value text of the value */
printf( ""%g : %s\n", v, text );
}

if( ! dcamprop_queryvalue( hdcam, iProp, &v, DCAMPROP_OPTION_NEXT ) )
{
/* no more value */
break;
}
}

return TRUE;
}

Enumerate value of VOLATILE properties
void get_volatile_properties(
HDCAM hdcam /* DCAM handle */
) {
int32 iProp; /* property ID */
double value;

iProp = 0;
if( dcamprop_getnextid( hdcam, &iProp, DCAMPROP_OPTION_VOLATILE ) )
{
do {
/* The iProp value is a VOLATILE property ID */

/* Getting property value */
dcamprop_getvalue* hdcam, iProp, &value );

} while( dcamprop_getnextid( hdcam, &iProp, DCAMPROP_OPTION_VOLATILE ) && iProp != 0 );
}
}

Enumerate value of INFLUENTIAL properties
void get_influent_properties(
HDCAM hdcam, /* DCAM handle */
int32 iSrcProp /* influential property ID */
) {
int i;
double value;
int32 iDstProp; /* effected property ID */

for( i=1; ; i++ )
{
int32 option;
option = DCAMPROP_OPTION_INFLUENCE;
option |= ( DCAMPROP_OPTION_NEXT * i );

iDstProp = iSrcProp;
if( ! dcamprop_getnextid( hdcam, &iDstProp, option ) )
{
/* No more effected property ID */
break;
}

/* The iDstProp value is one of effected property IDs */
}
}

Enumerate value of UPDATED properties
void get_updated_properties(
HDCAM hdcam; /* DCAM handle */
) {
int32 iProp; /*  property ID */
double value;

iProp = 0;
if( dcamprop_getnextid( hdcam, &iProp, DCAMPROP_OPTION_UPDATED
{
do {
/* The iProp value is an UPDATED property ID */

/* Getting property value */
dcamprop_getvalue( hdcam, iProp, &value );
} while ( dcamprop_getnextid( hdcam, &iProp. DCAMPROP_OPTION_UPDAED ) && iProp != 0 );
}
}

Go to top of this chapter