aboutsummaryrefslogtreecommitdiff
path: root/pyecsca/sca/trace/filter.py
blob: 11cc89c4d423fb699ab64dea5204400a3c1f93fd (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
from copy import copy
from public import public
from scipy.signal import butter, lfilter
from typing import Union, Tuple

from .trace import Trace


def filter_any(trace: Trace, sampling_frequency: int,
               cutoff: Union[int, Tuple[int, int]], band_type: str) -> Trace:
    nyq = 0.5 * sampling_frequency
    if not isinstance(cutoff, int):
        b, a = butter(6, tuple(map(lambda x: x / nyq, cutoff)), btype=band_type, analog=False, output='ba')
    else:
        b, a = butter(6, cutoff / nyq, btype=band_type, analog=False, output='ba')
    result_samples = lfilter(b, a, trace.samples)
    return Trace(copy(trace.title), copy(trace.data), result_samples)


@public
def filter_lowpass(trace: Trace, sampling_frequency: int, cutoff: int) -> Trace:
    """
    Apply a lowpass digital filter (Butterworth) to `trace`, given `sampling_frequency` and
    `cutoff` frequency.

    :param trace:
    :param sampling_frequency:
    :param cutoff:
    :return:
    """
    return filter_any(trace, sampling_frequency, cutoff, "lowpass")


@public
def filter_highpass(trace: Trace, sampling_frequency: int, cutoff: int) -> Trace:
    """
    Apply a highpass digital filter (Butterworth) to `trace`, given `sampling_frequency` and
    `cutoff` frequency.

    :param trace:
    :param sampling_frequency:
    :param cutoff:
    :return:
    """
    return filter_any(trace, sampling_frequency, cutoff, "highpass")


@public
def filter_bandpass(trace: Trace, sampling_frequency: int, low: int, high: int) -> Trace:
    """
    Apply a bandpass digital filter (Butterworth) to `trace`, given `sampling_frequency`, with the
    passband from `low` to `high`.

    :param trace:
    :param sampling_frequency:
    :param low:
    :param high:
    :return:
    """
    return filter_any(trace, sampling_frequency, (low, high), "bandpass")


@public
def filter_bandstop(trace: Trace, sampling_frequency: int, low: int, high: int) -> Trace:
    """
    Apply a bandstop digital filter (Butterworth) to `trace`, given `sampling_frequency`, with the
    stopband from `low` to `high`.

    :param trace:
    :param sampling_frequency:
    :param low:
    :param high:
    :return:
    """
    return filter_any(trace, sampling_frequency, (low, high), "bandstop")