CameraSettingsBlueFOX Class Reference

mvBlueFOX related camera settings(Device specific interface layout only). More...

Inheritance diagram for CameraSettingsBlueFOX:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.CameraSettingsBlueFOX object.
	getHDRControl (self)
	Returns the mvIMPACT.acquire.HDRControl object associated with this setting.

Properties
	advancedOptions = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_advancedOptions_get, doc=)
	An enumerated integer property defining a collection of advanced options that can be enabled or disabled.
	exposeToFlashDelay_us = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_exposeToFlashDelay_us_get, doc=)
	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.
	flashMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_flashMode_get, doc=)
	An enumerated integer property defining the behaviour of the flash output of the camera (if available).
	flashToExposeDelay_us = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_flashToExposeDelay_us_get, doc=)
	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.
	flashType = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_flashType_get, doc=)
	An enumerated integer property defining the type of the flash output of the camera (if available).
	lineDelay_clk = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_lineDelay_clk_get, doc=)
	An integer property defining the delay in clocks between two lines.
	offsetAutoBlackLevel = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetAutoBlackLevel_get, doc=)
	An integer property defining the digital value assumed as black.
	offsetAutoBlackSpeed = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetAutoBlackSpeed_get, doc=)
	An enumerated integer property defining the speed of the auto offset calibration circuit.
	offsetAutoCalibration = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetAutoCalibration_get, doc=)
	An enumerated integer property defining the offset calibration mode.
	offsetBlackLevel_pc = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetBlackLevel_pc_get, doc=)
	An integer property defining the analogue sensor offset in percent of the allowed range (sensor specific).
	offsetCorrection_pc = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetCorrection_pc_get, doc=)
	A float property defining and additional analogue sensor offset in percent of the allowed range (sensor specific) per color channel.
	reverseX = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_reverseX_get, doc=)
	An enumerated integer property defining the behaviour of the Aoi reverse mode (if available).
	reverseY = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_reverseY_get, doc=)
	An enumerated integer property defining the behaviour of the Aoi reverse mode (if available).
	sensorTimingMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_sensorTimingMode_get, doc=)
	An enumerated integer property defining the current image sensor timing mode.
	shutterMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_shutterMode_get, doc=)
	An enumerated integer property defining the shutter mode to use.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	triggerSource = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_triggerSource_get, doc=)
	An enumerated integer property defining where the trigger signal is expected to occur.

Detailed Description

mvBlueFOX related camera settings(Device specific interface layout only).

This class contains properties to control the way the image sensor of the mvBlueFOX behaves.

Note

This class will only be available if mvIMPACT.acquire.Device.interfaceLayout is set to mvIMPACT.acquire.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.CameraSettingsBlueFOX object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] 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

Reimplemented from CameraSettingsBlueDevice.

Member Function Documentation

getHDRControl()

getHDRControl

(

self

)

Returns the mvIMPACT.acquire.HDRControl object associated with this setting.

Property Documentation

advancedOptions

advancedOptions = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_advancedOptions_get, doc=)

static

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 may be: mvIMPACT.acquire.daoOff, mvIMPACT.acquire.daoLowLight, mvIMPACT.acquire.daoEmbeddedImageInfo, mvIMPACT.acquire.daoImageAverage, mvIMPACT.acquire.daoPipelinedGainExposeControl, mvIMPACT.acquire.daoOnDemandTriggerPreShot, mvIMPACT.acquire.daoLowFrameRateOptimization, mvIMPACT.acquire.daoEnablePerChannelOffsetCorrection, mvIMPACT.acquire.daoUseRawSensorGain, mvIMPACT.acquire.daoTriggerSensorColumnCalibration.

exposeToFlashDelay_us

exposeToFlashDelay_us = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_exposeToFlashDelay_us_get, doc=)

static

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.

flashMode

flashMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_flashMode_get, doc=)

static

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 may be: mvIMPACT.acquire.cfmOff, mvIMPACT.acquire.cfmDigout0, mvIMPACT.acquire.cfmDigout1.

See also

mvIMPACT.acquire.CameraSettingsBlueFOX.flashToExposeDelay_us

flashToExposeDelay_us

flashToExposeDelay_us = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_flashToExposeDelay_us_get, doc=)

static

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.

Note

This property is mainly provided for compatibility reasons. Previous versions of the mvBlueFOX driver produced a fixed delay of about 300 us between the beginning of the flash signal creation and the beginning of the sensors expose period. Newer versions of the driver do NOT produce this delay anymore which might cause a different illumination for applications using very intensive, short flash and expose times. Applications relying on the delay introduced in older driver versions should set this property to '300' by calling mvIMPACT.acquire.PropertyI.write.

See also

mvIMPACT.acquire.CameraSettingsBlueDevice.expose_us

flashType

flashType = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_flashType_get, doc=)

static

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 may be: mvIMPACT.acquire.cftStandard, mvIMPACT.acquire.cftRollingShutterFlash, mvIMPACT.acquire.cftVSync.

lineDelay_clk

lineDelay_clk = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_lineDelay_clk_get, doc=)

static

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.

offsetAutoBlackLevel

offsetAutoBlackLevel = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetAutoBlackLevel_get, doc=)

static

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.

Note

As the mvBlueFOX internally works with a 10 bit analog to digital conversion increasing this value by 4 will result in a black level increased by about 1 in the resulting 8 bit raw image delivered from the camera.

offsetAutoBlackSpeed

offsetAutoBlackSpeed = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetAutoBlackSpeed_get, doc=)

static

An enumerated integer property defining the speed of the auto offset calibration circuit.

Valid values for this property may be: mvIMPACT.acquire.bfoablFastest, mvIMPACT.acquire.bfoablVeryFast, mvIMPACT.acquire.bfoablFast, mvIMPACT.acquire.bfoablMedium, mvIMPACT.acquire.bfoablSlow, mvIMPACT.acquire.bfoablVerySlow, mvIMPACT.acquire.bfoablSlowest.

offsetAutoCalibration

offsetAutoCalibration = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetAutoCalibration_get, doc=)

static

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 may be: mvIMPACT.acquire.aocOff, mvIMPACT.acquire.aocOn.

offsetBlackLevel_pc

offsetBlackLevel_pc = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetBlackLevel_pc_get, doc=)

static

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.

Note

This property might not be supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

offsetCorrection_pc

offsetCorrection_pc = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_offsetCorrection_pc_get, doc=)

static

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.

• The value at index 0 applies to the green component of the red-green rows of the bayer pattern
• The value at index 1 applies to the red component of the bayer pattern
• The value at index 2 applies to the green component of the blue-green rows of the bayer pattern
• The value at index 3 applies to the blue component of the bayer pattern

Note

This property might not be supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. In addition to that this property must be enabled explicitly by setting the advanced option bit mvIMPACT.acquire.daoEnablePerChannelOffsetCorrection of the property mvIMPACT.acquire.CameraSettingsBlueFOX.advancedOptions.

See also

mvIMPACT.acquire.CameraSettingsBlueDevice.offset_pc

reverseX

reverseX = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_reverseX_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

reverseY

reverseY = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_reverseY_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

sensorTimingMode

sensorTimingMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_sensorTimingMode_get, doc=)

static

An enumerated integer property defining the current image sensor timing mode.

Valid values for this property may be: mvIMPACT.acquire.bfstStandard, mvIMPACT.acquire.bfstFastLineSkip, mvIMPACT.acquire.bfstLowSmearLineSkip.

shutterMode

shutterMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_shutterMode_get, doc=)

static

An enumerated integer property defining the shutter mode to use.

Valid values for this property may be: mvIMPACT.acquire.csmFrameShutter, mvIMPACT.acquire.csmElectronicRollingShutter, mvIMPACT.acquire.csmGlobalResetRelease, mvIMPACT.acquire.csmFrameShutterWithFastCenterReadout.

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

triggerSource

triggerSource = property(lib_mvIMPACT_acquire.CameraSettingsBlueFOX_triggerSource_get, doc=)

static

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 may be: mvIMPACT.acquire.ctsDigIn0, mvIMPACT.acquire.ctsDigIn1, mvIMPACT.acquire.ctsRTCtrl, mvIMPACT.acquire.ctsDigOut0, mvIMPACT.acquire.ctsDigOut1, mvIMPACT.acquire.ctsDigOut2, mvIMPACT.acquire.ctsDigOut3.