mvIMPACT Acquire SDK C++
mvDefectivePixelCorrectionControl Class Reference

Contains features to control the device's defective pixel correction parameters. More...

Inheritance diagram for mvDefectivePixelCorrectionControl:
ComponentCollection

Public Member Functions

HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 mvDefectivePixelCorrectionControl (mvIMPACT::acquire::Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::GenICam::mvDefectivePixelCorrectionControl object. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 

Public Attributes

PropertyIBoolean mvDefectivePixelBlinkingMode
 A boolean property. Activates the blinking mode of the camera's defective pixel correction. More...
 
PropertyI64 mvDefectivePixelCount
 An integer property. Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry. More...
 
Method mvDefectivePixelDataLoad
 A method object. Loads the defective pixels from device non volatile memory. More...
 
Method mvDefectivePixelDataSave
 A method object. Saves the defective pixels to device non volatile memory. More...
 
PropertyIBoolean mvDefectivePixelEnable
 A boolean property. Activates the camera's defective pixel correction. More...
 
PropertyI64 mvDefectivePixelOffsetX
 An integer property. Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. More...
 
PropertyI64 mvDefectivePixelOffsetY
 An integer property. Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. More...
 
PropertyI64 mvDefectivePixelSelector
 An integer property. Controls the index (offset) of the defective pixel to access. More...
 
PropertyI64 mvDefectPixelThreshold
 An integer property. Sets the threshold for the defect pixel detection. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Contains features to control the device's defective pixel correction parameters.

Contains features to control the device's defective pixel correction parameters.

Constructor & Destructor Documentation

◆ mvDefectivePixelCorrectionControl()

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

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

Parameters
[in]pDevA pointer to a mvIMPACT::acquire::Device object obtained from a mvIMPACT::acquire::DeviceManager object.
[in]settingNameThe 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

◆ mvDefectivePixelBlinkingMode

PropertyIBoolean mvDefectivePixelBlinkingMode

A boolean property. Activates the blinking mode of the camera's defective pixel correction.

Activates the blinking mode of the camera's defective pixel correction.

◆ mvDefectivePixelCount

PropertyI64 mvDefectivePixelCount

An integer property. Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.

Contains the number of valid defective pixels. Increasing this value adds a new empty entry. Decreasing this value deletes the last entry.

◆ mvDefectivePixelDataLoad

Method mvDefectivePixelDataLoad

A method object. Loads the defective pixels from device non volatile memory.

Loads the defective pixels from device non volatile memory.

◆ mvDefectivePixelDataSave

Method mvDefectivePixelDataSave

A method object. Saves the defective pixels to device non volatile memory.

Saves the defective pixels to device non volatile memory.

◆ mvDefectivePixelEnable

PropertyIBoolean mvDefectivePixelEnable

A boolean property. Activates the camera's defective pixel correction.

Activates the camera's defective pixel correction.

◆ mvDefectivePixelOffsetX

PropertyI64 mvDefectivePixelOffsetX

An integer property. Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector.

Returns the horizontal offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.

◆ mvDefectivePixelOffsetY

PropertyI64 mvDefectivePixelOffsetY

An integer property. Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector.

Returns the vertical offset of the defective pixel selected by mvDefectivePixelSelector. This data is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.

◆ mvDefectivePixelSelector

PropertyI64 mvDefectivePixelSelector

An integer property. Controls the index (offset) of the defective pixel to access.

Controls the index (offset) of the defective pixel to access. Data selected by this selector is NOT part of a user set, but must be written to non volatile memory by calling 'mvDefectivePixelDataSave' explicitly.

◆ mvDefectPixelThreshold

PropertyI64 mvDefectPixelThreshold

An integer property. Sets the threshold for the defect pixel detection.

Sets the threshold for the defect pixel detection.


The documentation for this class was generated from the following file: