mvFrameAverageControl Class Reference

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

Inheritance diagram for mvFrameAverageControl:

Public Member Functions
synchronized void	delete ()
PropertyI64	getMvFrameAverageDynamicMode ()
	An enumerated integer property.
PropertyI	getMvFrameAverageEnable ()
	A boolean property.
PropertyI64	getMvFrameAverageFrameCount ()
	An integer property.
PropertyI64	getMvFrameAverageMode ()
	An enumerated integer property.
PropertyI64	getMvFrameAverageNoiseGain ()
	An integer property.
PropertyI64	getMvFrameAverageNoiseLimit ()
	An integer property.
PropertyI64	getMvFrameAverageSlope ()
	An integer property.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	mvFrameAverageControl (Device pDev)
	Constructs a new mvIMPACT.acquire.mvFrameAverageControl object.
	mvFrameAverageControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.mvFrameAverageControl object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	mvFrameAverageControl (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (mvFrameAverageControl obj)

Protected Attributes
transient boolean	swigCMemOwn

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

mvFrameAverageControl() [1/3]

mvFrameAverageControl ( long cPtr, boolean cMemoryOwn )

protected

mvFrameAverageControl() [2/3]

mvFrameAverageControl	(	Device	pDev,
		String	settingName )

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

mvFrameAverageControl() [3/3]

mvFrameAverageControl

(

Device

pDev

)

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. 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

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getMvFrameAverageDynamicMode()

PropertyI64 getMvFrameAverageDynamicMode

(

)

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.

getMvFrameAverageEnable()

PropertyI getMvFrameAverageEnable

(

)

A boolean property.

Enables the frame averaging engine.

Enables the frame averaging engine.

getMvFrameAverageFrameCount()

PropertyI64 getMvFrameAverageFrameCount

(

)

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.

getMvFrameAverageMode()

PropertyI64 getMvFrameAverageMode

(

)

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.

getMvFrameAverageNoiseGain()

PropertyI64 getMvFrameAverageNoiseGain

(

)

An integer property.

Here you specify the noise border for very bright pictures.

Here you specify the noise border for very bright pictures.

getMvFrameAverageNoiseLimit()

PropertyI64 getMvFrameAverageNoiseLimit

(

)

An integer property.

Here you specify the noise limit for very bright pictures.

Here you specify the noise limit for very bright pictures.

getMvFrameAverageSlope()

PropertyI64 getMvFrameAverageSlope

(

)

An integer property.

Here you specify the noise border for very dark pictures.

Here you specify the noise border for very dark pictures.

hObj()

int hObj ( )

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()

ComponentCollection restoreDefault ( )

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.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( mvFrameAverageControl obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited