ImageRequestControl Class Reference

A helper class to control the way an image request will be processed. More...

Inheritance diagram for ImageRequestControl:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.ImageRequestControl object.

Properties
	imageCount = property(lib_mvIMPACT_acquire.ImageRequestControl_imageCount_get, doc=)
	An integer property defining the number of images to capture with each request.
	mode = property(lib_mvIMPACT_acquire.ImageRequestControl_mode_get, doc=)
	The mode this object shall be operated in.
	requestQueue = property(lib_mvIMPACT_acquire.ImageRequestControl_requestQueue_get, doc=)
	An integer property defining to which request queue the image request will be sent.
	requestToUse = property(lib_mvIMPACT_acquire.ImageRequestControl_requestToUse_get, doc=)
	An integer property defining which request object shall be used for the next image request.
	resultQueue = property(lib_mvIMPACT_acquire.ImageRequestControl_resultQueue_get, doc=)
	An integer property defining to which result queue the resulting image will be sent after the acquisition.
	setting = property(lib_mvIMPACT_acquire.ImageRequestControl_setting_get, doc=)
	An integer property defining which setting will be used for the acquisition.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

A helper class to control the way an image request will be processed.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.ImageRequestControl object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
name	[in] The name of the driver internal image request control to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableImageRequestControls, new image request controls can be created with the function mvIMPACT.acquire.FunctionInterface.createImageRequestControl

Reimplemented from ComponentCollection.

Property Documentation

imageCount

imageCount = property(lib_mvIMPACT_acquire.ImageRequestControl_imageCount_get, doc=)

static

An integer property defining the number of images to capture with each request.

Note

This property will currently have no effect.

mode

mode = property(lib_mvIMPACT_acquire.ImageRequestControl_mode_get, doc=)

static

The mode this object shall be operated in.

Valid values for this property may be: mvIMPACT.acquire.ircmManual, mvIMPACT.acquire.ircmLive, mvIMPACT.acquire.ircmCounting, mvIMPACT.acquire.ircmTrial, mvIMPACT.acquire.ircmUpdateBufferLayout.

This property can e.g. be used to prepare internal data structures without requesting a 'real' image from the hardware. This can be useful when the image dimensions must be known before the first image is captured.

pDev = getDeviceFromSomewhere()
irc = ImageRequestControl(pDev)
irc.mode.write(acquire.ircmTrial) # set to prepare mode
fi = FunctionInterface(pDev)
fi.imageRequestSingle(irc) # request dummy image
reqNr = fi.imageRequestWaitFor(500)
# waitFor will return as fast as possible. No 'real' image will be taken
# but a request object that contains a dummy image with the format, dimensions
# and other information will be returned that is (apart from the pixel data)
# similar to any 'real' image that would be captured with the current settings

requestQueue

requestQueue = property(lib_mvIMPACT_acquire.ImageRequestControl_requestQueue_get, doc=)

static

An integer property defining to which request queue the image request will be sent.

This property defines the stream channel requests associated with this request control instance will be sent to.

The maximum value for this feature corresponds to the number of independent stream channels offered by the device. Only devices operated in interface layout mvIMPACT.acquire.dilGenICam may offer more than one stream channel. Therefore the default value and the default maximum and minimum value will be 0 for most devices.

Since

2.47.0

requestToUse

requestToUse = property(lib_mvIMPACT_acquire.ImageRequestControl_requestToUse_get, doc=)

static

An integer property defining which request object shall be used for the next image request.

This is an advanced feature that should only be used if needed. A value smaller than 0 will result in an automatic mode. This is the default behaviour and the driver will decide which buffer to use next then.

A request can only be sent to the driver once. Until this request is returned to the user it can't be sent again thus this property must be changed for each request if multiple requests shall be sent to the capture queue.

resultQueue

resultQueue = property(lib_mvIMPACT_acquire.ImageRequestControl_resultQueue_get, doc=)

static

An integer property defining to which result queue the resulting image will be sent after the acquisition.

setting

setting = property(lib_mvIMPACT_acquire.ImageRequestControl_setting_get, doc=)

static

An integer property defining which setting will be used for the acquisition.

This property defines a translation dictionary. It maps the name of the setting (the parameter passed to the function mvIMPACT.acquire.FunctionInterface.createSetting) to the actual underlying handle of the request. Therefore either the name or the handle of the setting can be used to set this property to the desired value.

thisown

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

static