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

#include <mvIMPACT_acquire_GenICam.h>

Inheritance diagram for mvFFCControl:

Public Member Functions
HOBJ	hObj (void) const
	Returns a unique identifier for the component collection referenced by this object.

	mvFFCControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
	Constructs a new mvIMPACT::acquire::GenICam::mvFFCControl object.

const ComponentCollection &	restoreDefault (void) const
	Restores the default for every component of this collection.

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

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

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

PropertyIBoolean	mvFFCEnable
	A boolean property. Enables the Flat Field Correction.

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

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

Protected Attributes
HOBJ	m_hRoot

Detailed Description

Contains features to control the devices Flat Field Correction parameters.

Constructor & Destructor Documentation

◆ mvFFCControl()

mvFFCControl	(	mvIMPACT::acquire::Device *	pDev,
		const std::string &	settingName = "Base" )

inlineexplicit

Constructs a new mvIMPACT::acquire::GenICam::mvFFCControl object.

Parameters

[in]	pDev	A pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::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 mvIMPACT::acquire::FunctionInterface::getAvailableSettings, new settings can be created with the function mvIMPACT::acquire::FunctionInterface::createSetting

Member Function Documentation

◆ hObj()

HOBJ hObj ( void ) const

inlineinherited

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

const ComponentCollection & restoreDefault ( void ) const

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.

Returns: A const reference to the component.

Member Data Documentation

◆ m_hRoot

HOBJ m_hRoot

protectedinherited

◆ mvFFCAutoLoadMode

PropertyI64 mvFFCAutoLoadMode

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

◆ mvFFCCalibrate

Method mvFFCCalibrate

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

Starts the Calibration of the Flat Field Correction.

◆ mvFFCCalibrationImageCount

PropertyI64 mvFFCCalibrationImageCount

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

PropertyIBoolean mvFFCEnable

A boolean property. Enables the Flat Field Correction.

Enables the Flat Field Correction.

◆ mvFFCImageLoad

Method mvFFCImageLoad

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

Loads the Flat Field Correction image from flash.

◆ mvFFCImageSave

Method mvFFCImageSave

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

Saves the calibrated Flat Field Correction image to flash.

Public Member Functions

Public Attributes

Protected Attributes