mvFFCControl Class Reference

Contains features to control the devices Flat Field Correction parameters. More...

Inheritance diagram for mvFFCControl:

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.
	mvFFCControl (mv.impact.acquire.Device device)
	Constructs a new mv.impact.acquire.GenICam.mvFFCControl object.
	mvFFCControl (mv.impact.acquire.Device device, System.String settingName)
	Constructs a new mv.impact.acquire.GenICam.mvFFCControl object.
void	restoreDefault ()
	Restores the default for every component of this collection.

Public Attributes
readonly mv.impact.acquire.PropertyI64	mvFFCAutoLoadMode = new mv.impact.acquire.PropertyI64()
	An enumerated integer property. Selects whether FFC image shall be automatically loaded at camera startup.
readonly mv.impact.acquire.Method	mvFFCCalibrate = new mv.impact.acquire.Method()
	A method object. Starts the Calibration of the Flat Field Correction.
readonly mv.impact.acquire.PropertyI64	mvFFCCalibrationImageCount = new mv.impact.acquire.PropertyI64()
	An integer property. The number of images to use for the calculation of the correction image.
readonly mv.impact.acquire.PropertyIBoolean	mvFFCEnable = new mv.impact.acquire.PropertyIBoolean()
	A boolean property. Enables the Flat Field Correction.
readonly mv.impact.acquire.Method	mvFFCImageLoad = new mv.impact.acquire.Method()
	A method object. Loads the Flat Field Correction image from flash.
readonly mv.impact.acquire.Method	mvFFCImageSave = new mv.impact.acquire.Method()
	A method object. Saves the calibrated Flat Field Correction image to flash.

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

Contains features to control the devices Flat Field Correction parameters.

Contains features to control the devices Flat Field Correction parameters.

Constructor & Destructor Documentation

mvFFCControl() [1/2]

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

inline

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

Parameters

[in]

device

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

mvFFCControl() [2/2]

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

inline

Constructs a new mv.impact.acquire.GenICam.mvFFCControl 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 framework's 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 framework's 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

mvFFCAutoLoadMode

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

An enumerated integer property. Selects whether FFC image shall be automatically loaded at camera startup.

Selects whether FFC image shall be automatically loaded at camera startup.

The following string values might be valid for this feature:

• mvLegacy (Display string: 'mv Legacy'): FFC image will be automatically loaded and saved after calibration. Should no longer be used. Be careful that You do not lose calibrated FFC images(deprecated)
• Off (Display string: 'Off'): FFC image will not be automatically loaded at startup. Use this for short boot times.
• On (Display string: 'On'): FFC image will be automatically loaded at startup. Boot time will increase accordingly.

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.

mvFFCCalibrate

readonly mv.impact.acquire.Method mvFFCCalibrate = new mv.impact.acquire.Method()

A method object. Starts the Calibration of the Flat Field Correction.

Starts the Calibration of the Flat Field Correction.

mvFFCCalibrationImageCount

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

An integer property. The number of images to use for the calculation of the correction image.

The number of images to use for the calculation of the correction image.

mvFFCEnable

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

A boolean property. Enables the Flat Field Correction.

Enables the Flat Field Correction.

mvFFCImageLoad

readonly mv.impact.acquire.Method mvFFCImageLoad = new mv.impact.acquire.Method()

A method object. Loads the Flat Field Correction image from flash.

Loads the Flat Field Correction image from flash.

mvFFCImageSave

readonly mv.impact.acquire.Method mvFFCImageSave = new mv.impact.acquire.Method()

A method object. Saves the calibrated Flat Field Correction image to flash.

Saves the calibrated Flat Field Correction image to flash.

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 framework's 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 framework's 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.