IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes
RotationFeature Class Reference
IDS peak ICV » Python » Image Pipeline » Pipeline Features
Inheritance diagram for RotationFeature:
Inheritance graph
[legend]

Public Member Functions

bool enabled (self)
 Gets whether this feature is currently enabled.
 
None enabled (self, bool enabled)
 Enables or disables the feature.
 
Rotation angle (self)
 Gets the current rotation angle.
 
None angle (self, Rotation angle)
 Sets the desired rotation angle.
 
None reset_to_default (self)
 Resets the rotation to its default value (Rotation.NO_ROTATION).
 
None __init__ (self, TransformationModule module)
 Creates a RotationFeature for an existing transformation module.
 

Protected Attributes

 _module = module
 

Detailed Description

Rotation provides fixed-angle rotation functionality.

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

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

This feature rotates images in 90-degree increments, based on the rotation mode set via the angle property.

Warning
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 rotation.

The default rotation is Rotation.NO_ROTATION.

Since
ids_peak_icv 1.0

Definition at line 6 of file rotation_feature.py.

Constructor & Destructor Documentation

◆ __init__()

None __init__ ( self,
TransformationModule module )

Creates a RotationFeature for an existing transformation module.

Parameters
moduleReference to the underlying TransformationModule.
Since
ids_peak_icv 1.0

Definition at line 85 of file rotation_feature.py.

Member Function Documentation

◆ angle() [1/2]

Rotation angle ( self)

Gets the current rotation angle.

Returns
The currently configured rotation angle.
Since
ids_peak_icv 1.0

Definition at line 51 of file rotation_feature.py.

◆ angle() [2/2]

None angle ( self,
Rotation angle )

Sets the desired rotation angle.

Parameters
angleThe rotation angle to apply (see RotationAngle enum).
Since
ids_peak_icv 1.0

Definition at line 63 of file rotation_feature.py.

◆ enabled() [1/2]

bool enabled ( self)

Gets whether this feature is currently enabled.

Returns
True if enabled; otherwise False.
Since
ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 27 of file rotation_feature.py.

◆ enabled() [2/2]

None enabled ( self,
bool enabled )

Enables or disables the feature.

Parameters
enabledTrue to enable, False to disable.
Since
ids_peak_icv 1.0

Reimplemented from IFeature.

Definition at line 39 of file rotation_feature.py.

◆ reset_to_default()

None reset_to_default ( self)

Resets the rotation to its default value (Rotation.NO_ROTATION).

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

Reimplemented from IFeature.

Definition at line 74 of file rotation_feature.py.

Field Documentation

◆ _module

_module = module
protected

Definition at line 94 of file rotation_feature.py.