ModuleBase Class Reference

Inheritance diagram for ModuleBase:

Public Member Functions
virtual void	Serialize (IArchive archive)
	Serializes the object's internal state into the provided archive.
virtual void	Deserialize (IArchive archive)
	Restores the object's state from the provided archive.
virtual object	Process (object input)
	Processes input data and returns the result.This function is called by the pipeline to process a unit of data.
virtual void	ResetToDefault ()
	Resets the module to its default state.The enabled state is not reset.
Image	Process (Image inputImage)
	Processes the image.

Properties
int	Version = 1 [get]
	The module version.
virtual bool	IsEnabled = true [get, set]
	Get whether this module is enabled.
string	TypeId [get]
	Gets the module type identifier used for serialization.

Detailed Description

Base class for all pipeline modules.

Since

IDSImaging.Peak.ICV 1.3

Member Function Documentation

Deserialize()

virtual void Deserialize ( IArchive archive )

inlinevirtual

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

IcvCorruptedException	The Archive is malformed, misses keys or the values are invalid.
IcvNotSupportedException	The Version entry indicates an unsupported version.

Implements ISerializable.

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

Process() [1/2]

Image Process ( Image inputImage )

abstract

Processes the image.

Process() [2/2]

virtual object Process ( object input )

inlinevirtual

Processes input data and returns the result.This function is called by the pipeline to process a unit of data.

Implements IModule.

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

ResetToDefault()

virtual void ResetToDefault ( )

inlinevirtual

Resets the module to its default state.The enabled state is not reset.

Implements IModule.

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

Serialize()

virtual void Serialize ( IArchive archive )

inlinevirtual

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 serialized module's internal state.

Implements ISerializable.

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

Property Documentation

IsEnabled

virtual bool IsEnabled = true

getset

Get whether this module is enabled.

When disabled, Process returns the input image unchanged.

Implements IModule.

TypeId

string TypeId

getabstract

Gets the module type identifier used for serialization.

Implements IModule.

Version

int Version = 1

get

The module version.