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

Inheritance diagram for ImageProcessing:

Public Member Functions
	__init__ (self, *args)
	Constructs a new mvIMPACT.acquire.ImageProcessing object.

	getGainOffsetKneeParameter (self, index)
	Returns a reference to a set of user definable parameters to configure a certain channel of the GainOffsetKnee filter.

	getGainOffsetKneeParameterCount (self)
	Returns the number of available user definable parameter sets for the GainOffsetKnee filter.

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

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

	getMirrorParameter (self, index)
	Returns a reference to a set of user definable parameters to configure mirror filter related features.

	getMirrorParameterCount (self)
	Returns the number of available user definable parameter sets mirror filter related operations.

	getWBUserSetting (self, index)
	Returns a reference to a set of user definable parameters to perform a white balance correction.

	getWBUserSettingsCount (self)
	Returns the number of available user definable parameter sets for white balance correction.

	setSaturation (self, K)
	Sets the saturation by using the color twist matrix.

Properties
	adaptiveEdgeSensingPlusSharpenGain = property(lib_mvIMPACT_acquire.ImageProcessing_adaptiveEdgeSensingPlusSharpenGain_get, doc=)
	A floating point property defining the intensity of the sharpening during AdaptiveEdgeSensingPlus deBayering.

	adaptiveEdgeSensingPlusSharpenThreshold = property(lib_mvIMPACT_acquire.ImageProcessing_adaptiveEdgeSensingPlusSharpenThreshold_get, doc=)
	An integer property defining the max.

	bayerConversionMode = property(lib_mvIMPACT_acquire.ImageProcessing_bayerConversionMode_get, doc=)
	An enumerated integer property defining what kind of algorithm shall be used during Bayer to RGB conversion.

	channelSplitChannelIndex = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitChannelIndex_get, doc=)
	An integer property which can be used to define which channel of the image shall be extracted.

	channelSplitDeinterlaceEnable = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitDeinterlaceEnable_get, doc=)
	An enumerated integer property which can be used to enable/disable data re-ordering for interlaced images.

	channelSplitEnable = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitEnable_get, doc=)
	An enumerated integer property which can be used to enable/disable automatic data re-ordering or extraction from multi-channel images.

	channelSplitMode = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitMode_get, doc=)
	An enumerated integer property which can be used to define how data from multi-channel images shall be re-ordered.

	colorProcessing = property(lib_mvIMPACT_acquire.ImageProcessing_colorProcessing_get, doc=)

	colorTwistEnable = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistEnable_get, doc=)
	An enumerated integer property which can be used to enable/disable the color twist matrix.

	colorTwistInputCorrectionMatrixEnable = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixEnable_get, doc=)
	An enumerated integer property which can be used to enable/disable the color twist input correction matrix.

	colorTwistInputCorrectionMatrixMode = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixMode_get, doc=)
	An enumerated integer property which can be used to select an input color correction matrix.

	colorTwistInputCorrectionMatrixRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixRow0_get, doc=)
	The first row of the input color correction matrix.

	colorTwistInputCorrectionMatrixRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixRow1_get, doc=)
	The second row of the input color correction matrix.

	colorTwistInputCorrectionMatrixRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixRow2_get, doc=)
	The third row of the input color correction matrix.

	colorTwistOutputCorrectionMatrixEnable = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixEnable_get, doc=)
	An enumerated integer property which can be used to enable/disable the color twist output correction matrix.

	colorTwistOutputCorrectionMatrixMode = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixMode_get, doc=)
	An enumerated integer property which can be used to select an output color correction matrix.

	colorTwistOutputCorrectionMatrixRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixRow0_get, doc=)
	The first row of the output color correction matrix.

	colorTwistOutputCorrectionMatrixRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixRow1_get, doc=)
	The second row of the output color correction matrix.

	colorTwistOutputCorrectionMatrixRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixRow2_get, doc=)
	The third row of the output color correction matrix.

	colorTwistResultingMatrixRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistResultingMatrixRow0_get, doc=)
	The first row of the resulting color twist matrix.

	colorTwistResultingMatrixRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistResultingMatrixRow1_get, doc=)
	The second row of the resulting color twist matrix.

	colorTwistResultingMatrixRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistResultingMatrixRow2_get, doc=)
	The third row of the resulting color twist matrix.

	colorTwistRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistRow0_get, doc=)
	The first row of the color twist matrix.

	colorTwistRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistRow1_get, doc=)
	The second row of the color twist matrix.

	colorTwistRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistRow2_get, doc=)
	The third row of the color twist matrix.

	darkCurrentFilterCalibrationImageCount = property(lib_mvIMPACT_acquire.ImageProcessing_darkCurrentFilterCalibrationImageCount_get, doc=)
	An integer property defining the number of consecutive images to take into account during calibration of the dark current filter.

	darkCurrentFilterMode = property(lib_mvIMPACT_acquire.ImageProcessing_darkCurrentFilterMode_get, doc=)
	An enumerated integer property defining the operation mode of the dark current filter.

	defectivePixelOffsetX = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelOffsetX_get, doc=)
	An integer property defining a list of X-offsets of all pixels currently treated as defective.

	defectivePixelOffsetY = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelOffsetY_get, doc=)
	An integer property defining a list of Y-offsets of all pixels currently treated as defective.

	defectivePixelReadFromDevice = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelReadFromDevice_get, doc=)
	Calling this method will download defective pixels from the device.

	defectivePixelsFilterColdPixelDeviation_pc = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFilterColdPixelDeviation_pc_get, doc=)
	An integer property defining the max.

	defectivePixelsFilterLeakyPixelDeviation_ADCLimit = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFilterLeakyPixelDeviation_ADCLimit_get, doc=)
	An integer property defining the max.

	defectivePixelsFilterMode = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFilterMode_get, doc=)
	An enumerated integer property defining the operation mode of the defective pixels filter.

	defectivePixelsFound = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFound_get, doc=)
	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.

	defectivePixelsMaxDetectionCount = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsMaxDetectionCount_get, doc=)
	An integer property defining maximum the number of pixels considered as being defective during consecutive calibration runs.

	defectivePixelWriteToDevice = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelWriteToDevice_get, doc=)
	Calling this method will upload defective pixels from the device.

	filter = property(lib_mvIMPACT_acquire.ImageProcessing_filter_get, doc=)
	An enumerated integer property defining the filter to be applied to the image before it is transferred to the user.

	flatFieldFilterCalibrationAoiHeight = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiHeight_get, doc=)
	An integer property defining the calibration AOI's height of the flat field correction filter.

	flatFieldFilterCalibrationAoiMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiMode_get, doc=)
	An enumerated integer property defining the correction AOI mode of the flat field correction filter.

	flatFieldFilterCalibrationAoiOffsetX = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiOffsetX_get, doc=)
	An integer property defining the calibration AOI's X-offset of the flat field correction filter.

	flatFieldFilterCalibrationAoiOffsetY = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiOffsetY_get, doc=)
	An integer property defining the calibration AOI's Y-offset of the flat field correction filter.

	flatFieldFilterCalibrationAoiWidth = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiWidth_get, doc=)
	An integer property defining the calibration AOI's width of the flat field correction filter.

	flatFieldFilterCalibrationImageCount = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationImageCount_get, doc=)
	An integer property defining the number of consecutive images to take into account during the calibration of the flat field filter.

	flatFieldFilterCorrectionAoiHeight = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiHeight_get, doc=)
	An integer property defining the correction AOI's height of the flat field correction filter.

	flatFieldFilterCorrectionAoiMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiMode_get, doc=)
	An enumerated integer property defining the correction AOI mode of the flat field correction filter.

	flatFieldFilterCorrectionAoiOffsetX = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiOffsetX_get, doc=)
	An integer property defining the correction AOI's X-offset of the flat field correction filter.

	flatFieldFilterCorrectionAoiOffsetY = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiOffsetY_get, doc=)
	An integer property defining the correction AOI's Y-offset of the flat field correction filter.

	flatFieldFilterCorrectionAoiWidth = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiWidth_get, doc=)
	An integer property defining the correction AOI's width of the flat field correction filter.

	flatFieldFilterCorrectionMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionMode_get, doc=)
	An enumerated integer property defining the correction mode of the flat field correction filter.

	flatFieldFilterCorrectionModeReverseX = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionModeReverseX_get, doc=)
	An enumerated integer property defining the X-orientation that shall be used when applying the correction.

	flatFieldFilterCorrectionModeReverseY = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionModeReverseY_get, doc=)
	An enumerated integer property defining the Y-orientation that shall be used when applying the correction.

	flatFieldFilterMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterMode_get, doc=)
	An enumerated integer property defining the operation mode of the flat field correction filter.

	formatReinterpreterBayerMosaicParity = property(lib_mvIMPACT_acquire.ImageProcessing_formatReinterpreterBayerMosaicParity_get, doc=)
	An enumerated integer property defining the new Bayer parity of this buffer.

	formatReinterpreterEnable = property(lib_mvIMPACT_acquire.ImageProcessing_formatReinterpreterEnable_get, doc=)
	An enumerated integer property which can be used to enable/disable the format reinterpreter filter.

	formatReinterpreterMode = property(lib_mvIMPACT_acquire.ImageProcessing_formatReinterpreterMode_get, doc=)
	An enumerated integer property which can be used to configure the format reinterpreter filter.

	gainOffsetKneeEnable = property(lib_mvIMPACT_acquire.ImageProcessing_gainOffsetKneeEnable_get, doc=)
	An enumerated integer property which can be used to enable the Gain, Offset, Knee filter.

	gainOffsetKneeMasterOffset_pc = property(lib_mvIMPACT_acquire.ImageProcessing_gainOffsetKneeMasterOffset_pc_get, doc=)
	A float property that contains master offset(in percent).

	gainOffsetKneeParameterCount = property (getGainOffsetKneeParameterCount, None, None, None)
	An integer property (read-only) which holds the number of available user definable parameter sets for the GainOffsetKnee filter.

	LUTEnable = property(lib_mvIMPACT_acquire.ImageProcessing_LUTEnable_get, doc=)
	An enumerated integer property which can be used to enable LUT (Look Up Table) transformations.

	LUTImplementation = property(lib_mvIMPACT_acquire.ImageProcessing_LUTImplementation_get, doc=)
	An enumerated integer property which can be used to configure the LUT (Look Up Table) implementation.

	LUTInterpolationMode = property(lib_mvIMPACT_acquire.ImageProcessing_LUTInterpolationMode_get, doc=)
	An enumerated integer property which can be used to configure the LUT (Look Up Table) interpolation mode.

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

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

	LUTMode = property(lib_mvIMPACT_acquire.ImageProcessing_LUTMode_get, doc=)
	An enumerated integer property which can be used to configure the LUT (Look Up Table) transformation mode.

	LUTParameterCount = property (getLUTParameterCount, None, None, None)
	An integer property (read-only) which holds the number of available user definable parameter sets for LUT (Look Up Table) operations.

	mirrorModeGlobal = property(lib_mvIMPACT_acquire.ImageProcessing_mirrorModeGlobal_get, doc=)
	An enumerated integer property defining the mirror mode to be applied to ALL channels of the image.

	mirrorOperationMode = property(lib_mvIMPACT_acquire.ImageProcessing_mirrorOperationMode_get, doc=)
	An enumerated integer property defining the general mode the mirror filter will work in.

	polarizedDataExtractionChannelIndex = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionChannelIndex_get, doc=)
	An integer property defining the channel within the processing window of the polarization data extraction filter.

	polarizedDataExtractionEnable = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionEnable_get, doc=)
	An enumerated integer property defining whether the polarization data extraction filter shall be active or not.

	polarizedDataExtractionInterpolationMode = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionInterpolationMode_get, doc=)
	An enumerated integer property defining the interpolation mode the polarization data extraction filter shall be operated in.

	polarizedDataExtractionLowerLimit = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionLowerLimit_get, doc=)
	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.

	polarizedDataExtractionMode = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionMode_get, doc=)
	An enumerated integer property defining in which mode the polarization data extraction filter shall be operated in.

	polarizedDataExtractionUpperLimit = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionUpperLimit_get, doc=)
	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.

	rotationAngle = property(lib_mvIMPACT_acquire.ImageProcessing_rotationAngle_get, doc=)
	The counterclockwise angle at which the image will be rotated.

	rotationEnable = property(lib_mvIMPACT_acquire.ImageProcessing_rotationEnable_get, doc=)
	An enumerated integer property which can be used to enable/disable the rotation filter.

	tapSortEnable = property(lib_mvIMPACT_acquire.ImageProcessing_tapSortEnable_get, doc=)
	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.

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

	WBUserSettingsCount = property (getWBUserSettingsCount, None, None, None)
	An integer property (read-only) which holds the number of available user definable parameter sets for white balance correction.

	whiteBalance = property(lib_mvIMPACT_acquire.ImageProcessing_whiteBalance_get, doc=)
	An integer property defining the parameter set to be used to perform the white balance correction.

	whiteBalanceCalibration = property(lib_mvIMPACT_acquire.ImageProcessing_whiteBalanceCalibration_get, doc=)
	An enumerated integer property defining the mode used for white balance calibration.

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

◆ init()

__init__	(		self,
		*	args )

Constructs a new mvIMPACT.acquire.ImageProcessing object.

OVERLOAD 1:

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

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

Parameters

src	[in] A constant reference to the mvIMPACT.acquire.ImageProcessing object, this object shall be created from

Reimplemented from ComponentCollection.

Member Function Documentation

◆ getGainOffsetKneeParameter()

getGainOffsetKneeParameter	(		self,
			index )

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

Returns: A reference to one of the parameter sets for the GainOffsetKnee filter that can be altered by the user.

Parameters

index [in] The index of the gain, offset, knee parameter set to be returned

◆ getGainOffsetKneeParameterCount()

getGainOffsetKneeParameterCount ( self )

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

◆ getLUTParameter()

getLUTParameter	(		self,
			index )

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

Returns: A reference to one of the parameter sets for LUT (Look Up Table) operations that can be altered by the user.

Parameters

index [in] The index of the LUT parameter set to be returned

◆ getLUTParameterCount()

getLUTParameterCount ( self )

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

◆ getMirrorParameter()

getMirrorParameter	(		self,
			index )

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

Returns: A reference to one of the parameter sets for mirror filter related features that can be altered by the user.

Parameters

index [in] The index of the mirror parameter set to be returned

◆ getMirrorParameterCount()

getMirrorParameterCount ( self )

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

◆ getWBUserSetting()

getWBUserSetting	(		self,
			index )

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.

Returns: A reference to one of the parameter sets for white balance correction that can be altered by the user.

Parameters

index [in] The index of the white balance parameter set to be returned

◆ getWBUserSettingsCount()

getWBUserSettingsCount ( self )

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

◆ setSaturation()

setSaturation	(		self,
			K )

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

K	[in] The saturation value.

Property Documentation

◆ adaptiveEdgeSensingPlusSharpenGain

adaptiveEdgeSensingPlusSharpenGain = property(lib_mvIMPACT_acquire.ImageProcessing_adaptiveEdgeSensingPlusSharpenGain_get, doc=)

static

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

adaptiveEdgeSensingPlusSharpenThreshold = property(lib_mvIMPACT_acquire.ImageProcessing_adaptiveEdgeSensingPlusSharpenThreshold_get, doc=)

static

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

bayerConversionMode = property(lib_mvIMPACT_acquire.ImageProcessing_bayerConversionMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bcmLinearInterpolation, mvIMPACT.acquire.bcmAdaptiveEdgeSensing, mvIMPACT.acquire.bcmAuto, mvIMPACT.acquire.bcmPacked, mvIMPACT.acquire.bcmLinearPacked, mvIMPACT.acquire.bcmAdaptiveEdgeSensingPlus, mvIMPACT.acquire.bcmAdaptiveHomogeneityDirected.

◆ channelSplitChannelIndex

channelSplitChannelIndex = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitChannelIndex_get, doc=)

static

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

channelSplitDeinterlaceEnable = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitDeinterlaceEnable_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

◆ channelSplitEnable

channelSplitEnable = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitEnable_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

◆ channelSplitMode

channelSplitMode = property(lib_mvIMPACT_acquire.ImageProcessing_channelSplitMode_get, doc=)

static

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 may be: mvIMPACT.acquire.csmVertical, mvIMPACT.acquire.csmHorizontal, mvIMPACT.acquire.csmExtractSingle.

◆ colorProcessing

colorProcessing = property(lib_mvIMPACT_acquire.ImageProcessing_colorProcessing_get, doc=)

static

◆ colorTwistEnable

colorTwistEnable = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistEnable_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

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

colorTwistInputCorrectionMatrixEnable = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixEnable_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Since: 2.2.2.

◆ colorTwistInputCorrectionMatrixMode

colorTwistInputCorrectionMatrixMode = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.MV_CUSTOM_COLOR_TWIST_INPUT_CORRECTION_MATRIX_MODES, mvIMPACT.acquire.cticmmUser, mvIMPACT.acquire.cticmmDeviceSpecific.

Since: 2.2.2.

◆ colorTwistInputCorrectionMatrixRow0

colorTwistInputCorrectionMatrixRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixRow0_get, doc=)

static

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

colorTwistInputCorrectionMatrixRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixRow1_get, doc=)

static

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

colorTwistInputCorrectionMatrixRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistInputCorrectionMatrixRow2_get, doc=)

static

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

colorTwistOutputCorrectionMatrixEnable = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixEnable_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Since: 2.2.2.

◆ colorTwistOutputCorrectionMatrixMode

colorTwistOutputCorrectionMatrixMode = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.ctocmmUser, mvIMPACT.acquire.ctocmmXYZToAdobeRGB_D50, mvIMPACT.acquire.ctocmmXYZTosRGB_D50, mvIMPACT.acquire.ctocmmXYZToWideGamutRGB_D50, mvIMPACT.acquire.ctocmmXYZToAdobeRGB_D65, mvIMPACT.acquire.ctocmmXYZTosRGB_D65.

Since: 2.2.2.

◆ colorTwistOutputCorrectionMatrixRow0

colorTwistOutputCorrectionMatrixRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixRow0_get, doc=)

static

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

colorTwistOutputCorrectionMatrixRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixRow1_get, doc=)

static

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

colorTwistOutputCorrectionMatrixRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistOutputCorrectionMatrixRow2_get, doc=)

static

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

colorTwistResultingMatrixRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistResultingMatrixRow0_get, doc=)

static

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

colorTwistResultingMatrixRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistResultingMatrixRow1_get, doc=)

static

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

colorTwistResultingMatrixRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistResultingMatrixRow2_get, doc=)

static

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

colorTwistRow0 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistRow0_get, doc=)

static

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

colorTwistRow1 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistRow1_get, doc=)

static

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

colorTwistRow2 = property(lib_mvIMPACT_acquire.ImageProcessing_colorTwistRow2_get, doc=)

static

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

darkCurrentFilterCalibrationImageCount = property(lib_mvIMPACT_acquire.ImageProcessing_darkCurrentFilterCalibrationImageCount_get, doc=)

static

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

◆ darkCurrentFilterMode

darkCurrentFilterMode = property(lib_mvIMPACT_acquire.ImageProcessing_darkCurrentFilterMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.dcfmOff, mvIMPACT.acquire.dcfmOn, mvIMPACT.acquire.dcfmCalibrateDarkCurrent, mvIMPACT.acquire.dcfmTransmitCorrectionImage.

◆ defectivePixelOffsetX

defectivePixelOffsetX = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelOffsetX_get, doc=)

static

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

defectivePixelOffsetY = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelOffsetY_get, doc=)

static

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

defectivePixelReadFromDevice = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelReadFromDevice_get, doc=)

static

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

mvIMPACT.acquire.DMR_NO_ERROR if successful.
A negative error code as listed here: Error code list . Most likely mvIMPACT.acquire.DMR_FEATURE_NOT_AVAILABLE if the device does not support this feature.

◆ defectivePixelsFilterColdPixelDeviation_pc

defectivePixelsFilterColdPixelDeviation_pc = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFilterColdPixelDeviation_pc_get, doc=)

static

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

defectivePixelsFilterLeakyPixelDeviation_ADCLimit = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFilterLeakyPixelDeviation_ADCLimit_get, doc=)

static

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

defectivePixelsFilterMode = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFilterMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.dpfmOff, mvIMPACT.acquire.dpfm3x1Average, mvIMPACT.acquire.dpfm3x3Median, mvIMPACT.acquire.dpfmResetCalibration, mvIMPACT.acquire.dpfmCalibrateLeakyPixel, mvIMPACT.acquire.dpfmCalibrateColdPixel, mvIMPACT.acquire.dpfmCalibrateHotPixel, mvIMPACT.acquire.dpfmCalibrateHotAndColdPixel, mvIMPACT.acquire.dpfmReplaceDefectivePixelAfter3x3Filter.

◆ defectivePixelsFound

defectivePixelsFound = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsFound_get, doc=)

static

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

defectivePixelsMaxDetectionCount = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelsMaxDetectionCount_get, doc=)

static

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 than the amount of defective pixels currently detected.; Some devices might offer to store defective pixels inside the device in an Impact 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

defectivePixelWriteToDevice = property(lib_mvIMPACT_acquire.ImageProcessing_defectivePixelWriteToDevice_get, doc=)

static

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

mvIMPACT.acquire.DMR_NO_ERROR if successful.
A negative error code as listed here: Error code list . Most likely mvIMPACT.acquire.DMR_FEATURE_NOT_AVAILABLE if the device does not support this feature.

◆ filter

filter = property(lib_mvIMPACT_acquire.ImageProcessing_filter_get, doc=)

static

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 may be: mvIMPACT.acquire.ipfOff, mvIMPACT.acquire.ipfSharpen.

◆ flatFieldFilterCalibrationAoiHeight

flatFieldFilterCalibrationAoiHeight = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiHeight_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCalibrationAoiMode

flatFieldFilterCalibrationAoiMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiMode_get, doc=)

static

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 may be: mvIMPACT.acquire.amCentered, mvIMPACT.acquire.amFull, mvIMPACT.acquire.amUseAoi.

Since: 2.31.0

◆ flatFieldFilterCalibrationAoiOffsetX

flatFieldFilterCalibrationAoiOffsetX = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiOffsetX_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCalibrationAoiOffsetY

flatFieldFilterCalibrationAoiOffsetY = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiOffsetY_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCalibrationAoiWidth

flatFieldFilterCalibrationAoiWidth = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationAoiWidth_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCalibrationImageCount

flatFieldFilterCalibrationImageCount = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCalibrationImageCount_get, doc=)

static

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

◆ flatFieldFilterCorrectionAoiHeight

flatFieldFilterCorrectionAoiHeight = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiHeight_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCorrectionAoiMode

flatFieldFilterCorrectionAoiMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiMode_get, doc=)

static

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 may be: mvIMPACT.acquire.amCentered, mvIMPACT.acquire.amFull, mvIMPACT.acquire.amUseAoi.

Since: 2.31.0

◆ flatFieldFilterCorrectionAoiOffsetX

flatFieldFilterCorrectionAoiOffsetX = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiOffsetX_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCorrectionAoiOffsetY

flatFieldFilterCorrectionAoiOffsetY = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiOffsetY_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCorrectionAoiWidth

flatFieldFilterCorrectionAoiWidth = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionAoiWidth_get, doc=)

static

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

Since: 2.31.0

◆ flatFieldFilterCorrectionMode

flatFieldFilterCorrectionMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.ffcmDefault, mvIMPACT.acquire.ffcmBrightPreserving.

◆ flatFieldFilterCorrectionModeReverseX

flatFieldFilterCorrectionModeReverseX = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionModeReverseX_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Since: 2.40.0

◆ flatFieldFilterCorrectionModeReverseY

flatFieldFilterCorrectionModeReverseY = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterCorrectionModeReverseY_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Since: 2.40.0

◆ flatFieldFilterMode

flatFieldFilterMode = property(lib_mvIMPACT_acquire.ImageProcessing_flatFieldFilterMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.fffmOff, mvIMPACT.acquire.fffmOn, mvIMPACT.acquire.fffmCalibrateFlatField, mvIMPACT.acquire.fffmTransmitCorrectionImage.

◆ formatReinterpreterBayerMosaicParity

formatReinterpreterBayerMosaicParity = property(lib_mvIMPACT_acquire.ImageProcessing_formatReinterpreterBayerMosaicParity_get, doc=)

static

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 may be: mvIMPACT.acquire.bmpUndefined, mvIMPACT.acquire.bmpGR, mvIMPACT.acquire.bmpRG, mvIMPACT.acquire.bmpBG, mvIMPACT.acquire.bmpGB.

Since: 2.31.0

◆ formatReinterpreterEnable

formatReinterpreterEnable = property(lib_mvIMPACT_acquire.ImageProcessing_formatReinterpreterEnable_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Since: 2.10.1

◆ formatReinterpreterMode

formatReinterpreterMode = property(lib_mvIMPACT_acquire.ImageProcessing_formatReinterpreterMode_get, doc=)

static

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

Since: 2.10.1

◆ gainOffsetKneeEnable

gainOffsetKneeEnable = property(lib_mvIMPACT_acquire.ImageProcessing_gainOffsetKneeEnable_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

◆ gainOffsetKneeMasterOffset_pc

gainOffsetKneeMasterOffset_pc = property(lib_mvIMPACT_acquire.ImageProcessing_gainOffsetKneeMasterOffset_pc_get, doc=)

static

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

This offset will be applied before the channel specific gain.

◆ gainOffsetKneeParameterCount

gainOffsetKneeParameterCount = property (getGainOffsetKneeParameterCount, None, None, None)

static

An integer property (read-only) which holds the number of available user definable parameter sets for the GainOffsetKnee filter.

See mvIMPACT.acquire.ImageProcessing.getGainOffsetKneeParameterCount()

◆ LUTEnable

LUTEnable = property(lib_mvIMPACT_acquire.ImageProcessing_LUTEnable_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

◆ LUTImplementation

LUTImplementation = property(lib_mvIMPACT_acquire.ImageProcessing_LUTImplementation_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.LUTiHardware, mvIMPACT.acquire.LUTiSoftware.

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

◆ LUTInterpolationMode

LUTInterpolationMode = property(lib_mvIMPACT_acquire.ImageProcessing_LUTInterpolationMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.LUTimThreshold, mvIMPACT.acquire.LUTimLinear, mvIMPACT.acquire.LUTimCubic.

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

LUTMappingHardware = property(lib_mvIMPACT_acquire.ImageProcessing_LUTMappingHardware_get, doc=)

static

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 may be: mvIMPACT.acquire.LUTm8To8, mvIMPACT.acquire.LUTm10To8, mvIMPACT.acquire.LUTm10To10, mvIMPACT.acquire.LUTm12To10, mvIMPACT.acquire.LUTm12To12, mvIMPACT.acquire.LUTm14To14, mvIMPACT.acquire.LUTm16To16.

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

LUTMappingSoftware = property(lib_mvIMPACT_acquire.ImageProcessing_LUTMappingSoftware_get, doc=)

static

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 may be: mvIMPACT.acquire.LUTm8To8, mvIMPACT.acquire.LUTm10To8, mvIMPACT.acquire.LUTm10To10, mvIMPACT.acquire.LUTm12To10, mvIMPACT.acquire.LUTm12To12, mvIMPACT.acquire.LUTm14To14, mvIMPACT.acquire.LUTm16To16.

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

LUTMode = property(lib_mvIMPACT_acquire.ImageProcessing_LUTMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.LUTmInterpolated, mvIMPACT.acquire.LUTmGamma, mvIMPACT.acquire.LUTmDirect.

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

◆ LUTParameterCount

LUTParameterCount = property (getLUTParameterCount, None, None, None)

static

An integer property (read-only) which holds the number of available user definable parameter sets for LUT (Look Up Table) operations.

See mvIMPACT.acquire.ImageProcessing.getLUTParameterCount()

◆ mirrorModeGlobal

mirrorModeGlobal = property(lib_mvIMPACT_acquire.ImageProcessing_mirrorModeGlobal_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.mmOff, mvIMPACT.acquire.mmTopDown, mvIMPACT.acquire.mmLeftRight, mvIMPACT.acquire.mmTopDownAndLeftRight.

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

◆ mirrorOperationMode

mirrorOperationMode = property(lib_mvIMPACT_acquire.ImageProcessing_mirrorOperationMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.momGlobal, mvIMPACT.acquire.momChannelBased.

◆ polarizedDataExtractionChannelIndex

polarizedDataExtractionChannelIndex = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionChannelIndex_get, doc=)

static

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

polarizedDataExtractionEnable = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionEnable_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Since: 2.29.0

◆ polarizedDataExtractionInterpolationMode

polarizedDataExtractionInterpolationMode = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionInterpolationMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.primOff, mvIMPACT.acquire.primLinear.

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

Since: 2.29.0

◆ polarizedDataExtractionLowerLimit

polarizedDataExtractionLowerLimit = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionLowerLimit_get, doc=)

static

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

polarizedDataExtractionMode = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionMode_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.prmVertical, mvIMPACT.acquire.prmHorizontal, mvIMPACT.acquire.prmExtractSingle, mvIMPACT.acquire.prmMinimumValue, mvIMPACT.acquire.prmMeanValue, mvIMPACT.acquire.prm2By2, mvIMPACT.acquire.prmExtractAngle, mvIMPACT.acquire.prmExtractDegree, mvIMPACT.acquire.prmPseudoColorRepresentation.

Since: 2.29.0

◆ polarizedDataExtractionUpperLimit

polarizedDataExtractionUpperLimit = property(lib_mvIMPACT_acquire.ImageProcessing_polarizedDataExtractionUpperLimit_get, doc=)

static

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

rotationAngle = property(lib_mvIMPACT_acquire.ImageProcessing_rotationAngle_get, doc=)

static

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

rotationEnable = property(lib_mvIMPACT_acquire.ImageProcessing_rotationEnable_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

Since: 2.13.2

◆ tapSortEnable

tapSortEnable = property(lib_mvIMPACT_acquire.ImageProcessing_tapSortEnable_get, doc=)

static

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 may be: mvIMPACT.acquire.bFalse, mvIMPACT.acquire.bTrue.

◆ thisown

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

static

◆ WBUserSettingsCount

WBUserSettingsCount = property (getWBUserSettingsCount, None, None, None)

static

An integer property (read-only) which holds the number of available user definable parameter sets for white balance correction.

See mvIMPACT.acquire.ImageProcessing.getWBUserSettingsCount()

◆ whiteBalance

whiteBalance = property(lib_mvIMPACT_acquire.ImageProcessing_whiteBalance_get, doc=)

static

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

Valid values for this property may be: mvIMPACT.acquire.wbpTungsten, mvIMPACT.acquire.wbpHalogen, mvIMPACT.acquire.wbpFluorescent, mvIMPACT.acquire.wbpDayLight, mvIMPACT.acquire.wbpPhotoFlash, mvIMPACT.acquire.wbpBlueSky, mvIMPACT.acquire.wbpUser1, mvIMPACT.acquire.wbpUser2, mvIMPACT.acquire.wbpUser3, mvIMPACT.acquire.wbpUser4.

◆ whiteBalanceCalibration

whiteBalanceCalibration = property(lib_mvIMPACT_acquire.ImageProcessing_whiteBalanceCalibration_get, doc=)

static

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 may be: mvIMPACT.acquire.wbcmOff, mvIMPACT.acquire.wbcmNextFrame, mvIMPACT.acquire.wbcmContinuous.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ getGainOffsetKneeParameter()

◆ getGainOffsetKneeParameterCount()

◆ getLUTParameter()

◆ getLUTParameterCount()

◆ getMirrorParameter()

◆ getMirrorParameterCount()

◆ getWBUserSetting()

◆ getWBUserSettingsCount()

◆ setSaturation()

Property Documentation

◆ adaptiveEdgeSensingPlusSharpenGain

◆ adaptiveEdgeSensingPlusSharpenThreshold

◆ bayerConversionMode

◆ channelSplitChannelIndex

◆ channelSplitDeinterlaceEnable

◆ channelSplitEnable

◆ channelSplitMode

◆ colorProcessing

◆ colorTwistEnable

◆ colorTwistInputCorrectionMatrixEnable

◆ colorTwistInputCorrectionMatrixMode

◆ colorTwistInputCorrectionMatrixRow0

◆ colorTwistInputCorrectionMatrixRow1

◆ colorTwistInputCorrectionMatrixRow2

◆ colorTwistOutputCorrectionMatrixEnable

◆ colorTwistOutputCorrectionMatrixMode

◆ colorTwistOutputCorrectionMatrixRow0

◆ colorTwistOutputCorrectionMatrixRow1

◆ colorTwistOutputCorrectionMatrixRow2

◆ colorTwistResultingMatrixRow0

◆ colorTwistResultingMatrixRow1

◆ colorTwistResultingMatrixRow2

◆ colorTwistRow0

◆ colorTwistRow1

◆ colorTwistRow2

◆ darkCurrentFilterCalibrationImageCount

◆ darkCurrentFilterMode

◆ defectivePixelOffsetX

◆ defectivePixelOffsetY

◆ defectivePixelReadFromDevice

◆ defectivePixelsFilterColdPixelDeviation_pc

◆ defectivePixelsFilterLeakyPixelDeviation_ADCLimit

◆ defectivePixelsFilterMode

◆ defectivePixelsFound

◆ defectivePixelsMaxDetectionCount

◆ defectivePixelWriteToDevice

◆ filter

◆ flatFieldFilterCalibrationAoiHeight

◆ flatFieldFilterCalibrationAoiMode

◆ flatFieldFilterCalibrationAoiOffsetX

◆ flatFieldFilterCalibrationAoiOffsetY

◆ flatFieldFilterCalibrationAoiWidth

◆ flatFieldFilterCalibrationImageCount

◆ flatFieldFilterCorrectionAoiHeight

◆ flatFieldFilterCorrectionAoiMode

◆ flatFieldFilterCorrectionAoiOffsetX

◆ flatFieldFilterCorrectionAoiOffsetY

◆ flatFieldFilterCorrectionAoiWidth

◆ flatFieldFilterCorrectionMode

◆ flatFieldFilterCorrectionModeReverseX

◆ flatFieldFilterCorrectionModeReverseY

◆ flatFieldFilterMode

◆ formatReinterpreterBayerMosaicParity

◆ formatReinterpreterEnable

◆ formatReinterpreterMode

◆ gainOffsetKneeEnable

◆ gainOffsetKneeMasterOffset_pc

◆ gainOffsetKneeParameterCount

◆ LUTEnable

◆ LUTImplementation

◆ LUTInterpolationMode

◆ LUTMappingHardware

◆ LUTMappingSoftware

◆ LUTMode

◆ init()