Impact Acquire SDK Python
CameraSettingsBlueCOUGAR Class Reference

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

Inheritance diagram for CameraSettingsBlueCOUGAR:
[legend]

Public Member Functions

 __init__ (self, *args)
 Constructs a new mvIMPACT.acquire.CameraSettingsBlueCOUGAR object.
 
 getHDRControl (self)
 Returns the mvIMPACT.acquire.HDRControl object associated with this setting.
 
 getTriggerControlCount (self)
 Returns the number of mvIMPACT.acquire.TriggerControls available for this device.
 
 triggerControl (self, *args)
 Returns a const pointer to a mvIMPACT.acquire.TriggerControl object.
 

Properties

 acquisitionBurstFrameCount = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_acquisitionBurstFrameCount_get, doc=)
 A 64-bit integer property defining the number of frames to acquire for each FrameBurstStart trigger.
 
 frameRate_Hz = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_frameRate_Hz_get, doc=)
 A float property defining the frame rate (in Hz) this device shall use to transfer images.
 
 partialScanMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_partialScanMode_get, doc=)
 An enumerated integer property defining whether partial scan mode shall be used or not.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 triggerControlCount = property (getTriggerControlCount, None, None, None)
 An integer property (read-only) which holds the number of mvIMPACT.acquire.TriggerControls available for this device.
 
 triggerInterface = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_triggerInterface_get, doc=)
 An enumerated integer property defining which view of the trigger interface to use.
 
 triggerSource = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_triggerSource_get, doc=)
 An enumerated integer property defining where the trigger signal is expected to occur.
 

Detailed Description

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

This class contains properties to control the way the image sensor(s) of the mvBlueCOUGAR 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.CameraSettingsBlueCOUGAR 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.

◆ getTriggerControlCount()

getTriggerControlCount ( self)

Returns the number of mvIMPACT.acquire.TriggerControls available for this device.

This might be 0 if the device either does not support this feature.

◆ triggerControl()

triggerControl ( self,
* args )

Returns a const pointer to a mvIMPACT.acquire.TriggerControl object.

OVERLOAD 1:

Note
The features of each mvIMPACT.acquire.TriggerControl will only be visible and thus available, when mvIMPACT.acquire.CameraSettingsBlueCOUGAR.triggerInterface is set to mvIMPACT.acquire.dtiAdvanced.
Parameters
nr[in] The number of the trigger control

OVERLOAD 2: Returns a const pointer to a mvIMPACT.acquire.TriggerControl object or NULL if the name passed to the function does not specify a valid trigger control.

Parameters
name[in] The name of the trigger control

Property Documentation

◆ acquisitionBurstFrameCount

acquisitionBurstFrameCount = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_acquisitionBurstFrameCount_get, doc=)
static

A 64-bit integer property defining the number of frames to acquire for each FrameBurstStart trigger.

Note
This feature will only be taken into account if the FrameBurstStart trigger is active when mvIMPACT.acquire.CameraSettingsBlueCOUGAR.triggerInterface is set to mvIMPACT.acquire.dtiAdvanced.

◆ frameRate_Hz

frameRate_Hz = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_frameRate_Hz_get, doc=)
static

A float property defining the frame rate (in Hz) this device shall use to transfer images.

Depending on other parameters the desired frame rate might not be achievable (e.g. if the exposure time is higher than the frame period. In that case the device will automatically reduce the frame rate.

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

◆ partialScanMode

partialScanMode = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_partialScanMode_get, doc=)
static

An enumerated integer property defining whether partial scan mode shall be used or not.

This property currently is only available for mvBlueCOUGAR-S devices. When partial scan mode is active, the frame rate can no longer be controlled be the property mvIMPACT.acquire.CameraSettingsBlueCOUGAR.frameRate_Hz. The device will always transmit frames as fast as possible instead.

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

◆ thisown

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

◆ triggerControlCount

triggerControlCount = property (getTriggerControlCount, None, None, None)
static

An integer property (read-only) which holds the number of mvIMPACT.acquire.TriggerControls available for this device.

See mvIMPACT.acquire.CameraSettingsBlueCOUGAR.getTriggerControlCount()

◆ triggerInterface

triggerInterface = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_triggerInterface_get, doc=)
static

An enumerated integer property defining which view of the trigger interface to use.

This property mainly switches the visibility of trigger the different trigger interfaces. After applying changes to this property all trigger related features might have a different visibility. However the documentation will state what features are available in which mode.

Valid values for this property may be: mvIMPACT.acquire.dtiStandard, mvIMPACT.acquire.dtiAdvanced.

◆ triggerSource

triggerSource = property(lib_mvIMPACT_acquire.CameraSettingsBlueCOUGAR_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.

Note
This feature will only be visible and thus available, when mvIMPACT.acquire.CameraSettingsBlueCOUGAR.triggerInterface is set to mvIMPACT.acquire.dtiStandard.