IAutoFeature Interface Reference

Inheritance diagram for IAutoFeature:

Public Member Functions
void	SetGainModule (IGain? gainModule)
	Called by the pipeline to set the gain module for the auto-feature module.
void	SetColorCorrectionMatrix (float[] matrix)
	Notifies the auto-feature module of the currently used color correction matrix.
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 modules that provide auto-feature functionality.

Defines the members that any auto-feature module must implement.

Auto-feature modules participate in the pipeline and may control other modules (such as gain modules) in order to automatically adjust processing parameters based on runtime data.

Since

IDSImaging.Peak.Common 1.3

Definition at line 17 of file IAutoFeature.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 )

inherited

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

inherited

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.

SetColorCorrectionMatrix()

void SetColorCorrectionMatrix

(

float[]

matrix

)

Notifies the auto-feature module of the currently used color correction matrix.

Allows the auto-feature module to adjust its internal algorithms and gain values based on the provided color correction matrix.

The matrix represents a 3x3 color correction matrix and is expected to be supplied in row-major order.

Parameters

matrix

A read-only span containing exactly nine elements representing a 3x3 color correction matrix.

SetGainModule()

void SetGainModule

(

IGain?

gainModule

)

Called by the pipeline to set the gain module for the auto-feature module.

This method provides the gain module that the auto-feature module may use to apply gain adjustments as needed.

Implementations should not assume ownership of the provided gain module and should not dispose of it.

Parameters

gainModule

The gain module to be controlled by the auto-feature module.

Property Documentation

IsEnabled

bool IsEnabled

getsetinherited

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

getinherited

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.