aboutsummaryrefslogtreecommitdiff
path: root/pyecsca/sca/trace/trace.py
blob: 82d1ee4e4d67913e4753dc98d999ad4b9aeed550 (plain)
1
2
3
4
5
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
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
import weakref
from typing import Any, Mapping, Sequence
from copy import copy, deepcopy

from numpy import ndarray
import numpy as np
from public import public


@public
class Trace(object):
    """A trace, which has an optional title, optional data bytes and mandatory samples."""
    meta: Mapping[str, Any]
    samples: ndarray

    def __init__(self, samples: ndarray, meta: Mapping[str, Any] = None, trace_set: Any = None):
        self.meta = meta
        self.samples = samples
        self.trace_set = trace_set

    def __len__(self):
        """Length of the trace, in samples."""
        return len(self.samples)

    def __getitem__(self, index):
        """Get the sample at `index`."""
        return self.samples[index]

    def __setitem__(self, key, value):
        """Set the sample at `key`."""
        self.samples[key] = value

    def __iter__(self):
        """Iterate over the samples."""
        yield from self.samples

    @property
    def trace_set(self) -> Any:
        if self._trace_set is None:
            return None
        return self._trace_set()

    @trace_set.setter
    def trace_set(self, trace_set: Any):
        if trace_set is None:
            self._trace_set = None
        else:
            self._trace_set = weakref.ref(trace_set)

    def __getstate__(self):
        state = self.__dict__.copy()
        del state["_trace_set"]
        return state

    def __eq__(self, other):
        if not isinstance(other, Trace):
            return False
        return np.array_equal(self.samples, other.samples) and self.meta == other.meta

    def with_samples(self, samples: ndarray) -> "Trace":
        return Trace(samples, deepcopy(self.meta), deepcopy(self.trace_set))

    def __copy__(self):
        return Trace(copy(self.samples), copy(self.meta), copy(self.trace_set))

    def __deepcopy__(self, memodict={}):
        return Trace(deepcopy(self.samples, memo=memodict), deepcopy(self.meta, memo=memodict),
                     deepcopy(self.trace_set, memo=memodict))

    def __repr__(self):
        return f"Trace(samples={self.samples!r}, trace_set={self.trace_set!r})"


@public
class CombinedTrace(Trace):
    """A trace that was combined from other traces, `parents`."""

    def __init__(self, samples: ndarray, meta: Mapping[str, Any] = None, trace_set: Any = None,
                 parents: Sequence[Trace] = None):
        super().__init__(samples, meta, trace_set=trace_set)
        self.parents = None
        if parents is not None:
            self.parents = weakref.WeakSet(parents)

    def __repr__(self):
        return f"CombinedTrace(samples={self.samples!r}, trace_set={self.trace_set!r}, parents={self.parents})"