File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11Examples
22********
33
4- .. todo provide some examples
4+ .. todo provide some examples
5+
6+ .. note ::
7+ THIS SECTION IS STILL UNDER DEVELOPMENT
Original file line number Diff line number Diff line change @@ -20,7 +20,7 @@ You can easily install balder with the following command.
2020 python -m pip install baldertest
2121
2222 Install balderhub-waveform
23- =====================
23+ ==========================
2424
2525You can install this package with the following command:
2626
Original file line number Diff line number Diff line change 11Introduction into Waveform
2- **********************
2+ **************************
33
4- .. todo provide an explanation of your specific topic that can help others to use your BalderHub project
4+ .. todo provide an explanation of your specific topic that can help others to use your BalderHub project
5+
6+ .. note ::
7+ THIS SECTION IS STILL UNDER DEVELOPMENT
8+
9+
10+ This BalderHub project provides different working objects to write test that use waveforms.
11+
12+ The following BalderHub packages are using this package to interact with their test equipment devices:
13+
14+ +-----------------------+----------------------------------------------------------------------------------------------+
15+ | Device Type | BalderHub project |
16+ +=======================+==============================================================================================+
17+ | Oscilloscopes | `balderhub-waveformmonitor <https://hub.balder.dev/projects/waveformmonitor >`_ |
18+ +-----------------------+----------------------------------------------------------------------------------------------+
19+ | Function Generators | `balderhub-waveformgenerator <https://hub.balder.dev/projects/waveformgenerator >`_ |
20+ +-----------------------+----------------------------------------------------------------------------------------------+
Original file line number Diff line number Diff line change @@ -3,11 +3,45 @@ Utilities
33
44This section shows general objects and helper functions that are used with this package.
55
6+ Custom Waveform
7+ ===============
68
7- .. note ::
8- This BalderHub project doesn't have any utilities .
9+ You can define custom waveforms by using the :class: ` balderhub.waveform.lib.utils.CustomNonPeriodicWaveform ` and
10+ :class: ` balderhub.waveform.lib.utils.CustomPeriodicWaveform ` objects .
911
1012
11- .. todo add your scenarios with .. autoclass
12- .. autoclass:: balderhub.waveform.lib.utilities.MyExampleUtility
13- :members:
13+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.CustomNonPeriodicWaveform
14+ :members:
15+
16+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.CustomPeriodicWaveform
17+ :members:
18+
19+
20+ Common Waveform Classes
21+ =======================
22+
23+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.common.CardiacWaveform
24+ :members:
25+
26+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.common.CosineWaveform
27+ :members:
28+
29+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.common.SineWaveform
30+ :members:
31+
32+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.common.DCWaveform
33+ :members:
34+
35+
36+ Base Classes
37+ ============
38+
39+
40+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.AbstractWaveform
41+ :members:
42+
43+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.BaseNonPeriodicWaveform
44+ :members:
45+
46+ .. autoclass :: balderhub.waveform.lib.utils.waveforms.BasePeriodicWaveform
47+ :members:
You can’t perform that action at this time.
0 commit comments