|
1 | 1 | .. _filters: |
2 | 2 |
|
3 | | -Filters |
4 | | -======= |
| 3 | +Transforms |
| 4 | +========== |
5 | 5 |
|
6 | | -Filters are used to preprocess the data before it is used by the model. |
7 | | -Some filters can only work on chunked data, while others can work on both chunked and unchunked data. |
| 6 | +GPU-accelerated transforms using PyTorch named tensors. |
| 7 | +Works on both CPU and GPU - tensors provide dimension awareness everywhere. |
8 | 8 |
|
9 | | -Generic Filters |
10 | | ---------------- |
11 | | -Generic filters e.g. allow the use of custom methods to preprocess the data. |
12 | | - |
13 | | -.. currentmodule:: myoverse.datasets.filters.generic |
| 9 | +Base Classes |
| 10 | +------------ |
| 11 | +.. currentmodule:: myoverse.transforms |
14 | 12 | .. autosummary:: |
15 | | - :toctree: generated/filters |
| 13 | + :toctree: generated/transforms |
16 | 14 | :template: class.rst |
17 | 15 |
|
18 | | - ApplyFunctionFilter |
19 | | - IndexDataFilter |
20 | | - ChunkizeDataFilter |
21 | | - IdentityFilter |
| 16 | + Transform |
22 | 17 |
|
23 | | -Temporal Filters |
24 | | ----------------- |
25 | | -Temporal filters can be used to compute most EMG features such as the root mean square or the mean absolute value. |
| 18 | +Temporal / Signal Processing |
| 19 | +---------------------------- |
| 20 | +Temporal transforms for EMG feature extraction and signal processing. |
26 | 21 |
|
27 | | -.. currentmodule:: myoverse.datasets.filters.temporal |
| 22 | +.. currentmodule:: myoverse.transforms |
28 | 23 | .. autosummary:: |
29 | | - :toctree: generated/filters |
| 24 | + :toctree: generated/transforms |
30 | 25 | :template: class.rst |
31 | 26 |
|
32 | | - SOSFrequencyFilter |
33 | | - RectifyFilter |
34 | | - WindowedFunctionFilter |
35 | | - RMSFilter |
36 | | - VARFilter |
37 | | - MAVFilter |
38 | | - IAVFilter |
39 | | - WFLFilter |
40 | | - ZCFilter |
41 | | - SSCFilter |
42 | | - SpectralInterpolationFilter |
43 | | - |
44 | | - |
45 | | -Spatial Filters |
46 | | ---------------- |
47 | | -Spatial filters can be used to compute spatial features such as the Laplacian. |
48 | | - |
49 | | -.. currentmodule:: myoverse.datasets.filters.spatial |
| 27 | + SlidingWindowTransform |
| 28 | + RMS |
| 29 | + MAV |
| 30 | + VAR |
| 31 | + Rectify |
| 32 | + Bandpass |
| 33 | + Highpass |
| 34 | + Lowpass |
| 35 | + Notch |
| 36 | + ZeroCrossings |
| 37 | + SlopeSignChanges |
| 38 | + WaveformLength |
| 39 | + Diff |
| 40 | + |
| 41 | +Normalization |
| 42 | +------------- |
| 43 | +Normalization transforms for data preprocessing. |
| 44 | + |
| 45 | +.. currentmodule:: myoverse.transforms |
50 | 46 | .. autosummary:: |
51 | | - :toctree: generated/filters |
| 47 | + :toctree: generated/transforms |
52 | 48 | :template: class.rst |
53 | 49 |
|
54 | | - DifferentialSpatialFilter |
55 | | - ApplyFunctionSpatialFilter |
| 50 | + ZScore |
| 51 | + MinMax |
| 52 | + Normalize |
| 53 | + Standardize |
| 54 | + InstanceNorm |
| 55 | + LayerNorm |
| 56 | + BatchNorm |
| 57 | + ClampRange |
56 | 58 |
|
| 59 | +Generic Operations |
| 60 | +------------------ |
| 61 | +Generic array operations. |
57 | 62 |
|
58 | | -Base Filter Classes |
59 | | -------------------- |
60 | | -.. important:: If you wish to add a new filter make sure they inherit from the following base classes. |
| 63 | +.. currentmodule:: myoverse.transforms |
| 64 | +.. autosummary:: |
| 65 | + :toctree: generated/transforms |
| 66 | + :template: class.rst |
61 | 67 |
|
62 | | -.. currentmodule:: myoverse.datasets.filters.generic |
| 68 | + Reshape |
| 69 | + Index |
| 70 | + Flatten |
| 71 | + Squeeze |
| 72 | + Unsqueeze |
| 73 | + Transpose |
| 74 | + Mean |
| 75 | + Sum |
| 76 | + Stack |
| 77 | + Concat |
| 78 | + Lambda |
| 79 | + Identity |
| 80 | + Repeat |
| 81 | + Pad |
| 82 | + |
| 83 | +Augmentation |
| 84 | +------------ |
| 85 | +Data augmentation transforms. |
| 86 | + |
| 87 | +.. currentmodule:: myoverse.transforms |
63 | 88 | .. autosummary:: |
64 | | - :toctree: generated/filters |
| 89 | + :toctree: generated/transforms |
65 | 90 | :template: class.rst |
66 | 91 |
|
67 | | - FilterBaseClass |
| 92 | + GaussianNoise |
| 93 | + MagnitudeWarp |
| 94 | + TimeWarp |
| 95 | + Dropout |
| 96 | + ChannelShuffle |
| 97 | + TimeShift |
| 98 | + Scale |
| 99 | + Cutout |
68 | 100 |
|
69 | | -.. currentmodule:: myoverse.datasets.filters.spatial |
| 101 | +Spatial / Grid-Aware |
| 102 | +-------------------- |
| 103 | +Spatial transforms for electrode grid processing. |
| 104 | + |
| 105 | +.. currentmodule:: myoverse.transforms |
70 | 106 | .. autosummary:: |
71 | | - :toctree: generated/filters |
| 107 | + :toctree: generated/transforms |
72 | 108 | :template: class.rst |
73 | 109 |
|
74 | | - SpatialFilterGridAware |
75 | | - |
| 110 | + SpatialFilter |
| 111 | + NDD |
| 112 | + LSD |
| 113 | + TSD |
| 114 | + IB2 |
0 commit comments