Impact Acquire SDK Python
RequestInfoConfiguration Class Reference

Properties to configure which information shall be attached to the resulting images. More...

Inheritance diagram for RequestInfoConfiguration:
[legend]

Public Member Functions

 __init__ (self, *args)
 

Properties

 exposeStart_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_exposeStart_us_get, doc=)
 An enumerated integer property which can be used to configure whether the exposure start(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 exposeTime_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_exposeTime_us_get, doc=)
 An enumerated integer property which can be used to configure whether the exposure time(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 frameID = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_frameID_get, doc=)
 An enumerated integer property which can be used to configure whether the frame ID information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 frameNr = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_frameNr_get, doc=)
 An enumerated integer property which can be used to configure whether the frame number information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 gain_dB = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_gain_dB_get, doc=)
 An enumerated integer property which can be used to configure whether the gain(dB) information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 imageAverage = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_imageAverage_get, doc=)
 An enumerated integer property which can be used to configure whether the image average information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 IOStatesAtExposureStart = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_IOStatesAtExposureStart_get, doc=)
 An enumerated integer property which can be used to configure whether the I/O states at exposure start information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 lineCounter = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_lineCounter_get, doc=)
 An enumerated integer property which can be used to configure whether the line counter information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 lineStatusAll = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_lineStatusAll_get, doc=)
 An enumerated integer property which can be used to configure whether the line status all information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 missingData_pc = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_missingData_pc_get, doc=)
 An enumerated integer property which can be used to configure whether the missing data information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 settingUsed = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_settingUsed_get, doc=)
 An enumerated integer property which can be used to configure whether the 'setting used' information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 timeStamp_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_timeStamp_us_get, doc=)
 An enumerated integer property which can be used to configure whether the time stamp(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 transferDelay_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_transferDelay_us_get, doc=)
 An enumerated integer property which can be used to configure whether the transfer delay(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 triggerCounterAcquisitionStart = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_triggerCounterAcquisitionStart_get, doc=)
 An enumerated integer property which can be used to configure whether the trigger counter at acquisition start information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 triggerCounterFrameStart = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_triggerCounterFrameStart_get, doc=)
 An enumerated integer property which can be used to configure whether the trigger counter at frame start information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 userData = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_userData_get, doc=)
 An enumerated integer property which can be used to configure whether the user data information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 
 videoChannel = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_videoChannel_get, doc=)
 An enumerated integer property which can be used to configure whether the video channel information shall be attached to the resulting mvIMPACT.acquire.Request objects.
 

Detailed Description

Properties to configure which information shall be attached to the resulting images.

This class provides properties allowing the user to define which additional information shall be attached to the resulting images. For example some devices can transmit the state of the digital I/Os at the time the exposure of an image has been started. Some information will always be attached to the resulting images other information will only be available if it has been explicitly enabled before.

def fn(pdev, pRequest):
ric = acquire.RequestInfoConfiguration(pDev)
if ric.lineStatusAll.isValid == False:
# feature not supported
return
else:
ric.lineStatusAll.write(acquire.bTrue)
print(pRequest.chunkLineStatusAll.name() + ": 0x%x" %(pRequest.chunkLineStatusAll.read()))

E.g. for the mvBlueCOUGAR-X/XD series possible LineStatusAll values are

  • 0x11, Out0 and In0 on (Out0 needs to be connected with In0 for this to work)
  • 0x33, Out0, Out1, In0 and In1 on (Out0 and Out1 need to be connected with In0 and In1 for this to work)
  • 0x37, Out0, Out1, Out2, In0 and In1 on (Out0 and Out1 need to be connected with In0 and In1 for this to work)
  • 0x3f, Out0, Out1, Out2, Out3, In0 and In1 on (Out0 and Out1 need to be connected with in0 and in1 for this to work)
Since
2.10.0

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args )

Reimplemented from ComponentCollection.

Property Documentation

◆ exposeStart_us

exposeStart_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_exposeStart_us_get, doc=)
static

An enumerated integer property which can be used to configure whether the exposure start(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ exposeTime_us

exposeTime_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_exposeTime_us_get, doc=)
static

An enumerated integer property which can be used to configure whether the exposure time(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ frameID

frameID = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_frameID_get, doc=)
static

An enumerated integer property which can be used to configure whether the frame ID information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ frameNr

frameNr = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_frameNr_get, doc=)
static

An enumerated integer property which can be used to configure whether the frame number information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ gain_dB

gain_dB = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_gain_dB_get, doc=)
static

An enumerated integer property which can be used to configure whether the gain(dB) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ imageAverage

imageAverage = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_imageAverage_get, doc=)
static

An enumerated integer property which can be used to configure whether the image average information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
  • This feature currently is only available for mvBlueFOX devices

◆ IOStatesAtExposureStart

IOStatesAtExposureStart = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_IOStatesAtExposureStart_get, doc=)
static

An enumerated integer property which can be used to configure whether the I/O states at exposure start information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
This feature currently is only available for mvBlueFOX-MLC devices.

◆ lineCounter

lineCounter = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_lineCounter_get, doc=)
static

An enumerated integer property which can be used to configure whether the line counter information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
  • This feature currently is only available for mvTITAN-CL, mvGAMMA-CL and mvTITAN-DIG devices

◆ lineStatusAll

lineStatusAll = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_lineStatusAll_get, doc=)
static

An enumerated integer property which can be used to configure whether the line status all information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
  • This feature may be available for GenICam compliant devices

◆ missingData_pc

missingData_pc = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_missingData_pc_get, doc=)
static

An enumerated integer property which can be used to configure whether the missing data information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ settingUsed

settingUsed = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_settingUsed_get, doc=)
static

An enumerated integer property which can be used to configure whether the 'setting used' information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ timeStamp_us

timeStamp_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_timeStamp_us_get, doc=)
static

An enumerated integer property which can be used to configure whether the time stamp(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

◆ transferDelay_us

transferDelay_us = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_transferDelay_us_get, doc=)
static

An enumerated integer property which can be used to configure whether the transfer delay(us) information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
  • This feature currently is only available for mvBlueFOX devices

◆ triggerCounterAcquisitionStart

triggerCounterAcquisitionStart = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_triggerCounterAcquisitionStart_get, doc=)
static

An enumerated integer property which can be used to configure whether the trigger counter at acquisition start information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
  • This feature currently is only available for mvHYPERION devices

◆ triggerCounterFrameStart

triggerCounterFrameStart = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_triggerCounterFrameStart_get, doc=)
static

An enumerated integer property which can be used to configure whether the trigger counter at frame start information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
  • This feature currently is only available for mvHYPERION devices

◆ userData

userData = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_userData_get, doc=)
static

An enumerated integer property which can be used to configure whether the user data information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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

Note
This feature currently is only available for mvVirtual devices.

◆ videoChannel

videoChannel = property(lib_mvIMPACT_acquire.RequestInfoConfiguration_videoChannel_get, doc=)
static

An enumerated integer property which can be used to configure whether the video channel information shall be attached to the resulting mvIMPACT.acquire.Request objects.

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