mvFFCControl Class Reference

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

Inheritance diagram for mvFFCControl:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.mvFFCControl 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
	mvFFCAutoLoadMode = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCAutoLoadMode_get, doc=)
	An enumerated integer property.
	mvFFCCalibrate = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCCalibrate_get, doc=)
	A method object.
	mvFFCCalibrationImageCount = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCCalibrationImageCount_get, doc=)
	An integer property.
	mvFFCEnable = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCEnable_get, doc=)
	A boolean property.
	mvFFCImageLoad = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCImageLoad_get, doc=)
	A method object.
	mvFFCImageSave = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCImageSave_get, doc=)
	A method object.
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

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

__init__()

__init__	(		self,
		*	args )

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

mvFFCAutoLoadMode

mvFFCAutoLoadMode = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCAutoLoadMode_get, doc=)

static

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 mvIMPACT.acquire.PropertyI.getTranslationDictStrings() or one of the other functions dealing with translation dictionaries for enumerated properties.

mvFFCCalibrate

mvFFCCalibrate = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCCalibrate_get, doc=)

static

A method object.

Starts the Calibration of the Flat Field Correction.

Starts the Calibration of the Flat Field Correction.

mvFFCCalibrationImageCount

mvFFCCalibrationImageCount = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCCalibrationImageCount_get, doc=)

static

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

mvFFCEnable = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCEnable_get, doc=)

static

A boolean property.

Enables the Flat Field Correction.

Enables the Flat Field Correction.

mvFFCImageLoad

mvFFCImageLoad = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCImageLoad_get, doc=)

static

A method object.

Loads the Flat Field Correction image from flash.

Loads the Flat Field Correction image from flash.

mvFFCImageSave

mvFFCImageSave = property(lib_mvIMPACT_acquire.mvFFCControl_mvFFCImageSave_get, doc=)

static

A method object.

Saves the calibrated Flat Field Correction image to flash.

Saves the calibrated Flat Field Correction image to flash.

thisown

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

static