TriggerControl Class Reference

A class to configure the behaviour of trigger signals. More...

Inheritance diagram for TriggerControl:

Public Member Functions
	__init__ (self, *args, **kwargs)
	getDescription (self)
	Returns a name of the trigger being configured.
	hObj (self)
	Returns a unique identifier for the component collection referenced by this object.
	restoreDefault (self)
	Restores the default for every component of this collection.
	triggerSoftware (self)
	Generates of software trigger command.

Properties
	description = property (getDescription, None, None, None)
	A string property (read-only) which holds the name of the trigger being configured.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	triggerActivation = property(lib_mvIMPACT_acquire.TriggerControl_triggerActivation_get, doc=)
	An enumerated 64 bit integer property that defines the start condition for the selected trigger.
	triggerDelayAbs_us = property(lib_mvIMPACT_acquire.TriggerControl_triggerDelayAbs_us_get, doc=)
	Specifies the absolute delay in microseconds (us) to apply after the trigger reception before effectively activating it.
	triggerDelayLines = property(lib_mvIMPACT_acquire.TriggerControl_triggerDelayLines_get, doc=)
	Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it.
	triggerDivider = property(lib_mvIMPACT_acquire.TriggerControl_triggerDivider_get, doc=)
	An integer property used to divide the number of incoming trigger pulses by an integer factor.
	triggerMode = property(lib_mvIMPACT_acquire.TriggerControl_triggerMode_get, doc=)
	Defines if the selected trigger is active.
	triggerOverlap = property(lib_mvIMPACT_acquire.TriggerControl_triggerOverlap_get, doc=)
	Specifies the type trigger overlap permitted with the previous frame.
	triggerSource = property(lib_mvIMPACT_acquire.TriggerControl_triggerSource_get, doc=)
	Defines the signal that will cause the trigger event.

Detailed Description

A class to configure the behaviour of trigger signals.

Features in this class will open up a more flexible way to configure certain trigger events for devices then the previous features('triggerInterface', 'triggerSource' and 'triggerMode' used.

Note

Not ever device will support every property listed in this class for every trigger mode. Always call mvIMPACT.acquire.Component.isValid to check whether a feature is available or not before using it. Otherwise an exception will be generated.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args,
		**	kwargs )

Member Function Documentation

getDescription()

getDescription

(

self

)

Returns a name of the trigger being configured.

hObj()

hObj ( self )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

restoreDefault ( self )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

triggerSoftware()

triggerSoftware

(

self

)

Generates of software trigger command.

Returns

• mvIMPACT.acquire.DMR_NO_ERROR if successful.
• A negative error code as listed here: Error code list .

Property Documentation

description

description = property (getDescription, None, None, None)

static

A string property (read-only) which holds the name of the trigger being configured.

See mvIMPACT.acquire.TriggerControl.getDescription()

thisown

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

static

triggerActivation

triggerActivation = property(lib_mvIMPACT_acquire.TriggerControl_triggerActivation_get, doc=)

static

An enumerated 64 bit integer property that defines the start condition for the selected trigger.

Valid value will be 'RisingEdge', 'FallingEdge', 'AnyEdge', 'LevelLow' or 'LevelHigh'.

triggerDelayAbs_us

triggerDelayAbs_us = property(lib_mvIMPACT_acquire.TriggerControl_triggerDelayAbs_us_get, doc=)

static

Specifies the absolute delay in microseconds (us) to apply after the trigger reception before effectively activating it.

triggerDelayLines

triggerDelayLines = property(lib_mvIMPACT_acquire.TriggerControl_triggerDelayLines_get, doc=)

static

Specifies the absolute delay in lines to apply after the trigger reception before effectively activating it.

triggerDivider

triggerDivider = property(lib_mvIMPACT_acquire.TriggerControl_triggerDivider_get, doc=)

static

An integer property used to divide the number of incoming trigger pulses by an integer factor.

E.g. setting this value to 2 would generate 5 internal trigger events from a 10 Hz external signal.

triggerMode

triggerMode = property(lib_mvIMPACT_acquire.TriggerControl_triggerMode_get, doc=)

static

Defines if the selected trigger is active.

triggerOverlap

triggerOverlap = property(lib_mvIMPACT_acquire.TriggerControl_triggerOverlap_get, doc=)

static

Specifies the type trigger overlap permitted with the previous frame.

This defines when a valid trigger will be accepted (or latched) for a new frame. Valid values for this property may be: mvIMPACT.acquire.dtoOff, mvIMPACT.acquire.dtoReadOut, mvIMPACT.acquire.dtoPreviousFrame.

triggerSource

triggerSource = property(lib_mvIMPACT_acquire.TriggerControl_triggerSource_get, doc=)

static

Defines the signal that will cause the trigger event.

Currently this property will define a translation dictionary that can e.g. be queried via a call to mvIMPACT.acquire.PropertyI64.getTranslationDict. The resulting translation dictionary can be used to select the desired trigger source either via a string or the associated 64 bit integer value.