Skip to content

spheres

tit.analyzer.spheres

Parsing of spherical ROI specifications.

The GUI collects spheres as "x,y,z,r" rows. Parsing lives here rather than in the tab so it is exercised without PyQt5, which is absent from the test environment.

See Also

tit.analyzer.analyzer.Analyzer.analyze_sphere : Consumes one parsed sphere.

parse_sphere_row 

parse_sphere_row(text: str) -> tuple[float, float, float, float]

Parse a single "x,y,z,r" row.

Parameters

text : str Comma-separated centre and radius.

Returns

tuple of float (x, y, z, r).

Raises

ValueError If text is empty, does not hold exactly four values, holds a non-numeric value, or gives a non-positive radius.

Source code in tit/analyzer/spheres.py 
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
def parse_sphere_row(text: str) -> tuple[float, float, float, float]:
    """Parse a single ``"x,y,z,r"`` row.

    Parameters
    ----------
    text : str
        Comma-separated centre and radius.

    Returns
    -------
    tuple of float
        ``(x, y, z, r)``.

    Raises
    ------
    ValueError
        If *text* is empty, does not hold exactly four values, holds a
        non-numeric value, or gives a non-positive radius.
    """
    text = (text or "").strip()
    if not text:
        raise ValueError("Please enter coordinates and radius as x,y,z,r.")
    parts = [p.strip() for p in text.split(",")]
    if len(parts) != 4 or any(p == "" for p in parts):
        raise ValueError("Enter exactly 4 values: x,y,z,r.")
    try:
        x, y, z, r = (float(p) for p in parts)
    except ValueError:
        raise ValueError("All values must be numeric: x,y,z,r.")
    if r <= 0:
        raise ValueError("Radius must be positive.")
    return (x, y, z, r)

parse_sphere_rows 

parse_sphere_rows(texts) -> list[tuple[float, float, float, float]]

Parse several "x,y,z,r" rows.

A one-element sequence reproduces single-sphere behaviour exactly, including its error messages -- the row number is only prefixed when there is more than one row, so a single malformed sphere reads the way it always did.

Parameters

texts : sequence of str One "x,y,z,r" string per sphere.

Returns

list of tuple of float One (x, y, z, r) per input row, in order.

Raises

ValueError If texts is empty or any row is malformed.

Source code in tit/analyzer/spheres.py 
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
def parse_sphere_rows(texts) -> list[tuple[float, float, float, float]]:
    """Parse several ``"x,y,z,r"`` rows.

    A one-element sequence reproduces single-sphere behaviour exactly, including
    its error messages -- the row number is only prefixed when there is more
    than one row, so a single malformed sphere reads the way it always did.

    Parameters
    ----------
    texts : sequence of str
        One ``"x,y,z,r"`` string per sphere.

    Returns
    -------
    list of tuple of float
        One ``(x, y, z, r)`` per input row, in order.

    Raises
    ------
    ValueError
        If *texts* is empty or any row is malformed.
    """
    if not texts:
        raise ValueError("Please enter coordinates and radius as x,y,z,r.")
    spheres = []
    for i, text in enumerate(texts):
        try:
            spheres.append(parse_sphere_row(text))
        except ValueError as exc:
            if len(texts) == 1:
                raise
            raise ValueError(f"Row {i + 1}: {exc}")
    return spheres