Impact Acquire SDK C++
|
mvBlueFOX related camera settings(Device specific interface layout only). More...
#include <mvIMPACT_acquire.h>
Public Member Functions | |
CameraSettingsBlueFOX (Device *pDev, const std::string &settingName="Base") | |
Constructs a new mvIMPACT::acquire::CameraSettingsBlueFOX object. | |
AutoControlParameters & | getAutoControlParameters (void) |
Provides access to the control parameters for AGC and AEC. | |
HDRControl & | getHDRControl (void) |
Returns the mvIMPACT::acquire::HDRControl object associated with this setting. | |
HOBJ | hObj (void) const |
Returns a unique identifier for the component collection referenced by this object. | |
const ComponentCollection & | restoreDefault (void) const |
Restores the default for every component of this collection. | |
Public Attributes | |
PropertyIDeviceAdvancedOptions | advancedOptions |
An enumerated integer property defining a collection of advanced options that can be enabled or disabled. | |
PropertyI | aoiHeight |
An integer property defining the number of lines to capture. | |
PropertyI | aoiStartX |
An integer property defining the X-offset for each capture line. | |
PropertyI | aoiStartY |
An integer property defining the Y-offset. | |
PropertyI | aoiWidth |
An integer property defining the number of pixels to capture per line. | |
PropertyIAutoControlMode | autoControlMode |
An enumerated integer property defining the auto control mode the device is operated in. | |
AutoControlParameters | autoControlParameters |
Provides access to the control parameters for AGC and AEC. | |
PropertyIAutoExposureControl | autoExposeControl |
An enumerated integer property, which represents the current mode the AEC (A utomatic E xpose C ontrol) is operated in. | |
PropertyIAutoGainControl | autoGainControl |
An enumerated integer property, which represents the current mode the AGC (A utomatic G ain C ontrol) is operated in. | |
PropertyS | basedOn |
A string property (read-only) containing the name of the setting this setting is based on. | |
PropertyICameraBinningMode | binningMode |
An enumerated integer property defining the binning mode the camera is operated in. | |
PropertyI | expose_us |
An integer property which defines the exposure time for an image in us. | |
PropertyICameraExposeMode | exposeMode |
An enumerated integer property defining the exposure mode the camera sensor is operated in. | |
PropertyI | exposeToFlashDelay_us |
An integer property defining the delay in us after signaling the sensor to start the expose and the output of the flash signal at the camera's digital output. | |
PropertyICameraFlashMode | flashMode |
An enumerated integer property defining the behaviour of the flash output of the camera (if available). | |
PropertyI | flashToExposeDelay_us |
An integer property defining the delay in us between the start of the flash signal output and the beginning of the expose period of the image sensor. | |
PropertyICameraFlashType | flashType |
An enumerated integer property defining the type of the flash output of the camera (if available). | |
PropertyI | frameDelay_us |
An integer property defining the delay in us between an external trigger event an the begin of the sensor exposure. | |
PropertyF | gain_dB |
A float property defining the gain in dB. | |
PropertyI | imageRequestTimeout_ms |
An integer property defining the maximum time to wait for an image in ms. | |
PropertyI | lineDelay_clk |
An integer property defining the delay in clocks between two lines. | |
PropertyF | offset_pc |
A float property defining the analogue sensor offset in percent of the allowed range (sensor specific). | |
PropertyI | offsetAutoBlackLevel |
An integer property defining the digital value assumed as black. | |
PropertyIBlueFOXOffsetAutoBlackSpeed | offsetAutoBlackSpeed |
An enumerated integer property defining the speed of the auto offset calibration circuit. | |
PropertyIAutoOffsetCalibration | offsetAutoCalibration |
An enumerated integer property defining the offset calibration mode. | |
PropertyI | offsetBlackLevel_pc |
An integer property defining the analogue sensor offset in percent of the allowed range (sensor specific). | |
PropertyF | offsetCorrection_pc |
A float property defining and additional analogue sensor offset in percent of the allowed range (sensor specific) per color channel. | |
PropertyICameraPixelClock | pixelClock_KHz |
An enumerated integer property defining the pixel clock of the camera sensor in KHz. | |
PropertyIImageBufferPixelFormat | pixelFormat |
An enumerated integer property defining the pixel format used to transfer the image data into the target systems host memory. | |
PropertyIBoolean | reverseX |
An enumerated integer property defining the behaviour of the Aoi reverse mode (if available). | |
PropertyIBoolean | reverseY |
An enumerated integer property defining the behaviour of the Aoi reverse mode (if available). | |
PropertyIBlueFOXSensorTiming | sensorTimingMode |
An enumerated integer property defining the current image sensor timing mode. | |
PropertyICameraShutterMode | shutterMode |
An enumerated integer property defining the shutter mode to use. | |
PropertyICameraTestMode | testMode |
An enumerated integer property defining the image transmission mode of the camera. | |
PropertyICameraTriggerMode | triggerMode |
An enumerated integer property which defines what kind of trigger mode shall be used for an image acquisition. | |
PropertyICameraTriggerSource | triggerSource |
An enumerated integer property defining where the trigger signal is expected to occur. | |
Protected Attributes | |
HOBJ | m_hRoot |
mvBlueFOX related camera settings(Device specific interface layout only).
This class contains properties to control the way the image sensor of the mvBlueFOX behaves.
|
inlineexplicit |
Constructs a new mvIMPACT::acquire::CameraSettingsBlueFOX object.
[in] | pDev | A pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object. |
[in] | settingName | The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT::acquire::FunctionInterface::getAvailableSettings, new settings can be created with the function mvIMPACT::acquire::FunctionInterface::createSetting |
|
inlineinherited |
Provides access to the control parameters for AGC and AEC.
|
inline |
Returns the mvIMPACT::acquire::HDRControl object associated with this setting.
|
inlineinherited |
Returns a unique identifier for the component collection referenced by this object.
This handle will always reference an object of type mvIMPACT::acquire::ComponentList.
|
inlineinherited |
Restores the default for every component of this collection.
Calling this function will restore the default value for every component belonging to this collection.
PropertyIDeviceAdvancedOptions advancedOptions |
An enumerated integer property defining a collection of advanced options that can be enabled or disabled.
This property is highly sensor dependent. Each sensor might offer a different sub set of the options offered. Only experienced users should work with this feature.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TDeviceAdvancedOptions.
|
inherited |
An integer property defining the number of lines to capture.
|
inherited |
An integer property defining the X-offset for each capture line.
Example: When setting this property to 5 the first pixel in each line of the resulting image will be pixel number 5 of each line transmitted by the camera.
|
inherited |
An integer property defining the Y-offset.
Example: When setting this property to 5 the first line of the resulting image will be line number 5 of the image transmitted by the camera.
|
inherited |
An integer property defining the number of pixels to capture per line.
|
inherited |
An enumerated integer property defining the auto control mode the device is operated in.
This property can be used to control the overall behaviour of the algorithms used for performing AEC (A utomatic E xpose C ontrol) or AGC (A utomatic G ain C ontrol). This could be done by the device itself thus e.g. even in the analog domain or e.g. by a software process in the driver. Each method will offer certain advantages and disadvantages and depending on the application the correct method can be selected.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAutoControlMode.
Every device or even different models belonging to the same device family may support different auto control modes, thus it's crucial to query the valid modes for each device by reading the properties translation dictionary BEFORE trying to assign a certain value to this property.
|
inherited |
Provides access to the control parameters for AGC and AEC.
|
inherited |
An enumerated integer property, which represents the current mode the AEC (A utomatic E xpose C ontrol) is operated in.
The values used to capture the image, which are directly influenced by an activated AGC or AEC (e.g. the gain or the exposure time) will be returned as part of the result of the image request.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAutoExposureControl.
|
inherited |
An enumerated integer property, which represents the current mode the AGC (A utomatic G ain C ontrol) is operated in.
The values used to capture the image, which are directly influenced by an activated AGC or AEC (e.g. the gain or the exposure time) will be returned as part of the result of the image request.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAutoGainControl.
|
inherited |
A string property (read-only) containing the name of the setting this setting is based on.
|
inherited |
An enumerated integer property defining the binning mode the camera is operated in.
By default the no binning will be performed.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraBinningMode.
|
inherited |
An integer property which defines the exposure time for an image in us.
|
inherited |
An enumerated integer property defining the exposure mode the camera sensor is operated in.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraExposeMode.
PropertyI exposeToFlashDelay_us |
An integer property defining the delay in us after signaling the sensor to start the expose and the output of the flash signal at the camera's digital output.
PropertyICameraFlashMode flashMode |
An enumerated integer property defining the behaviour of the flash output of the camera (if available).
If this property is set the cameras flash output (if available) will be pulsed during the exposure period of the sensor. In that case the pulse width will be equal to the exposure time.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraFlashMode.
PropertyI flashToExposeDelay_us |
An integer property defining the delay in us between the start of the flash signal output and the beginning of the expose period of the image sensor.
PropertyICameraFlashType flashType |
An enumerated integer property defining the type of the flash output of the camera (if available).
Depending of the camera sensor type (rolling shutter or frame shutter there well be different modes available
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraFlashType.
|
inherited |
An integer property defining the delay in us between an external trigger event an the begin of the sensor exposure.
|
inherited |
A float property defining the gain in dB.
The formula for given gain_dB
is
Example:
I.e. increasing the gain setting by 6dB corresponds to factor of 2.
The formula for given gain_x is
Where:
gain_dB:
Balluff gain value (logarithmic)
gain_x:
multiplicative gain
^
: power function
|
inherited |
An integer property defining the maximum time to wait for an image in ms.
When this property is set to 0 the timeout never elapses. If the timeout this property defines elapses the currently processed request will be returned to the user even if no data has been captured so far. The result structure of the request object should be examined in that case. Also this should be considered as an error from the users point of view in which case he should clean up the acquisition queue by calling mvIMPACT::acquire::FunctionInterface::imageRequestReset. Afterwards the capture loop can be restarted.
PropertyI lineDelay_clk |
An integer property defining the delay in clocks between two lines.
Can be used to slow down the image readout the reduce the peak bandwidth required for the transfer.
|
protectedinherited |
|
inherited |
A float property defining the analogue sensor offset in percent of the allowed range (sensor specific).
This property influences the average grey level when no light reaches the sensor. mvBlueFOX specific: Changing its value will have no effect if mvIMPACT::acquire::CameraSettingsBlueFOX::offsetAutoCalibration is set to mvIMPACT::acquire::aocOn.
By default this value will be around 10 (if mvIMPACT::acquire::CameraSettingsBlueFOX::offsetAutoCalibration if set to mvIMPACT::acquire::aocOn). This means the average grey value for an image taken in a completely dark environment will be around 10. When setting mvIMPACT::acquire::CameraSettingsBlueFOX::offsetAutoCalibration to mvIMPACT::acquire::aocOff mvIMPACT::acquire::CameraSettingsBlueFOX::offset_pc can be used to modify this value.
The valid range for this property lies between -100% and +100%, whereas negative values will shifts the black level towards 0 and positive values to 255.
PropertyI offsetAutoBlackLevel |
An integer property defining the digital value assumed as black.
Modifying this property in rare cases might be useful to achieve a higher dynamic range for noise close to the black level.
PropertyIBlueFOXOffsetAutoBlackSpeed offsetAutoBlackSpeed |
An enumerated integer property defining the speed of the auto offset calibration circuit.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBlueFOXOffsetAutoBlackSpeed.
PropertyIAutoOffsetCalibration offsetAutoCalibration |
An enumerated integer property defining the offset calibration mode.
If this property is set to mvIMPACT::acquire::aocOff the offset can be adjusted manually by modifying the mvIMPACT::acquire::CameraSettingsBlueFOX::offset_pc and mvIMPACT::acquire::CameraSettingsBlueFOX::offsetCorrection_pc properties.
If set to mvIMPACT::acquire::aocOn the offset is approx. 10. That means, that the medium pixel count is 10, in case no light is falling on the sensor.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAutoOffsetCalibration.
PropertyI offsetBlackLevel_pc |
An integer property defining the analogue sensor offset in percent of the allowed range (sensor specific).
This property influences the average grey level when no light reaches the sensor.
PropertyF offsetCorrection_pc |
A float property defining and additional analogue sensor offset in percent of the allowed range (sensor specific) per color channel.
Together with value of the property mvIMPACT::acquire::CameraSettingsBlueDevice::offset_pc this property influences the average grey level when no light reaches the sensor.
This property stores 4 values.
|
inherited |
An enumerated integer property defining the pixel clock of the camera sensor in KHz.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraPixelClock.
Every device or even different models belonging to the same device family may support different pixel clocks, thus it's crucial to query the valid clock modes for each sensor by reading the properties translation dictionary.
|
inherited |
An enumerated integer property defining the pixel format used to transfer the image data into the target systems host memory.
Support for this property has been added in version 1.11.0 of Impact Acquire thus old driver versions will raise an exception if an application accesses the property without checking if the property is present.
By default this property will be set to mvIMPACT::acquire::ibpfAuto. This will result in the previous driver behaviour where depending on the various post processing steps that are enabled or disabled the driver will decide which transfer format will be used. However sometimes this could result in a transfer format, which is not ideal for the application (e.g. when a post processing step of the application needs RGBx888Packed but the systems bandwidth is limited the application might want to transfer the data in YUV422 packed and then use the fast format conversion algorithm in the driver). This can be achieved by explicitly setting mvIMPACT::acquire::CameraSettingsBase::pixelFormat to mvIMPACT::acquire::ibpfYUV422Packed and mvIMPACT::acquire::ImageDestination::pixelFormat to mvIMPACT::acquire::ibpfRGBx888Packed.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TImageBufferPixelFormat.
PropertyIBoolean reverseX |
An enumerated integer property defining the behaviour of the Aoi reverse mode (if available).
If this property is set the x-axis will be inverted by the sensor (if available).
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.
PropertyIBoolean reverseY |
An enumerated integer property defining the behaviour of the Aoi reverse mode (if available).
If this property is set the y-axis will be inverted by the sensor (if available).
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.
PropertyIBlueFOXSensorTiming sensorTimingMode |
An enumerated integer property defining the current image sensor timing mode.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBlueFOXSensorTiming.
PropertyICameraShutterMode shutterMode |
An enumerated integer property defining the shutter mode to use.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraShutterMode.
|
inherited |
An enumerated integer property defining the image transmission mode of the camera.
If this property is set to mvIMPACT::acquire::ctmOff the 'normal' image captured by the cameras sensor will be transmitted. This is the default. To ensure correct operation the camera might define several test modes where some kind of well defined pattern will be transmitted.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraTestMode. No every test mode will be supported by every device.
|
inherited |
An enumerated integer property which defines what kind of trigger mode shall be used for an image acquisition.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraTriggerMode.
PropertyICameraTriggerSource triggerSource |
An enumerated integer property defining where the trigger signal is expected to occur.
When working with hardware generated signals via mvIMPACT::acquire::RTCtrProgram objects this property should be set to mvIMPACT::acquire::ctsRTCtrl as otherwise the program will not affect the behaviour of the camera.
Valid values for this property are defined by the enumeration mvIMPACT::acquire::TCameraTriggerSource.