MirrorFeature Class Reference

Inheritance diagram for MirrorFeature:

Public Member Functions
bool	enabled (self)
	Indicates whether the feature is currently enabled.
None	enabled (self, bool value)
	Enables or disables the feature.
bool	left_right_enabled (self)
	Gets the current left-right mirroring setting.
None	left_right_enabled (self, bool value)
	Sets whether the image should be mirrored left-right.
bool	up_down_enabled (self)
	Gets the current up-down mirroring setting.
None	up_down_enabled (self, bool value)
	Sets whether the image should be mirrored up-down.
None	reset_to_default (self)
	Resets the mirroring to no mirroring.
None	__init__ (self, TransformationModule module)
	Creates a MirrorFeature for an existing transformation module.

Protected Attributes
	_module = module

Detailed Description

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

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

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

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.

The default value is no mirroring.

Since

ids_peak_icv 1.0

Definition at line 5 of file mirror_feature.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		TransformationModule	module )

Creates a MirrorFeature for an existing transformation module.

Parameters

module

Reference to the underlying TransformationModule.

Since

ids_peak_icv 1.0

Definition at line 103 of file mirror_feature.py.

Member Function Documentation

enabled() [1/2]

bool enabled

(

self

)

Indicates whether the feature is currently enabled.

Returns

True if enabled; otherwise, False.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 23 of file mirror_feature.py.

enabled() [2/2]

None enabled	(		self,
		bool	value )

Enables or disables the feature.

Parameters

value

Set to True to enable the feature, or False to disable it.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 34 of file mirror_feature.py.

left_right_enabled() [1/2]

bool left_right_enabled

(

self

)

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

Definition at line 45 of file mirror_feature.py.

left_right_enabled() [2/2]

None left_right_enabled	(		self,
		bool	value )

Sets whether the image should be mirrored left-right.

Parameters

value

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

Since

ids_peak_icv 1.0

Definition at line 57 of file mirror_feature.py.

reset_to_default()

None reset_to_default

(

self

)

Resets the mirroring to no mirroring.

Note

The enabled state does not change when calling this function.

Since

ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 92 of file mirror_feature.py.

up_down_enabled() [1/2]

bool up_down_enabled

(

self

)

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

Definition at line 69 of file mirror_feature.py.

up_down_enabled() [2/2]

None up_down_enabled	(		self,
		bool	value )

Sets whether the image should be mirrored up-down.

Parameters

value

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

Since

ids_peak_icv 1.0

Definition at line 81 of file mirror_feature.py.

Field Documentation

_module

_module = module

protected

Definition at line 112 of file mirror_feature.py.