mvFFCControl Class Reference

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

Inheritance diagram for mvFFCControl:

Public Member Functions
synchronized void	delete ()
PropertyI64	getMvFFCAutoLoadMode ()
	An enumerated integer property.
Method	getMvFFCCalibrate ()
	A method object.
PropertyI64	getMvFFCCalibrationImageCount ()
	An integer property.
PropertyI	getMvFFCEnable ()
	A boolean property.
Method	getMvFFCImageLoad ()
	A method object.
Method	getMvFFCImageSave ()
	A method object.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	mvFFCControl (Device pDev)
	Constructs a new mvIMPACT.acquire.mvFFCControl object.
	mvFFCControl (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.mvFFCControl object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

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

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

Protected Attributes
transient boolean	swigCMemOwn

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

mvFFCControl ( long cPtr, boolean cMemoryOwn )

protected

mvFFCControl() [2/3]

mvFFCControl	(	Device	pDev,
		String	settingName )

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

mvFFCControl() [3/3]

mvFFCControl

(

Device

pDev

)

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

getMvFFCAutoLoadMode()

PropertyI64 getMvFFCAutoLoadMode

(

)

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.

getMvFFCCalibrate()

Method getMvFFCCalibrate

(

)

A method object.

Starts the Calibration of the Flat Field Correction.

Starts the Calibration of the Flat Field Correction.

getMvFFCCalibrationImageCount()

PropertyI64 getMvFFCCalibrationImageCount

(

)

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.

getMvFFCEnable()

PropertyI getMvFFCEnable

(

)

A boolean property.

Enables the Flat Field Correction.

Enables the Flat Field Correction.

getMvFFCImageLoad()

Method getMvFFCImageLoad

(

)

A method object.

Loads the Flat Field Correction image from flash.

Loads the Flat Field Correction image from flash.

getMvFFCImageSave()

Method getMvFFCImageSave

(

)

A method object.

Saves the calibrated Flat Field Correction image to flash.

Saves the calibrated Flat Field Correction image to flash.

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

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited