mvFrameAverageControl Class Reference

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

Inheritance diagram for mvFrameAverageControl:

Public Member Functions
IEnumerable< T >	getEnumerable< T > ()
	Returns an enumerator of a certain type that iterates through the collection.
IEnumerator< int >	GetEnumerator ()
	Returns an enumerator that iterates through the collection.
	mvFrameAverageControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.mvFrameAverageControl object.
	mvFrameAverageControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.mvFrameAverageControl object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly mv.impact.acquire.PropertyI64	mvFrameAverageDynamicMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Sets the frame average dynamic operating mode.
readonly mv.impact.acquire.PropertyIBoolean	mvFrameAverageEnable = new mv.impact.acquire.PropertyIBoolean()
	A boolean property. Enables the frame averaging engine.
readonly mv.impact.acquire.PropertyI64	mvFrameAverageFrameCount = new mv.impact.acquire.PropertyI64()
	An integer property. Here you specify the frame count used for the calculation of the frame average.
readonly mv.impact.acquire.PropertyI64	mvFrameAverageMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Sets the frame average operating mode.
readonly mv.impact.acquire.PropertyI64	mvFrameAverageNoiseGain = new mv.impact.acquire.PropertyI64()
	An integer property. Here you specify the noise border for very bright pictures.
readonly mv.impact.acquire.PropertyI64	mvFrameAverageNoiseLimit = new mv.impact.acquire.PropertyI64()
	An integer property. Here you specify the noise limit for very bright pictures.
readonly mv.impact.acquire.PropertyI64	mvFrameAverageSlope = new mv.impact.acquire.PropertyI64()
	An integer property. Here you specify the noise border for very dark pictures.

Properties
IEnumerable< Component >	componentEnumerable [get]
	Returns an enumerator that iterates through the collection.
IEnumerable< ComponentList >	componentListEnumerable [get]
	Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.
int	hObj [get]
	Returns a unique identifier for the component collection referenced by this object.

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/2]

mvFrameAverageControl ( mv::impact::acquire::Device device )

inline

Constructs a new mv.impact.acquire.GenICam.mvFrameAverageControl object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

mvFrameAverageControl() [2/2]

mvFrameAverageControl ( mv::impact::acquire::Device device, System::String settingName )

inline

Constructs a new mv.impact.acquire.GenICam.mvFrameAverageControl object.

Parameters

[in]	device	A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.
[in]	settingName	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 mv.impact.acquire.FunctionInterface.availableSettings, new settings can be created with the function mv.impact.acquire.FunctionInterface.createSetting

Member Function Documentation

getEnumerable< T >()

IEnumerable< T > getEnumerable< T > ( )

inlineinherited

Returns an enumerator of a certain type that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Property c in info.getEnumerable<Property>())
{
  validateProperty(c);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

GetEnumerator()

IEnumerator< int > GetEnumerator ( )

inlineinherited

Returns an enumerator that iterates through the collection.

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

restoreDefault()

void restoreDefault ( )

inlineinherited

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.

Member Data Documentation

mvFrameAverageDynamicMode

readonly mv.impact.acquire.PropertyI64 mvFrameAverageDynamicMode = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvFrameAverageEnable

readonly mv.impact.acquire.PropertyIBoolean mvFrameAverageEnable = new mv.impact.acquire.PropertyIBoolean()

A boolean property. Enables the frame averaging engine.

Enables the frame averaging engine.

mvFrameAverageFrameCount

readonly mv.impact.acquire.PropertyI64 mvFrameAverageFrameCount = new mv.impact.acquire.PropertyI64()

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

readonly mv.impact.acquire.PropertyI64 mvFrameAverageMode = new mv.impact.acquire.PropertyI64()

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 mv.impact.acquire.EnumPropertyI<T>.listOfValidStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvFrameAverageNoiseGain

readonly mv.impact.acquire.PropertyI64 mvFrameAverageNoiseGain = new mv.impact.acquire.PropertyI64()

An integer property. Here you specify the noise border for very bright pictures.

Here you specify the noise border for very bright pictures.

mvFrameAverageNoiseLimit

readonly mv.impact.acquire.PropertyI64 mvFrameAverageNoiseLimit = new mv.impact.acquire.PropertyI64()

An integer property. Here you specify the noise limit for very bright pictures.

Here you specify the noise limit for very bright pictures.

mvFrameAverageSlope

readonly mv.impact.acquire.PropertyI64 mvFrameAverageSlope = new mv.impact.acquire.PropertyI64()

An integer property. Here you specify the noise border for very dark pictures.

Here you specify the noise border for very dark pictures.

Property Documentation

componentEnumerable

IEnumerable<Component> componentEnumerable

getinherited

Returns an enumerator that iterates through the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (Component c in info.componentEnumerable)
{
  Console.WriteLine("{0}", c.name);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

componentListEnumerable

IEnumerable<ComponentList> componentListEnumerable

getinherited

Returns an enumerator that iterates through all the mv.impact.acquire.ComponentList elements in the collection.

This interface will allow to e.g. write code like this:

Info info = new Info(pDev);
foreach (ComponentList cl in info.componentListEnumerable)
{
  Console.WriteLine("{0}", cl.name);
}

See the frameworks documentation about the System.Collections.IEnumerable interface for more information.

Returns

An enumerator that iterates through the collection

hObj

int hObj

getinherited

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

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

Returns

A unique identifier for the component referenced by this object.