Skip to content

charm_options

tit.charm_options

Validated, optional overrides for installed SimNIBS CHARM settings.

validate_charm_options 

validate_charm_options(options: dict | None) -> dict | None

Validate supported overrides while leaving installed defaults untouched.

Source code in tit/charm_options.py 
 6
 7
 8
 9
10
11
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
def validate_charm_options(options: dict | None) -> dict | None:
    """Validate supported overrides while leaving installed defaults untouched."""
    if options is None:
        return None
    if not isinstance(options, dict):
        raise ValueError("charm_options must be an object")
    ranges = {
        "segmentation_final_resolution": (0.5, 2.0),
        "skin_facet_size": (0.5, 10.0),
    }
    allowed = {"denoise", *ranges}
    unknown = set(options) - allowed
    if unknown:
        raise ValueError(f"Unknown CHARM options: {', '.join(sorted(unknown))}")
    result = {}
    for key, value in options.items():
        if value is None:
            continue
        if key == "denoise":
            if type(value) is not bool:
                raise ValueError("CHARM denoise must be a boolean")
        else:
            low, high = ranges[key]
            if (
                type(value) not in (int, float)
                or not math.isfinite(value)
                or not low <= value <= high
            ):
                raise ValueError(f"CHARM {key} must be between {low} and {high} mm")
        result[key] = value
    return result