IModule Interface Reference

Inheritance diagram for IModule:

Public Member Functions
object	Process (object input)
	Processes input data and returns the result.
void	ResetToDefault ()
	Resets the module to its default state.
void	Serialize (IArchive archive)
	Serializes the current object into the provided archive.
void	Deserialize (IArchive archive)
	Deserializes the object's state from the provided archive.

Properties
bool	IsEnabled [get, set]
	Gets or sets whether the module is enabled.
string	TypeId [get]
	The unique type identifier for this module implementation.

Detailed Description

Interface for a module used within a pipeline.

Defines the required members that must be implemented by any module participating in the pipeline. Modules support enabling/disabling, processing input, and serialization.

Since

IDSImaging.Peak.Common 1.3

Definition at line 18 of file IModule.cs.

Member Function Documentation

Deserialize()

void Deserialize ( IArchive archive )

inherited

Deserializes the object's state from the provided archive.

This method reads data from the given IArchive and reconstructs the internal state of the object.

Parameters

archive

The archive from which to read the object's data.

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, ModuleBase, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, UnpackModule, and ColorCorrectionMatrix.

Process()

object Process

(

object

input

)

Processes input data and returns the result.

This function is called by the pipeline to process a unit of data.

Parameters

input

The input data to process.

Returns

The processed input.

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

ResetToDefault()

void ResetToDefault

(

)

Resets the module to its default state.

The enabled state is not reset.

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

Serialize()

void Serialize ( IArchive archive )

inherited

Serializes the current object into the provided archive.

This method writes the internal state of the object into the given IArchive so that it can later be reconstructed using Deserialize.

Parameters

archive

The archive to which the object's data will be written.

Implemented in ColorMatrixTransformationModule, DebayerModule, DownsamplingModule, GainModule, HotpixelCorrectionModule, ModuleBase, PixelFormatConversionModule, SharpeningModule, ToneCurveCorrectionModule, TransformationModule, UnpackModule, and ColorCorrectionMatrix.

Property Documentation

IsEnabled

bool IsEnabled

getset

Gets or sets whether the module is enabled.

Implemented in ColorMatrixTransformationModule, GainModule, ModuleBase, ToneCurveCorrectionModule, TransformationModule, and UnpackModule.

Definition at line 23 of file IModule.cs.

TypeId

string TypeId

get

The unique type identifier for this module implementation.

This should be a unique string identifying the specific implementation of the module.

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

Definition at line 32 of file IModule.cs.