MirrorFeature Class Reference

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

Inheritance diagram for MirrorFeature:

Collaboration 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
	Indicates whether the 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

1.0

Definition at line 38 of file peak_icv_mirror_feature.hpp.

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

1.0

Definition at line 109 of file peak_icv_mirror_feature.hpp.

Member Function Documentation

IsEnabled()

bool IsEnabled ( ) const

inlineoverridevirtual

Indicates whether the feature is currently enabled.

Returns

true if enabled; otherwise, false.

Since

1.0

Implements IFeature.

Definition at line 118 of file peak_icv_mirror_feature.hpp.

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

1.0

Definition at line 139 of file peak_icv_mirror_feature.hpp.

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

1.0

Definition at line 144 of file peak_icv_mirror_feature.hpp.

ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets the mirroring to the default value.

Note

The enabled state does not change when calling this function.

Since

1.0

Implements IFeature.

Definition at line 123 of file peak_icv_mirror_feature.hpp.

SetEnabled()

void SetEnabled ( bool enabled )

inlineoverridevirtual

Enables or disables the feature.

Parameters

enabled

Set to true to enable the feature, or false to disable it.

Since

1.0

Implements IFeature.

Definition at line 113 of file peak_icv_mirror_feature.hpp.

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

1.0

Definition at line 129 of file peak_icv_mirror_feature.hpp.

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

1.0

Definition at line 134 of file peak_icv_mirror_feature.hpp.