MirrorFeature Class Reference

#include <peak_icv/pipeline/features/peak_icv_mirror_feature.hpp>

Inheritance diagram for MirrorFeature:

Public Member Functions
	MirrorFeature (detail::TransformationModule &module)
	Creates a MirrorFeature for an existing transformation module.
void	SetEnabled (bool enabled) override
	Enables or disables the feature.
bool	IsEnabled () const override
	Gets whether this feature is currently enabled.
void	ResetToDefault () override
	Resets the mirroring to the default value.
void	SetLeftRightEnabled (bool enabled)
	Sets whether the image should be mirrored left-right.
void	SetUpDownEnabled (bool enabled)
	Sets whether the image should be mirrored up-down.
bool	IsLeftRightEnabled () const
	Gets the current left-right mirroring setting.
bool	IsUpDownEnabled () const
	Gets the current up-down mirroring setting.

Detailed Description

Mirror provides functionality to flip the image left-right or up-down.

Note

When processing images with a Bayer pattern, the result may have a different pixel format, though the bit depth remains unchanged. Ensure your application can handle potential pixel format changes after mirroring.

Defaults

• no mirroring

Since

ids_peak_icv 1.0

Constructor & Destructor Documentation

MirrorFeature()

MirrorFeature ( detail::TransformationModule & module )

inlineexplicit

Creates a MirrorFeature for an existing transformation module.

Parameters

module

Reference to the underlying detail::TransformationModule.

Since

ids_peak_icv 1.0

Member Function Documentation

IsEnabled()

bool IsEnabled ( ) const

inlineoverridevirtual

Gets whether this feature is currently enabled.

Returns

true if enabled; otherwise false.

Since

ids_peak_icv 1.0

Implements IFeature.

IsLeftRightEnabled()

bool IsLeftRightEnabled ( ) const

inline

Gets the current left-right mirroring setting.

Returns

True if left-right mirroring is enabled so that left and right will be flipped.

Since

ids_peak_icv 1.0

IsUpDownEnabled()

bool IsUpDownEnabled ( ) const

inline

Gets the current up-down mirroring setting.

Returns

True if up-down mirroring is enabled so that up and down will be flipped.

Since

ids_peak_icv 1.0

ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets the mirroring to the default value.

Note

The enabled state does not change when calling this function.

Since

ids_peak_icv 1.0

Implements IFeature.

SetEnabled()

void SetEnabled ( bool enabled )

inlineoverridevirtual

Enables or disables the feature.

Parameters

enabled

Set to true to enable, or false to disable.

Since

ids_peak_icv 1.0

Implements IFeature.

SetLeftRightEnabled()

void SetLeftRightEnabled ( bool enabled )

inline

Sets whether the image should be mirrored left-right.

Parameters

enabled

If true, the image will be mirrored along the vertical axis.

Since

ids_peak_icv 1.0

SetUpDownEnabled()

void SetUpDownEnabled ( bool enabled )

inline

Sets whether the image should be mirrored up-down.

Parameters

enabled

If true, the image will be mirrored along the horizontal axis.

Since

ids_peak_icv 1.0