A class to handle the digital inputs and outputs for frame grabber devices(Device specific interface layout only) (deprecated. More...

Inheritance diagram for IOSubSystemFrameGrabber:

[legend]

Public Member Functions
	__init__ (self, args, *kwargs)
	getHDOutputCount (self)
	Returns the number of available HD output pins for the mvIMPACT.acquire.Device associated with this object.
	getInput (self, nr)
	Returns a const pointer to a mvIMPACT.acquire.DigitalInput object.
	getInputCount (self)
	Returns the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.
	getOutput (self, nr)
	Returns a pointer to a mvIMPACT.acquire.DigitalOutput object.
	getOutputCount (self)
	Returns the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.
	getPulseStartConfiguration (self, nr)
	Returns a pointer to a mvIMPACT.acquire.PulseStartConfiguration associated with this device.
	getPulseStartConfigurationCount (self)
	Returns the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.
	getRTCtrProgram (self, nr)
	Returns a pointer to a mvIMPACT.acquire.RTCtrProgram associated with this device.
	getRTCtrProgramCount (self)
	Returns the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.
	getVDOutputCount (self)
	Returns the number of available VD output pins for the mvIMPACT.acquire.Device associated with this object.
	HDOutput (self, nr)
	Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a HD output for this device.
	readInputRegister (self)
	Returns the current state of the digital input register.
	readOutputRegister (self)
	Returns the current state of the digital output register.
	VDOutput (self, nr)
	Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a VD output for this device.
	writeOutputRegister (self, *args)
	Alters the state of the digital output register.

Properties
	hDOutputCount = property (getHDOutputCount, None, None, None)
	An integer property (read-only) which holds the number of available HD output pins for the mvIMPACT.acquire.Device associated with this object.
	inputCount = property (getInputCount, None, None, None)
	An integer property (read-only) which holds the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.
	outputCount = property (getOutputCount, None, None, None)
	An integer property (read-only) which holds the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.
	pulseStartConfigurationCount = property (getPulseStartConfigurationCount, None, None, None)
	An integer property (read-only) which holds the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.
	RTCtrProgramCount = property (getRTCtrProgramCount, None, None, None)
	An integer property (read-only) which holds the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.
	syncOutputMode = property(lib_mvIMPACT_acquire.IOSubSystemFrameGrabber_syncOutputMode_get, doc=)
	An enumerated integer property defining the current mode for sync.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	vDOutputCount = property (getVDOutputCount, None, None, None)
	An integer property (read-only) which holds the number of available VD output pins for the mvIMPACT.acquire.Device associated with this object.

Detailed Description

A class to handle the digital inputs and outputs for frame grabber devices(Device specific interface layout only) (deprecated.

Deprecated: Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

This class provides a convenient basic access to the digital inputs and outputs of a frame grabber device.

Note: The number of digital inputs and outputs available will vary significantly from device to device. Some devices might not even have digital inputs and/or digital outputs. Therefore it's crucial to check for available pins before using them. The corresponding functions to do that can be found in the base class mvIMPACT.acquire.IOSubSystem.

To create more complex digital output related signals the class mvIMPACT.acquire.OutputSignalGeneratorFrameGrabber should be used.

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,
		**	kwargs )

Member Function Documentation

◆ getHDOutputCount()

getHDOutputCount ( self )

Returns the number of available HD output pins for the mvIMPACT.acquire.Device associated with this object.

◆ getInput()

getInput	(		self,
			nr )

inherited

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

Note: The possibility to access the digital inputs of a device as single objects is just provided for convenience. The same thing can be achieved by calling the function mvIMPACT.acquire.IOSubSystem.readInputRegister.

Parameters

nr	[in] The number of the digital input.

◆ getInputCount()

getInputCount ( self )

inherited

Returns the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.

◆ getOutput()

getOutput	(		self,
			nr )

inherited

Returns a pointer to a mvIMPACT.acquire.DigitalOutput object.

Note: The possibility to access the digital outputs of a device as single objects is just provided for convenience. The same thing can be achieved by calling the function mvIMPACT.acquire.IOSubSystem.writeOutputRegister with the corresponding bit mask.

Parameters

nr	[in] The number of the digital output.

◆ getOutputCount()

getOutputCount ( self )

inherited

Returns the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.

◆ getPulseStartConfiguration()

getPulseStartConfiguration	(		self,
			nr )

inherited

Returns a pointer to a mvIMPACT.acquire.PulseStartConfiguration associated with this device.

Parameters

nr	[in] The number of the pulse start configuration to return

◆ getPulseStartConfigurationCount()

getPulseStartConfigurationCount ( self )

inherited

Returns the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.

◆ getRTCtrProgram()

getRTCtrProgram	(		self,
			nr )

inherited

Returns a pointer to a mvIMPACT.acquire.RTCtrProgram associated with this device.

Parameters

nr	[in] The number of the real time controller program to return

◆ getRTCtrProgramCount()

getRTCtrProgramCount ( self )

inherited

Returns the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.

◆ getVDOutputCount()

getVDOutputCount ( self )

Returns the number of available VD output pins for the mvIMPACT.acquire.Device associated with this object.

◆ HDOutput()

HDOutput	(		self,
			nr )

Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a HD output for this device.

nr MUST be a valid number ( larger or equal than 0 and smaller than the value returned by mvIMPACT.acquire.IOSubSystemFrameGrabber.getHDOutputCount.

Returns: A pointer to a mvIMPACT.acquire.SyncOutput object.

Parameters

nr	[in] The number of the HD output to return.

◆ readInputRegister()

readInputRegister ( self )

inherited

Returns the current state of the digital input register.

This function can be used to read all digital inputs as a single value. Each bit represents the status of one digital output pin.

EXAMPLE

A value of '3' returned by this function means that digital inputs 0 and 1 are currently have a voltage considered as logical '1' applied to them.

◆ readOutputRegister()

readOutputRegister ( self )

inherited

Returns the current state of the digital output register.

This function can be used to read all digital outputs as a single value. Each bit represents the status of one digital output pin.

EXAMPLE

A value of '3' returned by this function means that digital output 0 and 1 are currently set to high.

◆ VDOutput()

VDOutput	(		self,
			nr )

Returns a pointer to a mvIMPACT.acquire.SyncOutput object that represents a VD output for this device.

nr MUST be a valid number ( larger or equal than 0 and smaller than the value returned by mvIMPACT.acquire.IOSubSystemFrameGrabber.getVDOutputCount.

Returns: A pointer to a mvIMPACT.acquire.SyncOutput object.

Parameters

nr	[in] The number of the VD output to return.

◆ writeOutputRegister()

writeOutputRegister	(		self,
		*	args )

inherited

Alters the state of the digital output register.

This function can be used to alter the state of certain (or all) digital outputs with a single function call. By working with the parameter mask certain bits can remain unaffected.

EXAMPLE

If the previous state of a digital output register was '5', which means that outputs 0 and 2 are set to high a call to mvIMPACT.acquire.IOSubSystem.writeOutputRegister with value set to 2 and mask set to 3 would result in '6' as the new value for the output register. Pin 2 will remain unaffected, as mask states just to modify pin 0 and 1 ( 3 = 00000011 binary ).

Parameters

value	[in] The value to be applied to the output register
mask	[in] The mask to specify which pins to modify. A bit set to '1' in this parameter means that the state of this output has to adopt its style according to the value in value.

Reimplemented from IOSubSystem.

Property Documentation

◆ hDOutputCount

hDOutputCount = property (getHDOutputCount, None, None, None)

static

An integer property (read-only) which holds the number of available HD output pins for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystemFrameGrabber.getHDOutputCount()

◆ inputCount

inputCount = property (getInputCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of mvIMPACT.acquire.DigitalInput s available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getInputCount()

◆ outputCount

outputCount = property (getOutputCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of digital outputs available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getOutputCount()

◆ pulseStartConfigurationCount

pulseStartConfigurationCount = property (getPulseStartConfigurationCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of mvIMPACT.acquire.PulseStartConfiguration objects available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getPulseStartConfigurationCount()

◆ RTCtrProgramCount

RTCtrProgramCount = property (getRTCtrProgramCount, None, None, None)

staticinherited

An integer property (read-only) which holds the number of mvIMPACT.acquire.RTCtrProgram s available for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystem.getRTCtrProgramCount()

◆ syncOutputMode

syncOutputMode = property(lib_mvIMPACT_acquire.IOSubSystemFrameGrabber_syncOutputMode_get, doc=)

static

An enumerated integer property defining the current mode for sync.

signal creation.

Sometimes it's desired to create a signal to sync. cameras connected to a capture device. E.g. when capturing 3 monochrome cameras in parallel these should be synchronized. Therefore some devices can create HD and VD signals that synchronize the connected cameras.

To create sync. signals this property must be set either to mvIMPACT.acquire.dsomNonInterlaced or mvIMPACT.acquire.dsomInterlaced.

In interlaced mode only the frequency of the VD signals can be modified, while in non-interlaced mode the width (in percent) the signal stays low can be modified as well.

Now e.g. to sync. two or more CCIR compliant cameras connected to a capture device that can create sync. signals, the HD signals must be generated with a CCIR compliant frequency. The function mvIMPACT.acquire.IOSubSystemFrameGrabber.HDOutput can be used to access the desired output pin. Then its property mvIMPACT.acquire.SyncOutput.frequency_Hz is set to 15625 Hz (CCIR standard). The remaining values can be left untouched. The capture device will no generate HD signals with the desired frequency and VD outputs with the frequency stored by the property mvIMPACT.acquire.SyncOutput.frequency_Hz belonging to the pointer to the object returned by a call to mvIMPACT.acquire.IOSubSystemFrameGrabber.VDOutput.

◆ thisown

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

static

◆ vDOutputCount

vDOutputCount = property (getVDOutputCount, None, None, None)

static

An integer property (read-only) which holds the number of available VD output pins for the mvIMPACT.acquire.Device associated with this object.

See mvIMPACT.acquire.IOSubSystemFrameGrabber.getVDOutputCount()

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ getHDOutputCount()

◆ getInput()

◆ getInputCount()

◆ getOutput()

◆ getOutputCount()

◆ getPulseStartConfiguration()

◆ getPulseStartConfigurationCount()

◆ getRTCtrProgram()

◆ getRTCtrProgramCount()

◆ getVDOutputCount()

◆ HDOutput()

◆ readInputRegister()

◆ readOutputRegister()

◆ VDOutput()

◆ writeOutputRegister()

Property Documentation

◆ hDOutputCount

◆ inputCount

◆ outputCount

◆ pulseStartConfigurationCount

◆ RTCtrProgramCount

◆ syncOutputMode

◆ thisown

◆ vDOutputCount

◆ init()