mvFrameAverageControl Class Reference

Category that contains features to control the frame averaging engine. More...

Inheritance diagram for mvFrameAverageControl:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.mvFrameAverageControl object.
	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.

Properties
	mvFrameAverageDynamicMode = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageDynamicMode_get, doc=)
	An enumerated integer property.
	mvFrameAverageEnable = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageEnable_get, doc=)
	A boolean property.
	mvFrameAverageFrameCount = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageFrameCount_get, doc=)
	An integer property.
	mvFrameAverageMode = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageMode_get, doc=)
	An enumerated integer property.
	mvFrameAverageNoiseGain = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageNoiseGain_get, doc=)
	An integer property.
	mvFrameAverageNoiseLimit = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageNoiseLimit_get, doc=)
	An integer property.
	mvFrameAverageSlope = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageSlope_get, doc=)
	An integer property.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Detailed Description

Category that contains features to control the frame averaging engine.

A category that contains features to control the frame averaging engine.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.mvFrameAverageControl 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

Member Function Documentation

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.

Property Documentation

mvFrameAverageDynamicMode

mvFrameAverageDynamicMode = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageDynamicMode_get, doc=)

static

An enumerated integer property.

Sets the frame average dynamic operating mode.

Sets the frame average dynamic operating mode.

The following string values might be valid for this feature:

• mvStandard (Display string: 'mv Standard')
• mvGauss (Display string: 'mv Gauss')

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvFrameAverageEnable

mvFrameAverageEnable = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageEnable_get, doc=)

static

A boolean property.

Enables the frame averaging engine.

Enables the frame averaging engine.

mvFrameAverageFrameCount

mvFrameAverageFrameCount = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageFrameCount_get, doc=)

static

An integer property.

Here you specify the frame count used for the calculation of the frame average.

Here you specify the frame count used for the calculation of the frame average.

mvFrameAverageMode

mvFrameAverageMode = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageMode_get, doc=)

static

An enumerated integer property.

Sets the frame average operating mode.

Sets the frame average operating mode.

The following string values might be valid for this feature:

• mvPlain (Display string: 'mv Plain')
• mvDynamic (Display string: 'mv Dynamic')
• mvNTo1 (Display string: 'mv N To 1')

Note

Depending on the device some of these values might not be supported and especially when working with third party devices there might be custom values which are not listed here. To get a complete and reliable list of supported values at runtime an application should therefore call mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvFrameAverageNoiseGain

mvFrameAverageNoiseGain = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageNoiseGain_get, doc=)

static

An integer property.

Here you specify the noise border for very bright pictures.

Here you specify the noise border for very bright pictures.

mvFrameAverageNoiseLimit

mvFrameAverageNoiseLimit = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageNoiseLimit_get, doc=)

static

An integer property.

Here you specify the noise limit for very bright pictures.

Here you specify the noise limit for very bright pictures.

mvFrameAverageSlope

mvFrameAverageSlope = property(lib_mvIMPACT_acquire.mvFrameAverageControl_mvFrameAverageSlope_get, doc=)

static

An integer property.

Here you specify the noise border for very dark pictures.

Here you specify the noise border for very dark pictures.

thisown

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

static