IDS peak ICV v1.0.0
Loading...
Searching...
No Matches
RotationFeature Class Reference

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

Inheritance diagram for RotationFeature:
Collaboration diagram for RotationFeature:

Public Member Functions

 RotationFeature (detail::TransformationModule &module)
 Creates a RotationFeature 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 rotation to the default value.
 
void SetAngle (Rotation angle)
 Sets the desired rotation angle.
 
Rotation GetAngle () const
 Retrieves the current rotation angle.
 

Detailed Description

Rotation provides fixed-angle rotation functionality.

This feature rotates images in 90-degree increments, based on the rotation mode set via the SetRotation() method.

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.

Defaults
See also
Rotation, features::MirrorFeature
Since
1.0

Definition at line 42 of file peak_icv_rotation_feature.hpp.

Constructor & Destructor Documentation

◆ RotationFeature()

RotationFeature ( detail::TransformationModule & module)
inlineexplicit

Creates a RotationFeature for an existing transformation module.

Parameters
moduleReference to the underlying detail::TransformationModule.
Since
1.0

Definition at line 95 of file peak_icv_rotation_feature.hpp.

Member Function Documentation

◆ GetAngle()

Rotation GetAngle ( ) const
inline

Retrieves the current rotation angle.

Returns
The currently configured rotation angle.
Since
1.0

Definition at line 119 of file peak_icv_rotation_feature.hpp.

◆ 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 104 of file peak_icv_rotation_feature.hpp.

◆ ResetToDefault()

void ResetToDefault ( )
inlineoverridevirtual

Resets the rotation to the default value.

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

Implements IFeature.

Definition at line 109 of file peak_icv_rotation_feature.hpp.

◆ SetAngle()

void SetAngle ( Rotation angle)
inline

Sets the desired rotation angle.

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

Definition at line 114 of file peak_icv_rotation_feature.hpp.

◆ SetEnabled()

void SetEnabled ( bool enabled)
inlineoverridevirtual

Enables or disables the feature.

Parameters
enabledSet to true to enable the feature, or false to disable it.
Since
1.0

Implements IFeature.

Definition at line 99 of file peak_icv_rotation_feature.hpp.