mvIMPACT Acquire SDK C++
ImageProcessing Class Reference

Base class for image processing related properties. More...

Inheritance diagram for ImageProcessing:
ComponentCollection

Public Member Functions

GainOffsetKneeChannelParametersgetGainOffsetKneeParameter (unsigned int index) const
 Returns a reference to a set of user definable parameters to configure a certain channel of the GainOffsetKnee filter. More...
 
unsigned int getGainOffsetKneeParameterCount (void) const
 Returns the number of available user definable parameter sets for the GainOffsetKnee filter. More...
 
LUTParametersgetLUTParameter (unsigned int index) const
 Returns a reference to a set of user definable parameters to configure LUT (Look Up Table) operations. More...
 
unsigned int getLUTParameterCount (void) const
 Returns the number of available user definable parameter sets for LUT (Look Up Table) operations. More...
 
MirrorParametersgetMirrorParameter (unsigned int index) const
 Returns a reference to a set of user definable parameters to configure mirror filter related features. More...
 
unsigned int getMirrorParameterCount (void) const
 Returns the number of available user definable parameter sets mirror filter related operations. More...
 
WhiteBalanceSettingsgetWBUserSetting (unsigned int index) const
 Returns a reference to a set of user definable parameters to perform a white balance correction. More...
 
unsigned int getWBUserSettingsCount (void) const
 Returns the number of available user definable parameter sets for white balance correction. More...
 
HOBJ hObj (void) const
 Returns a unique identifier for the component collection referenced by this object. More...
 
 ImageProcessing (const ImageProcessing &src)
 Constructs a new mvIMPACT::acquire::ImageProcessing from an existing one. More...
 
 ImageProcessing (Device *pDev, const std::string &settingName="Base")
 Constructs a new mvIMPACT::acquire::ImageProcessing object. More...
 
ImageProcessingoperator= (const ImageProcessing &rhs)
 Allows assignments of mvIMPACT::acquire::ImageProcessing objects. More...
 
const ComponentCollectionrestoreDefault (void) const
 Restores the default for every component of this collection. More...
 
void setSaturation (double K)
 Sets the saturation by using the color twist matrix. More...
 
virtual ~ImageProcessing ()
 Class destructor. More...
 

Public Attributes

PropertyF adaptiveEdgeSensingPlusSharpenGain
 A floating point property defining the intensity of the sharpening during AdaptiveEdgeSensingPlus deBayering. More...
 
PropertyI adaptiveEdgeSensingPlusSharpenThreshold
 An integer property defining the max. brightness level difference for which sharpening is not applied during AdaptiveEdgeSensingPlus deBayering. More...
 
PropertyIBayerConversionMode bayerConversionMode
 An enumerated integer property defining what kind of algorithm shall be used during Bayer to RGB conversion. More...
 
PropertyI channelSplitChannelIndex
 An integer property which can be used to define which channel of the image shall be extracted. More...
 
PropertyIBoolean channelSplitDeinterlaceEnable
 An enumerated integer property which can be used to enable/disable data re-ordering for interlaced images. More...
 
PropertyIBoolean channelSplitEnable
 An enumerated integer property which can be used to enable/disable automatic data re-ordering or extraction from multi-channel images. More...
 
PropertyIChannelSplitMode channelSplitMode
 An enumerated integer property which can be used to define how data from multi-channel images shall be re-ordered. More...
 
PropertyIColorProcessingMode colorProcessing
 An enumerated integer property defining what kind of color processing shall be applied to the raw image data. More...
 
PropertyIBoolean colorTwistEnable
 An enumerated integer property which can be used to enable/disable the color twist matrix. More...
 
PropertyIBoolean colorTwistInputCorrectionMatrixEnable
 An enumerated integer property which can be used to enable/disable the color twist input correction matrix. More...
 
PropertyIColorTwistInputCorrectionMatrixMode colorTwistInputCorrectionMatrixMode
 An enumerated integer property which can be used to select an input color correction matrix. More...
 
PropertyF colorTwistInputCorrectionMatrixRow0
 The first row of the input color correction matrix. More...
 
PropertyF colorTwistInputCorrectionMatrixRow1
 The second row of the input color correction matrix. More...
 
PropertyF colorTwistInputCorrectionMatrixRow2
 The third row of the input color correction matrix. More...
 
PropertyIBoolean colorTwistOutputCorrectionMatrixEnable
 An enumerated integer property which can be used to enable/disable the color twist output correction matrix. More...
 
PropertyIColorTwistOutputCorrectionMatrixMode colorTwistOutputCorrectionMatrixMode
 An enumerated integer property which can be used to select an output color correction matrix. More...
 
PropertyF colorTwistOutputCorrectionMatrixRow0
 The first row of the output color correction matrix. More...
 
PropertyF colorTwistOutputCorrectionMatrixRow1
 The second row of the output color correction matrix. More...
 
PropertyF colorTwistOutputCorrectionMatrixRow2
 The third row of the output color correction matrix. More...
 
PropertyF colorTwistResultingMatrixRow0
 The first row of the resulting color twist matrix. More...
 
PropertyF colorTwistResultingMatrixRow1
 The second row of the resulting color twist matrix. More...
 
PropertyF colorTwistResultingMatrixRow2
 The third row of the resulting color twist matrix. More...
 
PropertyF colorTwistRow0
 The first row of the color twist matrix. More...
 
PropertyF colorTwistRow1
 The second row of the color twist matrix. More...
 
PropertyF colorTwistRow2
 The third row of the color twist matrix. More...
 
PropertyI darkCurrentFilterCalibrationImageCount
 An integer property defining the number of consecutive images to take into account during calibration of the dark current filter. More...
 
PropertyIDarkCurrentFilterMode darkCurrentFilterMode
 An enumerated integer property defining the operation mode of the dark current filter. More...
 
PropertyI defectivePixelOffsetX
 An integer property defining a list of X-offsets of all pixels currently treated as defective. More...
 
PropertyI defectivePixelOffsetY
 An integer property defining a list of Y-offsets of all pixels currently treated as defective. More...
 
Method defectivePixelReadFromDevice
 Calling this method will download defective pixels from the device. More...
 
PropertyI defectivePixelsFilterColdPixelDeviation_pc
 An integer property defining the max. allowed deviation for a pixel in per cent from the average grey value. More...
 
PropertyI defectivePixelsFilterLeakyPixelDeviation_ADCLimit
 An integer property defining the max. allowed offset from the average grey value for a pixel during calibration. More...
 
PropertyIDefectivePixelsFilterMode defectivePixelsFilterMode
 An enumerated integer property defining the operation mode of the defective pixels filter. More...
 
PropertyI defectivePixelsFound
 An integer property (read-only) containing the number of pixels considered as being defective with respect to the calibration runs executed after the last reset of the calibration data. More...
 
PropertyI defectivePixelsMaxDetectionCount
 An integer property defining maximum the number of pixels considered as being defective during consecutive calibration runs. More...
 
Method defectivePixelWriteToDevice
 Calling this method will upload defective pixels from the device. More...
 
PropertyIImageProcessingFilter filter
 An enumerated integer property defining the filter to be applied to the image before it is transferred to the user. More...
 
PropertyI flatFieldFilterCalibrationAoiHeight
 An integer property defining the calibration AOI's height of the flat field correction filter. More...
 
PropertyIAoiMode flatFieldFilterCalibrationAoiMode
 An enumerated integer property defining the correction AOI mode of the flat field correction filter. More...
 
PropertyI flatFieldFilterCalibrationAoiOffsetX
 An integer property defining the calibration AOI's X-offset of the flat field correction filter. More...
 
PropertyI flatFieldFilterCalibrationAoiOffsetY
 An integer property defining the calibration AOI's Y-offset of the flat field correction filter. More...
 
PropertyI flatFieldFilterCalibrationAoiWidth
 An integer property defining the calibration AOI's width of the flat field correction filter. More...
 
PropertyI flatFieldFilterCalibrationImageCount
 An integer property defining the number of consecutive images to take into account during the calibration of the flat field filter. More...
 
PropertyI flatFieldFilterCorrectionAoiHeight
 An integer property defining the correction AOI's height of the flat field correction filter. More...
 
PropertyIAoiMode flatFieldFilterCorrectionAoiMode
 An enumerated integer property defining the correction AOI mode of the flat field correction filter. More...
 
PropertyI flatFieldFilterCorrectionAoiOffsetX
 An integer property defining the correction AOI's X-offset of the flat field correction filter. More...
 
PropertyI flatFieldFilterCorrectionAoiOffsetY
 An integer property defining the correction AOI's Y-offset of the flat field correction filter. More...
 
PropertyI flatFieldFilterCorrectionAoiWidth
 An integer property defining the correction AOI's width of the flat field correction filter. More...
 
PropertyIFlatFieldFilterCorrectionMode flatFieldFilterCorrectionMode
 An enumerated integer property defining the correction mode of the flat field correction filter. More...
 
PropertyIBoolean flatFieldFilterCorrectionModeReverseX
 An enumerated integer property defining the X-orientation that shall be used when applying the correction. More...
 
PropertyIBoolean flatFieldFilterCorrectionModeReverseY
 An enumerated integer property defining the Y-orientation that shall be used when applying the correction. More...
 
PropertyIFlatFieldFilterMode flatFieldFilterMode
 An enumerated integer property defining the operation mode of the flat field correction filter. More...
 
PropertyIBayerMosaicParity formatReinterpreterBayerMosaicParity
 An enumerated integer property defining the new Bayer parity of this buffer. More...
 
PropertyIBoolean formatReinterpreterEnable
 An enumerated integer property which can be used to enable/disable the format reinterpreter filter. More...
 
PropertyIImageBufferFormatReinterpreterMode formatReinterpreterMode
 An enumerated integer property which can be used to configure the format reinterpreter filter. More...
 
PropertyIBoolean gainOffsetKneeEnable
 An enumerated integer property which can be used to enable the Gain, Offset, Knee filter. More...
 
PropertyF gainOffsetKneeMasterOffset_pc
 A float property that contains master offset(in percent). More...
 
PropertyIBoolean LUTEnable
 An enumerated integer property which can be used to enable LUT (Look Up Table) transformations. More...
 
PropertyILUTImplementation LUTImplementation
 An enumerated integer property which can be used to configure the LUT (Look Up Table) implementation. More...
 
PropertyILUTInterpolationMode LUTInterpolationMode
 An enumerated integer property which can be used to configure the LUT (Look Up Table) interpolation mode. More...
 
PropertyILUTMapping LUTMappingHardware
 An enumerated integer property which can be used to configure the LUT (Look Up Table) mapping mode for LUT transformations done by the hardware. More...
 
PropertyILUTMapping LUTMappingSoftware
 An enumerated integer property which can be used to configure the LUT (Look Up Table) mapping mode for LUT transformations done optimized software algorithms. More...
 
PropertyILUTMode LUTMode
 An enumerated integer property which can be used to configure the LUT (Look Up Table) transformation mode. More...
 
PropertyIMirrorMode mirrorModeGlobal
 An enumerated integer property defining the mirror mode to be applied to ALL channels of the image. More...
 
PropertyIMirrorOperationMode mirrorOperationMode
 An enumerated integer property defining the general mode the mirror filter will work in. More...
 
PropertyI polarizedDataExtractionChannelIndex
 An integer property defining the channel within the processing window of the polarization data extraction filter. More...
 
PropertyIBoolean polarizedDataExtractionEnable
 An enumerated integer property defining whether the polarization data extraction filter shall be active or not. More...
 
PropertyIPolarizedDataExtractionInterpolationMode polarizedDataExtractionInterpolationMode
 An enumerated integer property defining the interpolation mode the polarization data extraction filter shall be operated in. More...
 
PropertyI polarizedDataExtractionLowerLimit
 An integer property defining the lower limit of the grey value of a pixel to be taken into account within the processing window of the polarization data extraction filter. More...
 
PropertyIPolarizedDataExtractionMode polarizedDataExtractionMode
 An enumerated integer property defining in which mode the polarization data extraction filter shall be operated in. More...
 
PropertyI polarizedDataExtractionUpperLimit
 An integer property defining the upper limit of the grey value of a pixel to be taken into account within the processing window of the polarization data extraction filter. More...
 
PropertyF rotationAngle
 The counterclockwise angle at which the image will be rotated. More...
 
PropertyIBoolean rotationEnable
 An enumerated integer property which can be used to enable/disable the rotation filter. More...
 
PropertyIBoolean tapSortEnable
 An enumerated integer property which can be used to enable/disable automatic data re-ordering from image sources delivering data from multiple taps that require re-ordering to reconstruct the image. More...
 
PropertyIWhiteBalanceParameter whiteBalance
 An integer property defining the parameter set to be used to perform the white balance correction. More...
 
PropertyIWhiteBalanceCalibrationMode whiteBalanceCalibration
 An enumerated integer property defining the mode used for white balance calibration. More...
 

Protected Attributes

HOBJ m_hRoot
 

Detailed Description

Base class for image processing related properties.

This class provides access to properties, which define how the image shall be processed after it has been captured but before it will be handed back to the user.

Constructor & Destructor Documentation

◆ ImageProcessing() [1/2]

ImageProcessing ( Device pDev,
const std::string &  settingName = "Base" 
)
inlineexplicit

Constructs a new mvIMPACT::acquire::ImageProcessing 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

◆ ImageProcessing() [2/2]

ImageProcessing ( const ImageProcessing src)
inline

Constructs a new mvIMPACT::acquire::ImageProcessing from an existing one.

Parameters
[in]srcA constant reference to the mvIMPACT::acquire::ImageProcessing object, this object shall be created from

◆ ~ImageProcessing()

virtual ~ImageProcessing ( )
inlinevirtual

Class destructor.

Member Function Documentation

◆ getGainOffsetKneeParameter()

GainOffsetKneeChannelParameters& getGainOffsetKneeParameter ( unsigned int  index) const
inline

Returns a reference to a set of user definable parameters to configure a certain channel of the GainOffsetKnee filter.

If nr is invalid(too large) a STL out_of_range exception will be thrown.

Returns
A reference to one of the parameter sets for the GainOffsetKnee filter that can be altered by the user.
Parameters
[in]indexThe index of the gain, offset, knee parameter set to be returned

◆ getGainOffsetKneeParameterCount()

unsigned int getGainOffsetKneeParameterCount ( void  ) const
inline

Returns the number of available user definable parameter sets for the GainOffsetKnee filter.

◆ getLUTParameter()

LUTParameters& getLUTParameter ( unsigned int  index) const
inline

Returns a reference to a set of user definable parameters to configure LUT (Look Up Table) operations.

If nr is invalid(too large) a STL out_of_range exception will be thrown.

Returns
A reference to one of the parameter sets for LUT (Look Up Table) operations that can be altered by the user.
Parameters
[in]indexThe index of the LUT parameter set to be returned

◆ getLUTParameterCount()

unsigned int getLUTParameterCount ( void  ) const
inline

Returns the number of available user definable parameter sets for LUT (Look Up Table) operations.

◆ getMirrorParameter()

MirrorParameters& getMirrorParameter ( unsigned int  index) const
inline

Returns a reference to a set of user definable parameters to configure mirror filter related features.

If nr is invalid(too large) a STL out_of_range exception will be thrown.

Returns
A reference to one of the parameter sets for mirror filter related features that can be altered by the user.
Parameters
[in]indexThe index of the mirror parameter set to be returned

◆ getMirrorParameterCount()

unsigned int getMirrorParameterCount ( void  ) const
inline

Returns the number of available user definable parameter sets mirror filter related operations.

◆ getWBUserSetting()

WhiteBalanceSettings& getWBUserSetting ( unsigned int  index) const
inline

Returns a reference to a set of user definable parameters to perform a white balance correction.

Pass '0' for the setting that is activated by setting the property mvIMPACT::acquire::ImageProcessing::whiteBalance to mvIMPACT::acquire::wbpUser1, '1' for mvIMPACT::acquire::wbpUser2 and so on.

If nr is invalid(too large) a STL out_of_range exception will be thrown.

Returns
A reference to one of the parameter sets for white balance correction that can be altered by the user.
Parameters
[in]indexThe index of the white balance parameter set to be returned

◆ getWBUserSettingsCount()

unsigned int getWBUserSettingsCount ( void  ) const
inline

Returns the number of available user definable parameter sets for white balance correction.

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

◆ operator=()

ImageProcessing& operator= ( const ImageProcessing rhs)
inline

Allows assignments of mvIMPACT::acquire::ImageProcessing objects.

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

◆ setSaturation()

void setSaturation ( double  K)
inline

Sets the saturation by using the color twist matrix.

The following saturation formula is used:

[0.299 + 0.701*K , 0.587*(1-K) , 0.114*(1-K) ]
[0.299*(1-K) + 0.701*K , 0.587 , 0.114*(1-K) ]
[0.299*(1-K) + 0.701*K , 0.587*(1-K) , 0.114 + 0.886*K ]

K is the saturation factor K > 1 increases saturation K = 1 means no change 0 < K < 1 decreases saturation K = 0 produces B&W K < 0 inverts color

Note
To enable/disable the saturation the application must write to mvIMPACT::acquire::ImageProcessing::colorTwistEnable.
Parameters
[in]KThe saturation value.

Member Data Documentation

◆ adaptiveEdgeSensingPlusSharpenGain

PropertyF adaptiveEdgeSensingPlusSharpenGain

A floating point property defining the intensity of the sharpening during AdaptiveEdgeSensingPlus deBayering.

Valid values for this property are between 0. and 100. (percent).

Since
2.26.0

◆ adaptiveEdgeSensingPlusSharpenThreshold

PropertyI adaptiveEdgeSensingPlusSharpenThreshold

An integer property defining the max. brightness level difference for which sharpening is not applied during AdaptiveEdgeSensingPlus deBayering.

Valid values for this property are between 0 and 2^(bits per pixel).

Since
2.26.0

◆ bayerConversionMode

PropertyIBayerConversionMode bayerConversionMode

An enumerated integer property defining what kind of algorithm shall be used during Bayer to RGB conversion.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBayerConversionMode.

◆ channelSplitChannelIndex

PropertyI channelSplitChannelIndex

An integer property which can be used to define which channel of the image shall be extracted.

This property will only be visible if mvIMPACT::acquire::ImageProcessing::channelSplitMode is set to mvIMPACT::acquire::csmExtractSingle.

◆ channelSplitDeinterlaceEnable

PropertyIBoolean channelSplitDeinterlaceEnable

An enumerated integer property which can be used to enable/disable data re-ordering for interlaced images.

Enabling this feature will cause interlaced images in a way that the 2 fields will be display next to each other. This will modify the original image in an image with twice the width but half the height.

Note
Right now this property will only result in correct results for images, that are line wise interlaced, thus some special sensors that e.g. transfer Bayer interlaced data (2 lines field 0, 2 lines field even, etc.) can not be re-arranged in a meaningful way.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ channelSplitEnable

PropertyIBoolean channelSplitEnable

An enumerated integer property which can be used to enable/disable automatic data re-ordering or extraction from multi-channel images.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ channelSplitMode

PropertyIChannelSplitMode channelSplitMode

An enumerated integer property which can be used to define how data from multi-channel images shall be re-ordered.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TChannelSplitMode.

◆ colorProcessing

An enumerated integer property defining what kind of color processing shall be applied to the raw image data.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TColorProcessingMode.

◆ colorTwistEnable

PropertyIBoolean colorTwistEnable

An enumerated integer property which can be used to enable/disable the color twist matrix.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

The color twist filter can be used to apply a linear transformation to a 3 channel image. Each pixel will at first be multiplied by a 3x3 matrix and afterwards an offset triplet can be added.

Since
2.2.2.

◆ colorTwistInputCorrectionMatrixEnable

PropertyIBoolean colorTwistInputCorrectionMatrixEnable

An enumerated integer property which can be used to enable/disable the color twist input correction matrix.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Since
2.2.2.

◆ colorTwistInputCorrectionMatrixMode

PropertyIColorTwistInputCorrectionMatrixMode colorTwistInputCorrectionMatrixMode

An enumerated integer property which can be used to select an input color correction matrix.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TColorTwistInputCorrectionMatrixMode.

Since
2.2.2.

◆ colorTwistInputCorrectionMatrixRow0

PropertyF colorTwistInputCorrectionMatrixRow0

The first row of the input color correction matrix.

This property stores the first row of a user defined 3x3 input color correction matrix if mvIMPACT::acquire::ImageProcessing::colorTwistInputCorrectionMatrixMode is set to mvIMPACT::acquire::cticmmUser. For other values of mvIMPACT::acquire::ImageProcessing::colorTwistInputCorrectionMatrixMode modifying this property will have no effect.

Since
2.2.2.

◆ colorTwistInputCorrectionMatrixRow1

PropertyF colorTwistInputCorrectionMatrixRow1

The second row of the input color correction matrix.

This property stores the second row of a user defined 3x3 input color correction matrix if mvIMPACT::acquire::ImageProcessing::colorTwistInputCorrectionMatrixMode is set to mvIMPACT::acquire::cticmmUser. For other values of mvIMPACT::acquire::ImageProcessing::colorTwistInputCorrectionMatrixMode modifying this property will have no effect.

Since
2.2.2.

◆ colorTwistInputCorrectionMatrixRow2

PropertyF colorTwistInputCorrectionMatrixRow2

The third row of the input color correction matrix.

This property stores the third row of a user defined 3x3 input color correction matrix if mvIMPACT::acquire::ImageProcessing::colorTwistInputCorrectionMatrixMode is set to mvIMPACT::acquire::cticmmUser. For other values of mvIMPACT::acquire::ImageProcessing::colorTwistInputCorrectionMatrixMode modifying this property will have no effect.

Since
2.2.2.

◆ colorTwistOutputCorrectionMatrixEnable

PropertyIBoolean colorTwistOutputCorrectionMatrixEnable

An enumerated integer property which can be used to enable/disable the color twist output correction matrix.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Since
2.2.2.

◆ colorTwistOutputCorrectionMatrixMode

PropertyIColorTwistOutputCorrectionMatrixMode colorTwistOutputCorrectionMatrixMode

An enumerated integer property which can be used to select an output color correction matrix.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TColorTwistOutputCorrectionMatrixMode.

Since
2.2.2.

◆ colorTwistOutputCorrectionMatrixRow0

PropertyF colorTwistOutputCorrectionMatrixRow0

The first row of the output color correction matrix.

This property stores the first row of a user defined 3x3 output color correction matrix if mvIMPACT::acquire::ImageProcessing::colorTwistOutputCorrectionMatrixMode is set to mvIMPACT::acquire::ctocmmUser. For other values of mvIMPACT::acquire::ImageProcessing::colorTwistOutputCorrectionMatrixMode modifying this property will have no effect.

Since
2.2.2.

◆ colorTwistOutputCorrectionMatrixRow1

PropertyF colorTwistOutputCorrectionMatrixRow1

The second row of the output color correction matrix.

This property stores the second row of a user defined 3x3 output color correction matrix if mvIMPACT::acquire::ImageProcessing::colorTwistOutputCorrectionMatrixMode is set to mvIMPACT::acquire::ctocmmUser. For other values of mvIMPACT::acquire::ImageProcessing::colorTwistOutputCorrectionMatrixMode modifying this property will have no effect.

Since
2.2.2.

◆ colorTwistOutputCorrectionMatrixRow2

PropertyF colorTwistOutputCorrectionMatrixRow2

The third row of the output color correction matrix.

This property stores the third row of a user defined 3x3 output color correction matrix if mvIMPACT::acquire::ImageProcessing::colorTwistOutputCorrectionMatrixMode is set to mvIMPACT::acquire::ctocmmUser. For other values of mvIMPACT::acquire::ImageProcessing::colorTwistOutputCorrectionMatrixMode modifying this property will have no effect.

Since
2.2.2.

◆ colorTwistResultingMatrixRow0

PropertyF colorTwistResultingMatrixRow0

The first row of the resulting color twist matrix.

This property will store the first row of the 3x4 resulting color twist matrix. This matrix is created by multiplying the input correction matrix by the color twist matrix by the output correction matrix. Only active matrices will be used to calculate the resulting matrix.

Since
2.2.2.

◆ colorTwistResultingMatrixRow1

PropertyF colorTwistResultingMatrixRow1

The second row of the resulting color twist matrix.

This property will store the second row of the 3x4 resulting color twist matrix. This matrix is created by multiplying the input correction matrix by the color twist matrix by the output correction matrix. Only active matrices will be used to calculate the resulting matrix.

Since
2.2.2.

◆ colorTwistResultingMatrixRow2

PropertyF colorTwistResultingMatrixRow2

The third row of the resulting color twist matrix.

This property will store the third row of the 3x4 resulting color twist matrix. This matrix is created by multiplying the input correction matrix by the color twist matrix by the output correction matrix. Only active matrices will be used to calculate the resulting matrix.

Since
2.2.2.

◆ colorTwistRow0

PropertyF colorTwistRow0

The first row of the color twist matrix.

This property stores 4 values. The first 3 components for the first row of the 3x4 matrix, the last component is the offset of this row.

Since
2.2.2.

◆ colorTwistRow1

PropertyF colorTwistRow1

The second row of the color twist matrix.

This property stores 4 values. The first 3 components for the second row of the 3x4 matrix, the last component is the offset of this row.

Since
2.2.2.

◆ colorTwistRow2

PropertyF colorTwistRow2

The third row of the color twist matrix.

This property stores 4 values. The first 3 components for the third row of the 3x4 matrix, the last component is the offset of this row.

Since
2.2.2.

◆ darkCurrentFilterCalibrationImageCount

PropertyI darkCurrentFilterCalibrationImageCount

An integer property defining the number of consecutive images to take into account during calibration of the dark current filter.

◆ darkCurrentFilterMode

PropertyIDarkCurrentFilterMode darkCurrentFilterMode

An enumerated integer property defining the operation mode of the dark current filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TDarkCurrentFilterMode.

◆ defectivePixelOffsetX

PropertyI defectivePixelOffsetX

An integer property defining a list of X-offsets of all pixels currently treated as defective.

All these pixels will be replaced depending on the selected algorithm in mvIMPACT::acquire::ImageProcessing::defectivePixelsFilterMode.

Note
In order to collect ALL defective pixels the list of detected pixels is not emptied each time a new calibration is started. In order to get rid of currently detected pixels an application must set the property mvIMPACT::acquire::ImageProcessing::defectivePixelsFilterMode to mvIMPACT::acquire::dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.17.1

◆ defectivePixelOffsetY

PropertyI defectivePixelOffsetY

An integer property defining a list of Y-offsets of all pixels currently treated as defective.

All these pixels will be replaced depending on the selected algorithm in mvIMPACT::acquire::ImageProcessing::defectivePixelsFilterMode.

Note
In order to collect ALL defective pixels the list of detected pixels is not emptied each time a new calibration is started. In order to get rid of currently detected pixels an application must set the property mvIMPACT::acquire::ImageProcessing::defectivePixelsFilterMode to mvIMPACT::acquire::dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.17.1

◆ defectivePixelReadFromDevice

Method defectivePixelReadFromDevice

Calling this method will download defective pixels from the device.

Note
In order to collect ALL defective pixels the list of detected pixels is not emptied each time a download from the device is executed. In order to get rid of currently detected pixels an application must set the property mvIMPACT::acquire::ImageProcessing::defectivePixelsFilterMode to mvIMPACT::acquire::dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Attention
This feature will only be supported by some devices providing a special interface inside their firmware.
Since
2.17.1

Calling this method will return

◆ defectivePixelsFilterColdPixelDeviation_pc

PropertyI defectivePixelsFilterColdPixelDeviation_pc

An integer property defining the max. allowed deviation for a pixel in per cent from the average grey value.

If this filter is active every pixel that during the calibration produces a grey value which is lower than the average grey value of the image minus the allowed deviation in per cent will be considered as a cold pixel and therefore will be replaced by a value depending on the operation mode of the filter.

◆ defectivePixelsFilterLeakyPixelDeviation_ADCLimit

PropertyI defectivePixelsFilterLeakyPixelDeviation_ADCLimit

An integer property defining the max. allowed offset from the average grey value for a pixel during calibration.

When this filter is calibrated each pixel producing a grey value higher than the average grey value plus the value of this property will be considered as a leaky pixel and therefore will be replaced by a value depending on the operation mode of the filter.

◆ defectivePixelsFilterMode

PropertyIDefectivePixelsFilterMode defectivePixelsFilterMode

An enumerated integer property defining the operation mode of the defective pixels filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TDefectivePixelsFilterMode.

◆ defectivePixelsFound

PropertyI defectivePixelsFound

An integer property (read-only) containing the number of pixels considered as being defective with respect to the calibration runs executed after the last reset of the calibration data.

Note
In order to collect ALL defective pixels the list of detected pixels is not emptied each time a new calibration is started. In order to get rid of currently detected pixels an application must set the property mvIMPACT::acquire::ImageProcessing::defectivePixelsFilterMode to mvIMPACT::acquire::dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.5.9

◆ defectivePixelsMaxDetectionCount

PropertyI defectivePixelsMaxDetectionCount

An integer property defining maximum the number of pixels considered as being defective during consecutive calibration runs.

With this property it is possible to define an upper limit for the number of detected defective pixels. This is not to be meant as an error checking mechanism for sensors reporting more defective pixels but to allow an application to keep the length of the list of defective pixels within reasonable boundaries. The more pixels a sensor has the higher a reasonable value might be. Set this to a value suitable for your application to protect the algorithm from huge lists due to incorrect calibration environments (too much light, not enough light, ...).

When after a calibration this value and the value of the mvIMPACT::acquire::ImageProcessing::defectivePixelsFound property are the same this indicates a problem. There are several possible reasons for this:

  • the lighting conditions or calibration parameters have not been set up correctly (fix your setup then)
  • the sensor is damaged (replace the device then)
  • the sensor has more defective pixels then indicated by the value of this property but which are still valid according to the specification of the sensor manufacturer (adjust the value of this property accordingly then)
Attention
When reducing this value at runtime excess pixels will be dropped from the current list of defective pixels if the new maximum list length is smaller then the amount of defective pixels currently detected.
Some devices might offer to store defective pixels inside the device in an mvIMPACT Acquire compatible format by calling mvIMPACT::acquire::ImageProcessing::defectivePixelWriteToDevice. However the device might not be able to store all these pixels due to a lack of storage space. Therefore always check the return value of the function!
Note
In order to get rid of currently detected pixels an application must set the property mvIMPACT::acquire::ImageProcessing::defectivePixelsFilterMode to mvIMPACT::acquire::dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.37.0

◆ defectivePixelWriteToDevice

Method defectivePixelWriteToDevice

Calling this method will upload defective pixels from the device.

Note
This will NOT automatically store this data in non-volatile memory on the device! A call to mvIMPACT::acquire::GenICam::mvDefectivePixelCorrectionControl::mvDefectivePixelDataSave might be needed!
Attention
This feature will only be supported by some devices providing a special interface inside their firmware.
Since
2.17.1

Calling this method will return

◆ filter

An enumerated integer property defining the filter to be applied to the image before it is transferred to the user.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TImageProcessingFilter.

◆ flatFieldFilterCalibrationAoiHeight

PropertyI flatFieldFilterCalibrationAoiHeight

An integer property defining the calibration AOI's height of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCalibrationAoiMode

PropertyIAoiMode flatFieldFilterCalibrationAoiMode

An enumerated integer property defining the correction AOI mode of the flat field correction filter.

When using an AOI only the AOI region is taken into consideration during calibration by this filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAoiMode.

Since
2.31.0

◆ flatFieldFilterCalibrationAoiOffsetX

PropertyI flatFieldFilterCalibrationAoiOffsetX

An integer property defining the calibration AOI's X-offset of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCalibrationAoiOffsetY

PropertyI flatFieldFilterCalibrationAoiOffsetY

An integer property defining the calibration AOI's Y-offset of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCalibrationAoiWidth

PropertyI flatFieldFilterCalibrationAoiWidth

An integer property defining the calibration AOI's width of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCalibrationImageCount

PropertyI flatFieldFilterCalibrationImageCount

An integer property defining the number of consecutive images to take into account during the calibration of the flat field filter.

◆ flatFieldFilterCorrectionAoiHeight

PropertyI flatFieldFilterCorrectionAoiHeight

An integer property defining the correction AOI's height of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCorrectionAoiMode

PropertyIAoiMode flatFieldFilterCorrectionAoiMode

An enumerated integer property defining the correction AOI mode of the flat field correction filter.

When using an AOI only the AOI region is corrected by this filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TAoiMode.

Since
2.31.0

◆ flatFieldFilterCorrectionAoiOffsetX

PropertyI flatFieldFilterCorrectionAoiOffsetX

An integer property defining the correction AOI's X-offset of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCorrectionAoiOffsetY

PropertyI flatFieldFilterCorrectionAoiOffsetY

An integer property defining the correction AOI's Y-offset of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCorrectionAoiWidth

PropertyI flatFieldFilterCorrectionAoiWidth

An integer property defining the correction AOI's width of the flat field correction filter.

Since
2.31.0

◆ flatFieldFilterCorrectionMode

PropertyIFlatFieldFilterCorrectionMode flatFieldFilterCorrectionMode

An enumerated integer property defining the correction mode of the flat field correction filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TFlatFieldFilterCorrectionMode.

◆ flatFieldFilterCorrectionModeReverseX

PropertyIBoolean flatFieldFilterCorrectionModeReverseX

An enumerated integer property defining the X-orientation that shall be used when applying the correction.

When active the calibration image will be applied reversed X direction thus the last correction factor of each line of the correction image will be applied to the first pixel of the image etc.. This can be useful e.g. if the calibration has been done and the device shall transmit the image flipped on a vertical axis in some configurations.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Since
2.40.0

◆ flatFieldFilterCorrectionModeReverseY

PropertyIBoolean flatFieldFilterCorrectionModeReverseY

An enumerated integer property defining the Y-orientation that shall be used when applying the correction.

When active the calibration image will be applied reversed Y direction thus the last line of correction factors of the correction image will be applied to the first line of the image etc.. This can be useful e.g. if the calibration has been done and the device shall transmit the image flipped on a horizontal axis in some configurations.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Since
2.40.0

◆ flatFieldFilterMode

PropertyIFlatFieldFilterMode flatFieldFilterMode

An enumerated integer property defining the operation mode of the flat field correction filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TFlatFieldFilterMode.

◆ formatReinterpreterBayerMosaicParity

PropertyIBayerMosaicParity formatReinterpreterBayerMosaicParity

An enumerated integer property defining the new Bayer parity of this buffer.

After applying the format reinterpreter this will be the new Bayer parity of the buffer when the filter is operated in one of the Mono To Mono modes.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBayerMosaicParity.

Since
2.31.0

◆ formatReinterpreterEnable

PropertyIBoolean formatReinterpreterEnable

An enumerated integer property which can be used to enable/disable the format reinterpreter filter.

This filter can be used if a device transmits data in a non-compliant or incorrect format. Using this filter the incoming data will simply be treated as a different pixel format then. This will NOT copy or modify the pixel data but will only adjust some of the elements describing the buffer (e.g. the pixel format and width). When e.g. setting this filter to treat mono data as RGB data, this will result in buffers with a width divided by 3 but RGB pixels instead of mono pixel afterwards.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Since
2.10.1

◆ formatReinterpreterMode

An enumerated integer property which can be used to configure the format reinterpreter filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TImageBufferFormatReinterpreterMode.

Since
2.10.1

◆ gainOffsetKneeEnable

PropertyIBoolean gainOffsetKneeEnable

An enumerated integer property which can be used to enable the Gain, Offset, Knee filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ gainOffsetKneeMasterOffset_pc

PropertyF gainOffsetKneeMasterOffset_pc

A float property that contains master offset(in percent).

This offset will be applied before the channel specific gain.

◆ LUTEnable

PropertyIBoolean LUTEnable

An enumerated integer property which can be used to enable LUT (Look Up Table) transformations.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ LUTImplementation

PropertyILUTImplementation LUTImplementation

An enumerated integer property which can be used to configure the LUT (Look Up Table) implementation.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TLUTImplementation.

Note
This property will be invisible when mvIMPACT::acquire::ImageProcessing::LUTEnable is set to mvIMPACT::acquire::bFalse.

◆ LUTInterpolationMode

PropertyILUTInterpolationMode LUTInterpolationMode

An enumerated integer property which can be used to configure the LUT (Look Up Table) interpolation mode.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TLUTInterpolationMode.

Note
This property will be invisible when mvIMPACT::acquire::ImageProcessing::LUTEnable is set to mvIMPACT::acquire::bFalse or if mvIMPACT::acquire::ImageProcessing::LUTMode is NOT set to mvIMPACT::acquire::LUTmInterpolated.

◆ LUTMappingHardware

PropertyILUTMapping LUTMappingHardware

An enumerated integer property which can be used to configure the LUT (Look Up Table) mapping mode for LUT transformations done by the hardware.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TLUTMapping.

Note
This property will be invisible when mvIMPACT::acquire::ImageProcessing::LUTEnable is set to mvIMPACT::acquire::bFalse or if mvIMPACT::acquire::ImageProcessing::LUTImplementation is NOT set to mvIMPACT::acquire::LUTiHardware.

◆ LUTMappingSoftware

PropertyILUTMapping LUTMappingSoftware

An enumerated integer property which can be used to configure the LUT (Look Up Table) mapping mode for LUT transformations done optimized software algorithms.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TLUTMapping.

Note
This property will be invisible when mvIMPACT::acquire::ImageProcessing::LUTEnable is set to mvIMPACT::acquire::bFalse or if mvIMPACT::acquire::ImageProcessing::LUTImplementation is NOT set to mvIMPACT::acquire::LUTiSoftware.

◆ LUTMode

An enumerated integer property which can be used to configure the LUT (Look Up Table) transformation mode.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TLUTMode.

Note
This property will be invisible when mvIMPACT::acquire::ImageProcessing::LUTEnable is set to mvIMPACT::acquire::bFalse.

◆ m_hRoot

HOBJ m_hRoot
protectedinherited

◆ mirrorModeGlobal

PropertyIMirrorMode mirrorModeGlobal

An enumerated integer property defining the mirror mode to be applied to ALL channels of the image.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TMirrorMode.

Note
This property will only be visible, when mvIMPACT::acquire::ImageProcessing::mirrorOperationMode is set to mvIMPACT::acquire::momGlobal.

◆ mirrorOperationMode

PropertyIMirrorOperationMode mirrorOperationMode

An enumerated integer property defining the general mode the mirror filter will work in.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TMirrorOperationMode.

◆ polarizedDataExtractionChannelIndex

PropertyI polarizedDataExtractionChannelIndex

An integer property defining the channel within the processing window of the polarization data extraction filter.

This channel will only be taken into account when mvIMPACT::acquire::ImageProcessing::polarizedDataExtractionMode is set to mvIMPACT::acquire::prmExtractSingle.

Since
2.29.0

◆ polarizedDataExtractionEnable

PropertyIBoolean polarizedDataExtractionEnable

An enumerated integer property defining whether the polarization data extraction filter shall be active or not.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Since
2.29.0

◆ polarizedDataExtractionInterpolationMode

PropertyIPolarizedDataExtractionInterpolationMode polarizedDataExtractionInterpolationMode

An enumerated integer property defining the interpolation mode the polarization data extraction filter shall be operated in.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TPolarizedDataExtractionInterpolationMode.

Note
This property will only be available when the polarization data extraction mode is either horizontal, vertical or single.
Since
2.29.0

◆ polarizedDataExtractionLowerLimit

PropertyI polarizedDataExtractionLowerLimit

An integer property defining the lower limit of the grey value of a pixel to be taken into account within the processing window of the polarization data extraction filter.

This limit will only be taken into account when mvIMPACT::acquire::ImageProcessing::polarizedDataExtractionMode is set to mvIMPACT::acquire::prmMeanValue.

Since
2.29.0

◆ polarizedDataExtractionMode

PropertyIPolarizedDataExtractionMode polarizedDataExtractionMode

An enumerated integer property defining in which mode the polarization data extraction filter shall be operated in.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TPolarizedDataExtractionMode.

Since
2.29.0

◆ polarizedDataExtractionUpperLimit

PropertyI polarizedDataExtractionUpperLimit

An integer property defining the upper limit of the grey value of a pixel to be taken into account within the processing window of the polarization data extraction filter.

This limit will only be taken into account when mvIMPACT::acquire::ImageProcessing::polarizedDataExtractionMode is set to mvIMPACT::acquire::prmMeanValue.

Since
2.29.0

◆ rotationAngle

PropertyF rotationAngle

The counterclockwise angle at which the image will be rotated.

This property will store the counterclockwise angle at which the image will be rotated.

Since
2.13.2

◆ rotationEnable

PropertyIBoolean rotationEnable

An enumerated integer property which can be used to enable/disable the rotation filter.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

Since
2.13.2

◆ tapSortEnable

PropertyIBoolean tapSortEnable

An enumerated integer property which can be used to enable/disable automatic data re-ordering from image sources delivering data from multiple taps that require re-ordering to reconstruct the image.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TBoolean.

◆ whiteBalance

An integer property defining the parameter set to be used to perform the white balance correction.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TWhiteBalanceParameter.

◆ whiteBalanceCalibration

PropertyIWhiteBalanceCalibrationMode whiteBalanceCalibration

An enumerated integer property defining the mode used for white balance calibration.

This property can be used to define the way a white balance calibration shall be performed. Currently only the mvIMPACT::acquire::wbcmNextFrame mode is supported, but new modes might appear in later revisions of the interface.

When this property is set to mvIMPACT::acquire::wbcmNextFrame the next image captured will be used as a reference to calculate the gain factors for the red, green and blue channel. So make sure when the next image is captured the camera looks on a plain white or slightly grey surface in order to obtain correct results. After the calibration has been done, the property will be reset to mvIMPACT::acquire::wbcmOff again.

Note
Performing this kind of white balance calibration will only affect Bayer color sensors and will only have any visual effect on the image if one of the user definable parameter sets has been selected before. This can be done by modifying the property mvIMPACT::acquire::ImageProcessing::whiteBalance. Afterwards the calculated factors will be stored in the mvIMPACT::acquire::WhiteBalanceSettings selected.

Valid values for this property are defined by the enumeration mvIMPACT::acquire::TWhiteBalanceCalibrationMode.


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