Impact Acquire SDK Java
ImageProcessing Class Reference

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

Inheritance diagram for ImageProcessing:
[legend]

Public Member Functions

synchronized void delete ()
 
PropertyF getAdaptiveEdgeSensingPlusSharpenGain ()
 A floating point property defining the intensity of the sharpening during AdaptiveEdgeSensingPlus deBayering.
 
PropertyI getAdaptiveEdgeSensingPlusSharpenThreshold ()
 An integer property defining the max.
 
PropertyI getBayerConversionMode ()
 An enumerated integer property defining what kind of algorithm shall be used during Bayer to RGB conversion.
 
PropertyI getChannelSplitChannelIndex ()
 An integer property which can be used to define which channel of the image shall be extracted.
 
PropertyI getChannelSplitDeinterlaceEnable ()
 An enumerated integer property which can be used to enable/disable data re-ordering for interlaced images.
 
PropertyI getChannelSplitEnable ()
 An enumerated integer property which can be used to enable/disable automatic data re-ordering or extraction from multi-channel images.
 
PropertyI getChannelSplitMode ()
 An enumerated integer property which can be used to define how data from multi-channel images shall be re-ordered.
 
PropertyI getColorProcessing ()
 An enumerated integer property defining what kind of color processing shall be applied to the raw image data.
 
PropertyI getColorTwistEnable ()
 An enumerated integer property which can be used to enable/disable the color twist matrix.
 
PropertyI getColorTwistInputCorrectionMatrixEnable ()
 An enumerated integer property which can be used to enable/disable the color twist input correction matrix.
 
PropertyI getColorTwistInputCorrectionMatrixMode ()
 An enumerated integer property which can be used to select an input color correction matrix.
 
PropertyF getColorTwistInputCorrectionMatrixRow0 ()
 The first row of the input color correction matrix.
 
PropertyF getColorTwistInputCorrectionMatrixRow1 ()
 The second row of the input color correction matrix.
 
PropertyF getColorTwistInputCorrectionMatrixRow2 ()
 The third row of the input color correction matrix.
 
PropertyI getColorTwistOutputCorrectionMatrixEnable ()
 An enumerated integer property which can be used to enable/disable the color twist output correction matrix.
 
PropertyI getColorTwistOutputCorrectionMatrixMode ()
 An enumerated integer property which can be used to select an output color correction matrix.
 
PropertyF getColorTwistOutputCorrectionMatrixRow0 ()
 The first row of the output color correction matrix.
 
PropertyF getColorTwistOutputCorrectionMatrixRow1 ()
 The second row of the output color correction matrix.
 
PropertyF getColorTwistOutputCorrectionMatrixRow2 ()
 The third row of the output color correction matrix.
 
PropertyF getColorTwistResultingMatrixRow0 ()
 The first row of the resulting color twist matrix.
 
PropertyF getColorTwistResultingMatrixRow1 ()
 The second row of the resulting color twist matrix.
 
PropertyF getColorTwistResultingMatrixRow2 ()
 The third row of the resulting color twist matrix.
 
PropertyF getColorTwistRow0 ()
 The first row of the color twist matrix.
 
PropertyF getColorTwistRow1 ()
 The second row of the color twist matrix.
 
PropertyF getColorTwistRow2 ()
 The third row of the color twist matrix.
 
PropertyI getDarkCurrentFilterCalibrationImageCount ()
 An integer property defining the number of consecutive images to take into account during calibration of the dark current filter.
 
PropertyI getDarkCurrentFilterMode ()
 An enumerated integer property defining the operation mode of the dark current filter.
 
PropertyI getDefectivePixelOffsetX ()
 An integer property defining a list of X-offsets of all pixels currently treated as defective.
 
PropertyI getDefectivePixelOffsetY ()
 An integer property defining a list of Y-offsets of all pixels currently treated as defective.
 
Method getDefectivePixelReadFromDevice ()
 Calling this method will download defective pixels from the device.
 
PropertyI getDefectivePixelsFilterColdPixelDeviation_pc ()
 An integer property defining the max.
 
PropertyI getDefectivePixelsFilterLeakyPixelDeviation_ADCLimit ()
 An integer property defining the max.
 
PropertyI getDefectivePixelsFilterMode ()
 An enumerated integer property defining the operation mode of the defective pixels filter.
 
PropertyI getDefectivePixelsFound ()
 An integer property (read-only) containing the number of pixels considered as being defective with respect to the.
 
PropertyI getDefectivePixelsMaxDetectionCount ()
 An integer property defining maximum the number of pixels considered as being defective during consecutive calibration runs.
 
Method getDefectivePixelWriteToDevice ()
 Calling this method will upload defective pixels from the device.
 
PropertyI getFilter ()
 An enumerated integer property defining the filter to be applied to the image before it is transferred to the user.
 
PropertyI getFlatFieldFilterCalibrationAoiHeight ()
 An integer property defining the calibration AOI's height of the flat field correction filter.
 
PropertyI getFlatFieldFilterCalibrationAoiMode ()
 An enumerated integer property defining the correction AOI mode of the flat field correction filter.
 
PropertyI getFlatFieldFilterCalibrationAoiOffsetX ()
 An integer property defining the calibration AOI's X-offset of the flat field correction filter.
 
PropertyI getFlatFieldFilterCalibrationAoiOffsetY ()
 An integer property defining the calibration AOI's Y-offset of the flat field correction filter.
 
PropertyI getFlatFieldFilterCalibrationAoiWidth ()
 An integer property defining the calibration AOI's width of the flat field correction filter.
 
PropertyI getFlatFieldFilterCalibrationImageCount ()
 An integer property defining the number of consecutive images to take into account during the calibration of the flat field filter.
 
PropertyI getFlatFieldFilterCorrectionAoiHeight ()
 An integer property defining the correction AOI's height of the flat field correction filter.
 
PropertyI getFlatFieldFilterCorrectionAoiMode ()
 An enumerated integer property defining the correction AOI mode of the flat field correction filter.
 
PropertyI getFlatFieldFilterCorrectionAoiOffsetX ()
 An integer property defining the correction AOI's X-offset of the flat field correction filter.
 
PropertyI getFlatFieldFilterCorrectionAoiOffsetY ()
 An integer property defining the correction AOI's Y-offset of the flat field correction filter.
 
PropertyI getFlatFieldFilterCorrectionAoiWidth ()
 An integer property defining the correction AOI's width of the flat field correction filter.
 
PropertyI getFlatFieldFilterCorrectionMode ()
 An enumerated integer property defining the correction mode of the flat field correction filter.
 
PropertyI getFlatFieldFilterCorrectionModeReverseX ()
 An enumerated integer property defining the X-orientation that shall be used when applying the correction.
 
PropertyI getFlatFieldFilterCorrectionModeReverseY ()
 An enumerated integer property defining the Y-orientation that shall be used when applying the correction.
 
PropertyI getFlatFieldFilterMode ()
 An enumerated integer property defining the operation mode of the flat field correction filter.
 
PropertyI getFormatReinterpreterBayerMosaicParity ()
 An enumerated integer property defining the new Bayer parity of this buffer.
 
PropertyI getFormatReinterpreterEnable ()
 An enumerated integer property which can be used to enable/disable the format reinterpreter filter.
 
PropertyI getFormatReinterpreterMode ()
 An enumerated integer property which can be used to configure the format reinterpreter filter.
 
PropertyI getGainOffsetKneeEnable ()
 An enumerated integer property which can be used to enable the Gain, Offset, Knee filter.
 
PropertyF getGainOffsetKneeMasterOffset_pc ()
 A float property that contains master offset(in percent).
 
GainOffsetKneeChannelParameters getGainOffsetKneeParameter (long index)
 Returns a reference to a set of user definable parameters to configure a certain channel of the GainOffsetKnee filter.
 
long getGainOffsetKneeParameterCount ()
 Returns the number of available user definable parameter sets for the GainOffsetKnee filter.
 
PropertyI getLUTEnable ()
 An enumerated integer property which can be used to enable LUT (Look Up Table) transformations.
 
PropertyI getLUTImplementation ()
 An enumerated integer property which can be used to configure the LUT (Look Up Table) implementation.
 
PropertyI getLUTInterpolationMode ()
 An enumerated integer property which can be used to configure the LUT (Look Up Table) interpolation mode.
 
PropertyI getLUTMappingHardware ()
 An enumerated integer property which can be used to configure the LUT (Look Up Table) mapping mode for LUT transformations done by the hardware.
 
PropertyI getLUTMappingSoftware ()
 An enumerated integer property which can be used to configure the LUT (Look Up Table) mapping mode for LUT transformations done optimized software algorithms.
 
PropertyI getLUTMode ()
 An enumerated integer property which can be used to configure the LUT (Look Up Table) transformation mode.
 
LUTParameters getLUTParameter (long index)
 Returns a reference to a set of user definable parameters to configure LUT (Look Up Table) operations.
 
long getLUTParameterCount ()
 Returns the number of available user definable parameter sets for LUT (Look Up Table) operations.
 
PropertyI getMirrorModeGlobal ()
 An enumerated integer property defining the mirror mode to be applied to ALL channels of the image.
 
PropertyI getMirrorOperationMode ()
 An enumerated integer property defining the general mode the mirror filter will work in.
 
MirrorParameters getMirrorParameter (long index)
 Returns a reference to a set of user definable parameters to configure mirror filter related features.
 
long getMirrorParameterCount ()
 Returns the number of available user definable parameter sets mirror filter related operations.
 
PropertyI getPolarizedDataExtractionChannelIndex ()
 An integer property defining the channel within the processing window of the polarization data extraction filter.
 
PropertyI getPolarizedDataExtractionEnable ()
 An enumerated integer property defining whether the polarization data extraction filter shall be active or not.
 
PropertyI getPolarizedDataExtractionInterpolationMode ()
 An enumerated integer property defining the interpolation mode the polarization data extraction filter shall be operated in.
 
PropertyI getPolarizedDataExtractionLowerLimit ()
 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.
 
PropertyI getPolarizedDataExtractionMode ()
 An enumerated integer property defining in which mode the polarization data extraction filter shall be operated in.
 
PropertyI getPolarizedDataExtractionUpperLimit ()
 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.
 
PropertyF getRotationAngle ()
 The counterclockwise angle at which the image will be rotated.
 
PropertyI getRotationEnable ()
 An enumerated integer property which can be used to enable/disable the rotation filter.
 
PropertyI getTapSortEnable ()
 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.
 
WhiteBalanceSettings getWBUserSetting (long index)
 Returns a reference to a set of user definable parameters to perform a white balance correction.
 
long getWBUserSettingsCount ()
 Returns the number of available user definable parameter sets for white balance correction.
 
PropertyI getWhiteBalance ()
 An integer property defining the parameter set to be used to perform the white balance correction.
 
PropertyI getWhiteBalanceCalibration ()
 An enumerated integer property defining the mode used for white balance calibration.
 
int hObj ()
 Returns a unique identifier for the component collection referenced by this object.
 
 ImageProcessing (Device pDev)
 Constructs a new mvIMPACT.acquire.ImageProcessing object.
 
 ImageProcessing (Device pDev, String settingName)
 Constructs a new mvIMPACT.acquire.ImageProcessing object.
 
 ImageProcessing (ImageProcessing src)
 Constructs a new mvIMPACT.acquire.ImageProcessing from an existing one.
 
ComponentCollection restoreDefault ()
 Restores the default for every component of this collection.
 
void setSaturation (double K)
 Sets the saturation by using the color twist matrix.
 

Protected Member Functions

void finalize ()
 
 ImageProcessing (long cPtr, boolean cMemoryOwn)
 

Static Protected Member Functions

static long swigRelease (ComponentCollection obj)
 
static long swigRelease (ImageProcessing obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

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

ImageProcessing ( long cPtr,
boolean cMemoryOwn )
protected

◆ ImageProcessing() [2/4]

ImageProcessing ( Device pDev,
String settingName )

Constructs a new mvIMPACT.acquire.ImageProcessing object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName[in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

◆ ImageProcessing() [3/4]

Constructs a new mvIMPACT.acquire.ImageProcessing object.

Parameters
pDev[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

◆ ImageProcessing() [4/4]

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

Member Function Documentation

◆ delete()

synchronized void delete ( )

Reimplemented from ComponentCollection.

◆ finalize()

void finalize ( )
protected

Reimplemented from ComponentCollection.

◆ getAdaptiveEdgeSensingPlusSharpenGain()

PropertyF getAdaptiveEdgeSensingPlusSharpenGain ( )

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

◆ getAdaptiveEdgeSensingPlusSharpenThreshold()

PropertyI getAdaptiveEdgeSensingPlusSharpenThreshold ( )

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

◆ getBayerConversionMode()

PropertyI getBayerConversionMode ( )

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.

◆ getChannelSplitChannelIndex()

PropertyI getChannelSplitChannelIndex ( )

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.getChannelSplitMode() is set to mvIMPACT.acquire.TChannelSplitMode.csmExtractSingle.

◆ getChannelSplitDeinterlaceEnable()

PropertyI getChannelSplitDeinterlaceEnable ( )

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.

◆ getChannelSplitEnable()

PropertyI getChannelSplitEnable ( )

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.

◆ getChannelSplitMode()

PropertyI getChannelSplitMode ( )

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.

◆ getColorProcessing()

PropertyI getColorProcessing ( )

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.

◆ getColorTwistEnable()

PropertyI getColorTwistEnable ( )

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.

◆ getColorTwistInputCorrectionMatrixEnable()

PropertyI getColorTwistInputCorrectionMatrixEnable ( )

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.

◆ getColorTwistInputCorrectionMatrixMode()

PropertyI getColorTwistInputCorrectionMatrixMode ( )

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.

◆ getColorTwistInputCorrectionMatrixRow0()

PropertyF getColorTwistInputCorrectionMatrixRow0 ( )

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.getColorTwistInputCorrectionMatrixMode() is set to mvIMPACT.acquire.TColorTwistInputCorrectionMatrixMode.cticmmUser. For other values of mvIMPACT.acquire.ImageProcessing.getColorTwistInputCorrectionMatrixMode() modifying this property will have no effect.

Since
2.2.2.

◆ getColorTwistInputCorrectionMatrixRow1()

PropertyF getColorTwistInputCorrectionMatrixRow1 ( )

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.getColorTwistInputCorrectionMatrixMode() is set to mvIMPACT.acquire.TColorTwistInputCorrectionMatrixMode.cticmmUser. For other values of mvIMPACT.acquire.ImageProcessing.getColorTwistInputCorrectionMatrixMode() modifying this property will have no effect.

Since
2.2.2.

◆ getColorTwistInputCorrectionMatrixRow2()

PropertyF getColorTwistInputCorrectionMatrixRow2 ( )

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.getColorTwistInputCorrectionMatrixMode() is set to mvIMPACT.acquire.TColorTwistInputCorrectionMatrixMode.cticmmUser. For other values of mvIMPACT.acquire.ImageProcessing.getColorTwistInputCorrectionMatrixMode() modifying this property will have no effect.

Since
2.2.2.

◆ getColorTwistOutputCorrectionMatrixEnable()

PropertyI getColorTwistOutputCorrectionMatrixEnable ( )

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.

◆ getColorTwistOutputCorrectionMatrixMode()

PropertyI getColorTwistOutputCorrectionMatrixMode ( )

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.

◆ getColorTwistOutputCorrectionMatrixRow0()

PropertyF getColorTwistOutputCorrectionMatrixRow0 ( )

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.getColorTwistOutputCorrectionMatrixMode() is set to mvIMPACT.acquire.TColorTwistOutputCorrectionMatrixMode.ctocmmUser. For other values of mvIMPACT.acquire.ImageProcessing.getColorTwistOutputCorrectionMatrixMode() modifying this property will have no effect.

Since
2.2.2.

◆ getColorTwistOutputCorrectionMatrixRow1()

PropertyF getColorTwistOutputCorrectionMatrixRow1 ( )

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.getColorTwistOutputCorrectionMatrixMode() is set to mvIMPACT.acquire.TColorTwistOutputCorrectionMatrixMode.ctocmmUser. For other values of mvIMPACT.acquire.ImageProcessing.getColorTwistOutputCorrectionMatrixMode() modifying this property will have no effect.

Since
2.2.2.

◆ getColorTwistOutputCorrectionMatrixRow2()

PropertyF getColorTwistOutputCorrectionMatrixRow2 ( )

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.getColorTwistOutputCorrectionMatrixMode() is set to mvIMPACT.acquire.TColorTwistOutputCorrectionMatrixMode.ctocmmUser. For other values of mvIMPACT.acquire.ImageProcessing.getColorTwistOutputCorrectionMatrixMode() modifying this property will have no effect.

Since
2.2.2.

◆ getColorTwistResultingMatrixRow0()

PropertyF getColorTwistResultingMatrixRow0 ( )

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.

◆ getColorTwistResultingMatrixRow1()

PropertyF getColorTwistResultingMatrixRow1 ( )

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.

◆ getColorTwistResultingMatrixRow2()

PropertyF getColorTwistResultingMatrixRow2 ( )

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.

◆ getColorTwistRow0()

PropertyF getColorTwistRow0 ( )

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.

◆ getColorTwistRow1()

PropertyF getColorTwistRow1 ( )

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.

◆ getColorTwistRow2()

PropertyF getColorTwistRow2 ( )

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.

◆ getDarkCurrentFilterCalibrationImageCount()

PropertyI getDarkCurrentFilterCalibrationImageCount ( )

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

◆ getDarkCurrentFilterMode()

PropertyI getDarkCurrentFilterMode ( )

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.

◆ getDefectivePixelOffsetX()

PropertyI getDefectivePixelOffsetX ( )

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

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.getDefectivePixelsFilterMode() to mvIMPACT.acquire.TDefectivePixelsFilterMode.dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.17.1

◆ getDefectivePixelOffsetY()

PropertyI getDefectivePixelOffsetY ( )

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

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.getDefectivePixelsFilterMode() to mvIMPACT.acquire.TDefectivePixelsFilterMode.dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.17.1

◆ getDefectivePixelReadFromDevice()

Method getDefectivePixelReadFromDevice ( )

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.getDefectivePixelsFilterMode() to mvIMPACT.acquire.TDefectivePixelsFilterMode.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

◆ getDefectivePixelsFilterColdPixelDeviation_pc()

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

◆ getDefectivePixelsFilterLeakyPixelDeviation_ADCLimit()

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

◆ getDefectivePixelsFilterMode()

PropertyI getDefectivePixelsFilterMode ( )

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.

◆ getDefectivePixelsFound()

PropertyI getDefectivePixelsFound ( )

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.getDefectivePixelsFilterMode() to mvIMPACT.acquire.TDefectivePixelsFilterMode.dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.5.9

◆ getDefectivePixelsMaxDetectionCount()

PropertyI getDefectivePixelsMaxDetectionCount ( )

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.getDefectivePixelsFound() 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.getDefectivePixelsFilterMode() to mvIMPACT.acquire.TDefectivePixelsFilterMode.dpfmResetCalibration and then capture a fresh image. Only then all currently detected pixels will be discarded.
Since
2.37.0

◆ getDefectivePixelWriteToDevice()

Method getDefectivePixelWriteToDevice ( )

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

◆ getFilter()

PropertyI getFilter ( )

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.

◆ getFlatFieldFilterCalibrationAoiHeight()

PropertyI getFlatFieldFilterCalibrationAoiHeight ( )

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

Since
2.31.0

◆ getFlatFieldFilterCalibrationAoiMode()

PropertyI getFlatFieldFilterCalibrationAoiMode ( )

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

◆ getFlatFieldFilterCalibrationAoiOffsetX()

PropertyI getFlatFieldFilterCalibrationAoiOffsetX ( )

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

Since
2.31.0

◆ getFlatFieldFilterCalibrationAoiOffsetY()

PropertyI getFlatFieldFilterCalibrationAoiOffsetY ( )

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

Since
2.31.0

◆ getFlatFieldFilterCalibrationAoiWidth()

PropertyI getFlatFieldFilterCalibrationAoiWidth ( )

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

Since
2.31.0

◆ getFlatFieldFilterCalibrationImageCount()

PropertyI getFlatFieldFilterCalibrationImageCount ( )

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

◆ getFlatFieldFilterCorrectionAoiHeight()

PropertyI getFlatFieldFilterCorrectionAoiHeight ( )

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

Since
2.31.0

◆ getFlatFieldFilterCorrectionAoiMode()

PropertyI getFlatFieldFilterCorrectionAoiMode ( )

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

◆ getFlatFieldFilterCorrectionAoiOffsetX()

PropertyI getFlatFieldFilterCorrectionAoiOffsetX ( )

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

Since
2.31.0

◆ getFlatFieldFilterCorrectionAoiOffsetY()

PropertyI getFlatFieldFilterCorrectionAoiOffsetY ( )

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

Since
2.31.0

◆ getFlatFieldFilterCorrectionAoiWidth()

PropertyI getFlatFieldFilterCorrectionAoiWidth ( )

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

Since
2.31.0

◆ getFlatFieldFilterCorrectionMode()

PropertyI getFlatFieldFilterCorrectionMode ( )

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.

◆ getFlatFieldFilterCorrectionModeReverseX()

PropertyI getFlatFieldFilterCorrectionModeReverseX ( )

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

◆ getFlatFieldFilterCorrectionModeReverseY()

PropertyI getFlatFieldFilterCorrectionModeReverseY ( )

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

◆ getFlatFieldFilterMode()

PropertyI getFlatFieldFilterMode ( )

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.

◆ getFormatReinterpreterBayerMosaicParity()

PropertyI getFormatReinterpreterBayerMosaicParity ( )

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

◆ getFormatReinterpreterEnable()

PropertyI getFormatReinterpreterEnable ( )

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

◆ getFormatReinterpreterMode()

PropertyI getFormatReinterpreterMode ( )

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

◆ getGainOffsetKneeEnable()

PropertyI getGainOffsetKneeEnable ( )

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.

◆ getGainOffsetKneeMasterOffset_pc()

PropertyF getGainOffsetKneeMasterOffset_pc ( )

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

This offset will be applied before the channel specific gain.

◆ getGainOffsetKneeParameter()

GainOffsetKneeChannelParameters getGainOffsetKneeParameter ( long 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()

long getGainOffsetKneeParameterCount ( )

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

◆ getLUTEnable()

PropertyI getLUTEnable ( )

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.

◆ getLUTImplementation()

PropertyI getLUTImplementation ( )

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.getLUTEnable() is set to mvIMPACT.acquire.TBoolean.bFalse.

◆ getLUTInterpolationMode()

PropertyI getLUTInterpolationMode ( )

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.getLUTEnable() is set to mvIMPACT.acquire.TBoolean.bFalse or if mvIMPACT.acquire.ImageProcessing.getLUTMode() is NOT set to mvIMPACT.acquire.TLUTMode.LUTmInterpolated.

◆ getLUTMappingHardware()

PropertyI getLUTMappingHardware ( )

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.getLUTEnable() is set to mvIMPACT.acquire.TBoolean.bFalse or if mvIMPACT.acquire.ImageProcessing.getLUTImplementation() is NOT set to mvIMPACT.acquire.TLUTImplementation.LUTiHardware.

◆ getLUTMappingSoftware()

PropertyI getLUTMappingSoftware ( )

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.getLUTEnable() is set to mvIMPACT.acquire.TBoolean.bFalse or if mvIMPACT.acquire.ImageProcessing.getLUTImplementation() is NOT set to mvIMPACT.acquire.TLUTImplementation.LUTiSoftware.

◆ getLUTMode()

PropertyI getLUTMode ( )

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.getLUTEnable() is set to mvIMPACT.acquire.TBoolean.bFalse.

◆ getLUTParameter()

LUTParameters getLUTParameter ( long 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()

long getLUTParameterCount ( )

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

◆ getMirrorModeGlobal()

PropertyI getMirrorModeGlobal ( )

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.getMirrorOperationMode() is set to mvIMPACT.acquire.TMirrorOperationMode.momGlobal.

◆ getMirrorOperationMode()

PropertyI getMirrorOperationMode ( )

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.

◆ getMirrorParameter()

MirrorParameters getMirrorParameter ( long 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()

long getMirrorParameterCount ( )

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

◆ getPolarizedDataExtractionChannelIndex()

PropertyI getPolarizedDataExtractionChannelIndex ( )

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.getPolarizedDataExtractionMode() is set to mvIMPACT.acquire.TPolarizedDataExtractionMode.prmExtractSingle.

Since
2.29.0

◆ getPolarizedDataExtractionEnable()

PropertyI getPolarizedDataExtractionEnable ( )

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

◆ getPolarizedDataExtractionInterpolationMode()

PropertyI getPolarizedDataExtractionInterpolationMode ( )

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

◆ getPolarizedDataExtractionLowerLimit()

PropertyI getPolarizedDataExtractionLowerLimit ( )

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.getPolarizedDataExtractionMode() is set to mvIMPACT.acquire.TPolarizedDataExtractionMode.prmMeanValue.

Since
2.29.0

◆ getPolarizedDataExtractionMode()

PropertyI getPolarizedDataExtractionMode ( )

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

◆ getPolarizedDataExtractionUpperLimit()

PropertyI getPolarizedDataExtractionUpperLimit ( )

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.getPolarizedDataExtractionMode() is set to mvIMPACT.acquire.TPolarizedDataExtractionMode.prmMeanValue.

Since
2.29.0

◆ getRotationAngle()

PropertyF getRotationAngle ( )

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

◆ getRotationEnable()

PropertyI getRotationEnable ( )

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

◆ getTapSortEnable()

PropertyI getTapSortEnable ( )

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.

◆ getWBUserSetting()

WhiteBalanceSettings getWBUserSetting ( long 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.getWhiteBalance() to mvIMPACT.acquire.TWhiteBalanceParameter.wbpUser1, '1' for mvIMPACT.acquire.TWhiteBalanceParameter.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()

long getWBUserSettingsCount ( )

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

◆ getWhiteBalance()

PropertyI getWhiteBalance ( )

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.

◆ getWhiteBalanceCalibration()

PropertyI getWhiteBalanceCalibration ( )

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.TWhiteBalanceCalibrationMode.wbcmNextFrame mode is supported, but new modes might appear in later revisions of the interface.

When this property is set to mvIMPACT.acquire.TWhiteBalanceCalibrationMode.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.TWhiteBalanceCalibrationMode.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.getWhiteBalance(). 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.

◆ hObj()

int hObj ( )
inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns
A unique identifier for the component referenced by this object.

◆ restoreDefault()

ComponentCollection restoreDefault ( )
inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note
The caller must have the right to modify the component. Otherwise an exception will be thrown.
Returns
A const reference to the component.

◆ setSaturation()

void setSaturation ( double 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.getColorTwistEnable().
Parameters
K[in] The saturation value.

◆ swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj)
staticprotectedinherited

◆ swigRelease() [2/2]

static long swigRelease ( ImageProcessing obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protectedinherited