 |
IDS peak ICV v1.5.0
|
|
IDS peak ICV v1.5.0
|
Public Member Functions | |
| None | __init__ (self) |
| Creates a HotpixelCorrectionModule module with default settings (no correction). | |
| str | type (self) |
| Returns the type of the module for serialization purposes. | |
| bool | enabled (self) |
| Gets whether this module is enabled. | |
| None | enabled (self, bool enabled) |
| Enables or disables the module. | |
| PointArray | hotpixel_list (self) |
| Gets the current array of known hot pixels. | |
| None | hotpixel_list (self, PointArray pixel_list) |
| Sets the array of known hot pixels. | |
| Interval | sensitivity_range (self) |
| Gets the valid range for sensitivity. | |
| None | detect (self, Image image, int sensitivity=3, float gain_factor=1.0) |
| Performs immediate hot pixel detection on the given image. | |
| Image | process (self, Image input_image) |
| Applies hot pixel correction to the input image in place and returns a reference to the modified image. | |
| None | reset_to_default (self) |
| Resets the hotpixel list to its default value (empty list). | |
| None | serialize (self, IArchive archive) |
| Serializes the object's internal state into the provided archive. | |
| None | deserialize (self, IArchive archive) |
| Restores the object's state from the provided archive. | |
Data Fields | |
| enabled | |
| hotpixel_list = [] | |
Static Public Attributes | |
| np | DEFAULT_HOTPIXEL_LIST = np.empty(0, dtype=Point) |
Protected Member Functions | |
| None | _apply_pixel_list (self) |
| None | _call_backend_set_list (self, npt.NDArray pixel_list) |
| None | _call_backend_get_list (self) |
Protected Attributes | |
| bool | _hotpixel_correction_enabled = True |
| np.ndarray|None | _hotpixel_list = self.DEFAULT_HOTPIXEL_LIST |
| _handle = _hotpixel_correction_handle | |
| np | _hotpixel_list |
| _enabled | |
Hotpixel correction is an image pipeline module for detecting and correcting hot pixels in camera images.
Provides the feature HotpixelCorrectionFeature.
| None __init__ | ( | self | ) |
Creates a HotpixelCorrectionModule module with default settings (no correction).
Reimplemented from ModuleBase.
|
protected |
|
protected |
|
protected |
| None deserialize | ( | self, | |
| IArchive | archive ) |
Restores the object's state from the provided archive.
This function reads and applies all necessary parameters from the given archive to reconstruct the internal state of the object. It ensures that the object is restored to a valid and consistent state.
| archive | The source archive containing the serialized parameters. |
| CorruptedException | If Archive is malformed, misses keys or the values are invalid |
| NotSupportedException | If the 'Version' entry indicates an unsupported version. |
Reimplemented from ModuleBase.
| None detect | ( | self, | |
| Image | image, | ||
| int | sensitivity = 3, | ||
| float | gain_factor = 1.0 ) |
Performs immediate hot pixel detection on the given image.
This method analyzes the provided image and detects hot pixels based on the sensitivity setting. The results are stored internally and can be accessed using pixel_list.
Note: Calling this function will overwrite any existing hot pixel list previously set via pixel_list.
| image | The input image to analyze for hot pixel detection. |
| sensitivity | Sensitivity for hot pixel detection. A higher sensitivity may result in detecting more hot pixels, including possible false positives. |
| gain_factor | Gain factor applied to the image. Used to account for increased noise levels when detecting hot pixels. |
| NotSupportedException | If image has any other than the supported pixel formats. |
| bool enabled | ( | self | ) |
Gets whether this module is enabled.
When disabled, :func:process returns the input image unchanged.
Reimplemented from ModuleBase.
| None enabled | ( | self, | |
| bool | enabled ) |
Enables or disables the module.
When disabled, :func:process returns the input image unchanged.
| enabled | True to enable, False to disable. |
Reimplemented from ModuleBase.
| PointArray hotpixel_list | ( | self | ) |
Gets the current array of known hot pixels.
| None hotpixel_list | ( | self, | |
| PointArray | pixel_list ) |
Sets the array of known hot pixels.
| pixel_list | An array of hot pixel positions to use. |
Applies hot pixel correction to the input image in place and returns a reference to the modified image.
|
|
See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.
The correction is performed based on the current configuration of the module. The operation modifies the input image directly and does not create a copy.
|
|
See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.
Images with other formats are passed through unmodified.
This operation disregards any specified image regions and processes the entire image.
| input_image | The input image to be processed and corrected. |
| NotSupportedException | If image has any other than the supported pixel formats. |
| None reset_to_default | ( | self | ) |
Resets the hotpixel list to its default value (empty list).
| Interval sensitivity_range | ( | self | ) |
| None serialize | ( | self, | |
| IArchive | archive ) |
Serializes the object's internal state into the provided archive.
This function populates the given archive with all parameters required to fully represent the current state of the object. It ensures that the object can be reconstructed or transmitted accurately by saving all relevant data members in a consistent and structured format.
| archive | The target archive that will store the serialized parameters. |
Reimplemented from ModuleBase.
| str type | ( | self | ) |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
static |
| enabled |
| hotpixel_list = [] |