ModuleBase Class Reference

Inheritance diagram for ModuleBase:

Public Member Functions
None	__init__ (self)
	Creates an instance of class ModuleBase.
int	version (self)
	Return the module version.
bool	enabled (self)
	Gets whether this module is enabled.
None	enabled (self, bool enabled)
	Enables or disables the module.
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
	version

Protected Member Functions
None	_validate_version (self, IArchive archive)
None	_raise_corrupted_archive_key_missing (self, str missing_archive_key)
None	_raise_version_is_not_supported (self, str actual_version, str expected_version)

Protected Attributes
bool	_enabled = True

Detailed Description

Base class for all pipeline modules.

Since

ids_peak_icv 1.0

Constructor & Destructor Documentation

__init__()

None __init__

(

self

)

Creates an instance of class ModuleBase.

Since

ids_peak_icv 1.0

Reimplemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, MonoConversionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

Member Function Documentation

_raise_corrupted_archive_key_missing()

None _raise_corrupted_archive_key_missing ( self, str missing_archive_key )

protected

_raise_version_is_not_supported()

None _raise_version_is_not_supported ( self, str actual_version, str expected_version )

protected

_validate_version()

None _validate_version ( self, IArchive archive )

protected

deserialize()

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.

Parameters

archive

The source archive containing the serialized parameters.

Exceptions

CorruptedException	If Archive is malformed, misses keys or the values are invalid.
NotSupportedException	If the 'Version' entry indicates an unsupported version.

Note

This function requires that the archive contains all expected fields as produced by a corresponding serialize() call.

Since

ids_peak_icv 1.0

Reimplemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

enabled() [1/2]

bool enabled

(

self

)

Gets whether this module is enabled.

When disabled, process returns the input image unchanged.

Returns

True if the module is enabled, False otherwise.

Since

ids_peak_icv 1.0

Reimplemented in ColorMatrixTransformationModule, ColorMatrixTransformationModule, HotpixelCorrectionModule, HotpixelCorrectionModule, ToneCurveCorrectionModule, ToneCurveCorrectionModule, TransformationModule, TransformationModule, UnpackModule, and UnpackModule.

enabled() [2/2]

None enabled	(		self,
		bool	enabled )

Enables or disables the module.

When disabled, process returns the input image unchanged.

Parameters

enabled

True to enable, False to disable.

Since

ids_peak_icv 1.0

Reimplemented in ColorMatrixTransformationModule, ColorMatrixTransformationModule, HotpixelCorrectionModule, HotpixelCorrectionModule, ToneCurveCorrectionModule, ToneCurveCorrectionModule, TransformationModule, TransformationModule, UnpackModule, and UnpackModule.

serialize()

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.

Parameters

archive

The target archive that will store the serialized parameters.

Since

ids_peak_icv 1.0

Reimplemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

version()

int version

(

self

)

Return the module version.

Returns

Module version.

Since

ids_peak_icv 1.0

Reimplemented in ColorMatrixTransformationModule.

Field Documentation

_enabled

bool _enabled = True

protected

enabled

enabled

Reimplemented in ColorMatrixTransformationModule, ColorMatrixTransformationModule, HotpixelCorrectionModule, HotpixelCorrectionModule, ToneCurveCorrectionModule, ToneCurveCorrectionModule, TransformationModule, TransformationModule, UnpackModule, and UnpackModule.

version

version

Reimplemented in ColorMatrixTransformationModule.