MonoConversionModule Class Reference

Inheritance diagram for MonoConversionModule:

Public Member Functions
	MonoConversionModule ()
	Creates an instance of class MonoConversionModule.
void	Dispose ()
	Releases all resources used by this class.
override void	ResetToDefault ()
	Calling this method has no effect.
override Image	Process (Image inputImage)
	Converts the input image to the configured output pixel format.
void	ReleaseBuffers ()
	Frees unused internal buffers.
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.

Properties
override string	TypeId [get]
	The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.
int	Version = 1 [get]
	The module version.
virtual bool	IsEnabled = true [get, set]
	Get whether this module is enabled.

Detailed Description

Mono conversion is an image pipeline module that converts images to a monochrome format.

The mono conversion module performs a mono (grayscale) conversion on input images. When enabled, it converts the input image to a mono format while preserving the input bit depth. If disabled, the input image is passed through unchanged.

Since

IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

MonoConversionModule()

MonoConversionModule ( )

inline

Creates an instance of class MonoConversionModule.

Member Function Documentation

Deserialize()

virtual void Deserialize ( IArchive archive )

inlinevirtualinherited

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.

Dispose()

void Dispose ( )

inline

Releases all resources used by this class.

Process() [1/2]

virtual object Process ( object input )

inlinevirtualinherited

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.

Process() [2/2]

override Image Process ( Image inputImage )

inline

Converts the input image to the configured output pixel format.

Note

This operation disregards any specified image regions and processes the full image.

Parameters

inputImage

The input image to convert.

Returns

Converted image in the configured pixel format.

ReleaseBuffers()

void ReleaseBuffers ( )

inline

Frees unused internal buffers.

This module uses pre-allocated internal buffers to accelerate conversions. When the image size or pixel format changes, new buffers are allocated, which may cause the internal buffer pool to grow over time. This function can be used to release unused buffers and reduce memory usage.

Note

Avoid calling this function too frequently (e.g., after every resize or format change), as it introduces some overhead.

ResetToDefault()

override void ResetToDefault ( )

inlinevirtual

Calling this method has no effect.

Reimplemented from ModuleBase.

Serialize()

virtual void Serialize ( IArchive archive )

inlinevirtualinherited

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

getsetinherited

Get whether this module is enabled.

When disabled, Process returns the input image unchanged.

Implements IModule.

TypeId

override string TypeId

get

The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.

Implements IModule.

Version

int Version = 1

getinherited

The module version.