Skip to content

single

Single #

Bases: PhysicsObject

A single physics object

Source code in hml/physics_objects/single.py 
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
48
49
class Single(PhysicsObject):
    """A single physics object"""

    def __init__(self, branch: str, index: int) -> None:
        self._branch = branch
        self._index = index

    @classmethod
    def from_name(cls, name: str) -> Single:
        if match_ := re.match(r"^([a-zA-Z]+)(\d+)$", name.strip()):
            branch, index = match_.groups()
            return cls(branch, int(index))

        raise ValueError(f"Invalid name '{name}' for a single physics object")

    @property
    def index(self) -> int:
        return self._index

    @property
    def branch(self) -> str:
        return self._branch

    @property
    def slices(self) -> list[slice]:
        return [slice(self.index, self.index + 1)]

    @property
    def name(self) -> str:
        return f"{self.branch}{self.index}"

    @property
    def config(self) -> dict:
        return {"branch": self.branch, "index": self.index}

is_single #

is_single(object_)

Check if an object is a single physics object

Source code in hml/physics_objects/single.py 
 8
 9
10
11
12
13
def is_single(object_: PhysicsObject | str) -> bool:
    """Check if an object is a single physics object"""
    if isinstance(object_, PhysicsObject):
        return isinstance(object_, Single)

    return bool(re.match(r"^[a-zA-Z]+\d+$", object_))