IGain Interface Reference

Inheritance diagram for IGain:

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
float	Master [get, set]
	Gets or sets the master gain value applied to all channels.
float	Red [get, set]
	Gets or sets the gain value for the red channel.
float	Green [get, set]
	Gets or sets the gain value for the green channel.
float	Blue [get, set]
	Gets or sets the gain value for the blue channel.
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 gain control functionality.

A gain module consists of a master gain applied to all channels, along with individual gain values for the red, green, and blue channels.

Since

IDSImaging.Peak.Common 1.3

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.

Property Documentation

Blue

float Blue

getset

Gets or sets the gain value for the blue channel.

Implemented in GainModule.

Green

float Green

getset

Gets or sets the gain value for the green channel.

Implemented in GainModule.

IsEnabled

bool IsEnabled

getsetinherited

Gets or sets whether the module is enabled.

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

Master

float Master

getset

Gets or sets the master gain value applied to all channels.

This value is applied uniformly to all color channels.

Implemented in GainModule.

Red

float Red

getset

Gets or sets the gain value for the red channel.

Implemented in GainModule.

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.