Results

Standardized output contracts for feature extraction.

This module defines the FeatureResult base class, which ensures consistency in how feature values are returned, validated, and flattened for data logging.

FeatureResult dataclass

Standardized base output contract for all PyEyesWeb features.

Attributes:
  • is_valid ((bool, optional)) –

    Flag indicating if the computation was successful. Defaults to True. Set to False when input data is insufficient (e.g., empty window).
Source code in pyeyesweb/data_models/results.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@dataclass(slots=True)
class FeatureResult:
    """Standardized base output contract for all PyEyesWeb features.

    Attributes
    ----------
    is_valid : bool, optional
        Flag indicating if the computation was successful.  Defaults to `True`.
        Set to `False` when input data is insufficient (e.g., empty window).
    """
    is_valid: bool = True

    def to_flat_dict(self, prefix: str = "") -> Dict[str, Any]:
        """Flatten the result into a dictionary for logging.

        Converts the dataclass to a dictionary, optionally adding a prefix to
        all keys and removing any fields with `None` values.

        Parameters
        ----------
        prefix : str, optional
            A string to prepend to each key in the dictionary.  Defaults to `""`.

        Returns
        -------
        Dict[str, Any]
            A flat dictionary containing the valid feature results.
        """
        raw_dict = asdict(self)  # type: ignore
        flat = {}
        for key, value in raw_dict.items():
            if value is None:
                continue
            final_key = f"{prefix}_{key}" if prefix else key
            flat[final_key] = value
        return flat

to_flat_dict(prefix='')

Flatten the result into a dictionary for logging.

Converts the dataclass to a dictionary, optionally adding a prefix to all keys and removing any fields with None values.

Parameters:
  • prefix (str, default: '' ) –

    A string to prepend to each key in the dictionary. Defaults to "".
Returns:
  • Dict[str, Any] –

    A flat dictionary containing the valid feature results.
Source code in pyeyesweb/data_models/results.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def to_flat_dict(self, prefix: str = "") -> Dict[str, Any]:
    """Flatten the result into a dictionary for logging.

    Converts the dataclass to a dictionary, optionally adding a prefix to
    all keys and removing any fields with `None` values.

    Parameters
    ----------
    prefix : str, optional
        A string to prepend to each key in the dictionary.  Defaults to `""`.

    Returns
    -------
    Dict[str, Any]
        A flat dictionary containing the valid feature results.
    """
    raw_dict = asdict(self)  # type: ignore
    flat = {}
    for key, value in raw_dict.items():
        if value is None:
            continue
        final_key = f"{prefix}_{key}" if prefix else key
        flat[final_key] = value
    return flat