tobi/KDEAmbi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add default parameters for HyperionProcessor to algorithm documentation

Browse Source
This commit is contained in:
Tobias J. Endres 2025-08-16 06:11:49 +02:00
parent e321272c95
commit 10be323a3b
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/hyperion_processor_algorithm.md
View File

@ -6,6 +6,17 @@ This document outlines the algorithm implemented in the `HyperionProcessor` modu
The primary goal of the `HyperionProcessor` is to transform a captured screen image into a set of colors suitable for driving an LED strip, creating an Ambilight-like effect. It focuses on accurately sampling colors from relevant areas of the screen while ignoring irrelevant parts like black borders.
### Configurable Parameters and Defaults
The behavior of the `HyperionProcessor` can be influenced by several parameters, which are passed during its initialization via a `QJsonObject`. These parameters allow for fine-tuning the algorithm's response to different content and user preferences.
* **`blackBorderThreshold`**: This parameter controls the sensitivity of the black border detection. It is a floating-point value.
* **Default Value:** `0.1`
* **`smoothingFactor`**: This parameter determines the degree of color smoothing applied to the calculated LED colors. It is a floating-point value, where higher values result in smoother transitions between colors.
* **Default Value:** `0.1`
Note that the LED layout (number of LEDs on each side) is provided separately via the `LedLayout` struct and is not part of this `QJsonObject` configuration.
## Processing Steps
The `HyperionProcessor` follows a multi-step pipeline to achieve this: