Skip to content

_specs

Full documentation pages are generated for docstring reference only and may contain symbols imported from other modules. Imported symbols are not distinguished from locally defined symbols and will appear in any module that they are imported into. For better information on where symbols should be imported from, review the sourcecode on the github.

FoSpy.plotting.diffraction.ui._specs

full_cfg module-attribute 

full_cfg = None

_round_spec 

_round_spec(x, digits, key=None, include=True)
Source code in FoSpy/ui/sliders/_utils.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
def _round_spec(x, digits, key=None, include=True):
    if isinstance(x, list or tuple):
        return [_round_spec(xi, digits) for xi in x]
    elif key == "min":
        val = _floor_to(x, digits)
        if not include:
            val += 10**-digits
        return val
    elif key == "max":
        val = _ceil_to(x, digits)
        if not include:
            val -= 10**-digits
        return val
    elif key == "None":
        return round(x, digits)
    else:
        return round(x, digits) if x is not None else None

assemble_sliders 

assemble_sliders(specs, cfg_name, cfg)
Source code in FoSpy/plotting/diffraction/ui/_specs.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def assemble_sliders(specs, cfg_name, cfg):
    # TODO: move to ui utils
    digits_default = full_cfg.get("slider_digits.default")
    digit_cfg = full_cfg.get(f"slider_digits.{cfg_name}")
    for name, spec in specs.items():
        if spec["type"] == "group":
            grp_specs = assemble_sliders(spec["specs"], cfg_name, cfg)
            spec["specs"] = grp_specs
            continue
        if spec.get("int", False):
            digits = 0
        else:
            digits = digit_cfg.get(name, None) or digits_default
        spec["digits"] = digits

        spec["default"] = cfg.get(name)

        for key in ["min", "max", "default", "None"]:
            if key not in spec:
                continue
            include = spec.get("include_"+key, True)
            spec[key] = _round_spec(spec[key], digits, key, include)
    return specs

get_baseline_sliders 

get_baseline_sliders(baseline_cfg)
Source code in FoSpy/plotting/diffraction/ui/_specs.py 
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def get_baseline_sliders(baseline_cfg):
    sliders = {
        "lam": {
            "type": "scalar",
            "label": "Baseline Smoothing",
            "min": 0,
            "max": 10
        },
        "diff_order": {
            "type": "scalar",
            "label": "Differential Order",
            "min": 1,
            "max": 3,
            "int": True
        },
        "max_iter": {
            "type": "scalar",
            "label": "Maximum Iterations",
            "min": 1,
            "max": 100,
            "int": True
        },
        "tol": {
            "type": "scalar",
            "label": "Tolerance",
            "min": 0,
            "max": 1
        }
    }

    sliders = assemble_sliders(sliders, "baseline", baseline_cfg)
    return sliders

get_find_sliders 

get_find_sliders(find_cfg, intensity_col)
Source code in FoSpy/plotting/diffraction/ui/_specs.py 
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def get_find_sliders(find_cfg, intensity_col):
    sliders = {
        "height_group": {
            "type": "group",
            "label": "Height Parameters",
            "specs": {
                "height": {
                    "type": "range",
                    "label": "Allowed Height (Y units)",
                    "min": 0,
                    "max": max(intensity_col),
                },
                "threshold": {
                    "type": "range",
                    "label": "Allowed Threshold (Y units)",
                    "min": 0,
                    "max": np.max(np.abs(np.diff(intensity_col))),
                },
                "prominence": {
                    "type": "range",
                    "label": "Allowed Prominence (Y units)",
                    "min": 0,
                    "max": max(intensity_col),
                },
            }
        },
        "width_group": {
            "type": "group",
            "label": "Width Parameters",
            "specs": {
                "distance": {
                    "type": "scalar",
                    "label": "Allowed Neighbor Distance (points)",
                    "min": 1,
                    "max": len(intensity_col),
                    "int": True,
                    "None": 1
                },
                "width": {
                    "type": "range",
                    "label": "Allowed Width (points)",
                    "min": 0,
                    "max": len(intensity_col),
                    "int": True
                },
                "wlen": {
                    "type": "scalar",
                    "label": "Window Length (points)",
                    "min": 2,
                    "max": len(intensity_col),
                    "int": True,
                    "None": len(intensity_col)
                },
                "rel_height": {
                    "type": "scalar",
                    "label": "Width @ Height (Height-Relative, top-down)",
                    "include_min": False,
                    "min": 0,
                    "max": 1,
                    "None": 1
                },
                "plateau_size": {
                    "type": "range",
                    "label": "Plateau Size (points)",
                    "min": 0,
                    "max": len(intensity_col),
                    "int": True
                } 
            }
        } 
    }

    sliders = assemble_sliders(sliders, "find_peaks", find_cfg)

    return sliders