IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
Public Member Functions | Properties
TransformationModule Class Reference
IDS peak ICV » .NET » Image Pipeline » Pipeline Modules
Inheritance diagram for TransformationModule:
Inheritance graph
[legend]

Public Member Functions

override Image Process (Image inputImage)
 Processes the input image and returns a mirrored and/or rotated copy based on current settings.
 
override object Process (object input)
 Processes the input image and returns a mirrored and/or rotated copy based on current settings.
 
override void Serialize (IArchive archive)
 Serializes the object's internal state into the provided archive.
 
override void Deserialize (IArchive archive)
 Restores the object's state from the provided archive.
 
override void ResetToDefault ()
 Resets all parameters to their default values.
 

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.
 
override bool IsEnabled [get, set]
 Gets or sets whether the module is enabled.
 
bool MirrorLeftRight = DefaultMirrorLeftRight [get, set]
 Sets whether the image should be mirrored left-right (along the vertical axis).
 
bool MirrorUpDown = DefaultMirrorUpDown [get, set]
 Sets whether the image should be mirrored up-down (along the horizontal axis).
 
Rotation RotationAngle = DefaultRotationAngle [get, set]
 The current rotation angle.
 
int Version = 1 [get]
 The module version.
 

Detailed Description

Transformation is an image pipeline module that provides mirror and rotation functionality.

See also
Features.MirrorFeature, Features.RotationFeature
Since
IDSImaging.Peak.ICV 1.3

Definition at line 17 of file TransformationModule.cs.

Member Function Documentation

◆ Deserialize()

override 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.

Note
This function requires that the archive contains all expected fields as produced by a corresponding Serialize call.
Parameters
archiveThe source archive containing the serialized parameters.
Exceptions
IcvCorruptedExceptionThe archive is malformed, misses keys or the values are invalid.
IcvNotSupportedExceptionThe Version entry indicates an unsupported version.

Reimplemented from ModuleBase.

Definition at line 213 of file TransformationModule.cs.

◆ Process() [1/2]

override Image Process ( Image inputImage)
inline

Processes the input image and returns a mirrored and/or rotated copy based on current settings.

Note
Supported pixel formats: BayerGR8, BayerGR10, BayerGR12, BayerRG8, BayerRG10, BayerRG12, BayerGB8, BayerGB10, BayerGB12, BayerBG8, BayerBG10, BayerBG12, Mono8, Mono10, Mono12, Mono16, Confidence8, Confidence16, Coord3D_C8, Coord3D_C16, Coord3D_C32f, Coord3D_ABC32f, RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12, Mono32fIDS, RGB32fIDS
Note
When processing images with a Bayer pattern, the result may have a different pixel format, though the bit depth remains unchanged.
Note
This operation disregards any specified image regions and processes the entire image.
Parameters
inputImageThe input image to be processed.
Returns
A new image object that is the transformed result of the input.
Exceptions
IcvNotSupportedExceptionThe inputImage has any other than the supported pixel formats.

Definition at line 93 of file TransformationModule.cs.

◆ Process() [2/2]

override object Process ( object input)
inlinevirtual

Processes the input image and returns a mirrored and/or rotated copy based on current settings.

Note
Supported pixel formats: BayerGR8, BayerGR10, BayerGR12, BayerRG8, BayerRG10, BayerRG12, BayerGB8, BayerGB10, BayerGB12, BayerBG8, BayerBG10, BayerBG12, Mono8, Mono10, Mono12, Mono16, Confidence8, Confidence16, Coord3D_C8, Coord3D_C16, Coord3D_C32f, Coord3D_ABC32f, RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12, Mono32fIDS, RGB32fIDS
Note
When processing images with a Bayer pattern, the result may have a different pixel format, though the bit depth remains unchanged.
Note
This operation disregards any specified image regions and processes the entire image.
Parameters
inputThe input image to be processed.
Returns
A new image object that is the transformed result of the input.
Exceptions
IcvNotSupportedExceptionThe input has any other than the supported pixel formats.

Reimplemented from ModuleBase.

Definition at line 157 of file TransformationModule.cs.

◆ ResetToDefault()

override void ResetToDefault ( )
inlinevirtual

Resets all parameters to their default values.

Default values:

Note
The enabled state does not change when calling this function.

Reimplemented from ModuleBase.

Definition at line 258 of file TransformationModule.cs.

◆ Serialize()

override 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
archiveThe target archive that will store the serialized parameters.

Reimplemented from ModuleBase.

Definition at line 173 of file TransformationModule.cs.

Property Documentation

◆ IsEnabled

override bool IsEnabled
getset

Gets or sets whether the module is enabled.

Implements IModule.

Definition at line 35 of file TransformationModule.cs.

◆ MirrorLeftRight

bool MirrorLeftRight = DefaultMirrorLeftRight
getset

Sets whether the image should be mirrored left-right (along the vertical axis).

Definition at line 48 of file TransformationModule.cs.

◆ MirrorUpDown

bool MirrorUpDown = DefaultMirrorUpDown
getset

Sets whether the image should be mirrored up-down (along the horizontal axis).

Definition at line 53 of file TransformationModule.cs.

◆ RotationAngle

Rotation RotationAngle = DefaultRotationAngle
getset

The current rotation angle.

Definition at line 58 of file TransformationModule.cs.

◆ 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.

Definition at line 32 of file TransformationModule.cs.

◆ Version

int Version = 1
getinherited

The module version.

Definition at line 20 of file ModuleBase.cs.