Skip to content

Settings

Provides configuration containers for the yarPPG application.

HydraSettings dataclass

Base class for Hydra-based configurations.

Mainly manages the hydra-specific settings, deactivating its directory and output management, so that running with hydra.main does not behave differently from a normal CLI.

Source code in src\yarppg\settings.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@dataclasses.dataclass(kw_only=True)
class HydraSettings:
    """Base class for Hydra-based configurations.

    Mainly manages the hydra-specific settings, deactivating its directory and output
    management, so that running with hydra.main does not behave differently from a
    normal CLI.
    """

    hydra: "hydra.conf.HydraConf" = dataclasses.field(
        default_factory=lambda: hydra.conf.HydraConf(
            output_subdir=None,
            run=hydra.conf.RunDir("."),
            help=hydra.conf.HelpConf(app_name="run-yarppg"),
            overrides=hydra.conf.OverridesConf(
                # hydra=["job_logging=null", "hydra_logging=null"]
            ),
        )
    )

Settings dataclass

Bases: HydraSettings

Comprises all configuration options available in the yarppg application.

Source code in src\yarppg\settings.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@dataclasses.dataclass
class Settings(HydraSettings):
    """Comprises all configuration options available in the yarppg application."""

    ui: Any
    savepath: str | None = None
    detector: str = "facemesh"
    filter: FilterConfig | None = dataclasses.field(
        default_factory=lambda: FilterConfig(30, 0.5, 2, btype="bandpass")
    )
    algorithm: str = "green"
    defaults: Any = dataclasses.field(
        default_factory=lambda: [
            {"ui": "simplest"},
            "_self_",
        ]
    )

UiSettings dataclass

Settings for the user interface.

Source code in src\yarppg\settings.py 
14
15
16
@dataclasses.dataclass
class UiSettings:
    """Settings for the user interface."""

available_ui_configs()

Check availability of UIs and return each corresponding settings container.

Source code in src\yarppg\settings.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
def available_ui_configs():
    """Check availability of UIs and return each corresponding settings container."""
    import yarppg.ui.simplest

    uis: dict[str, Any] = {"simplest": yarppg.ui.simplest.SimplestOpenCvWindowSettings}
    try:
        import yarppg.ui.qt6

        uis["qt6_simple"] = yarppg.ui.qt6.SimpleQt6WindowSettings
    except (ModuleNotFoundError, ImportError):
        pass

    return uis

get_config(argv)

Get the default configuration with optional overrides.

Source code in src\yarppg\settings.py 
82
83
84
85
86
87
def get_config(argv: list[str] | None) -> Settings:
    """Get the default configuration with optional overrides."""
    register_schemas()
    with hydra.initialize():
        cfg = hydra.compose(config_name="config", overrides=argv)
    return hydra.utils.instantiate(cfg)

register_schemas()

Register base schema and settings for available UI implementations.

Source code in src\yarppg\settings.py 
74
75
76
77
78
79
def register_schemas():
    """Register base schema and settings for available UI implementations."""
    cs = hydra.core.config_store.ConfigStore.instance()
    cs.store(name="config", node=Settings)
    for name, cfg_class in available_ui_configs().items():
        cs.store(name=name, node=cfg_class, group="ui")