VTOFG: Vibration Test Object Function Generator
Introduction
A function generator that uses the audio output (3.5mm port, speaker, or usb-c) on a computer, for use with a vibration test object (VTO) for testing of doppler ultrasound. This can be used as a general function generator if plot is set to False.
When the function generator is ran it has the following inputs: -- Master amplitude: the overall amplitude of the signal (essentially the volume when played through a speaker)
- Generator frequency: the frequency of the audio frames in the signal
- Resolution: the resolution of each audio frame
- Buffer time: the length of each segment that is calculated/played (the next segment is calculated while the previous one is being played)
- Transducer Frequency: The ultrasound wave frequency in kHz
- Pulse Repetition Frequency: The Pulse Repetition Frequency that the scanner is using in Hz
- Display Time: The time period displayed
- Display Samples: The number of lines per time period
- Wall Filter: The wall filter frequency used (A simple cutoff mask is used)
- Gain: Arbitrary value use to scale the displayed signal
- Display Speed: used to control the display speed if it is out of sync with the signal
- For each sweep wave:
- Wave amplitude: relative to each other, changing this will not change the overall signal amplitude
- Start Frequency: the frequency to start the sweep
- End Frequency: the frequency to end the sweep
- Sweep Time: the period of the sweep
Installation Instructions
Windows
Use pip to install the vtofg package:
pip install vtofg
Run the following python script:
import vtofg
gen = vtofg.FunctionGenerator(plot=True)
gen.mainloop()
Set plot to False if you don't want the plotter.
See Example.PNG for expected output when ran with settings shown in image.
Mac and others
Installation of the package is largely the same, except you will need to run pip3 install vtofg instead of pip install vtofg. You may also need to manually install a version of python through your package manager which includes tkinter, as the default version of python3 preloaded onto your system may not contain this.
Python Version
An installation of python 3.7.9 is recommended, other versions have not been tested.
Roadmap
- Adding functionality to save/load waves
- Add functionaality to run .wav files
Contributing
Contributions are welcome
Contributors
- Zack Ravetz
License
This project is licensed under the BSD license.
Metadata
Release files for vtofg 1.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| vtofg-1.1.1.tar.gz | 16.9 kB | Without provenance | Details for vtofg-1.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| vtofg-1.1.1-py3-none-any.whl | Python 3 | none | any | Details for vtofg-1.1.1-py3-none-any.whl |
Total release size: 34.3 kB
Release files / vtofg-1.1.1.tar.gz
| Download URL | vtofg-1.1.1.tar.gz |
|---|---|
| Size | 16.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a26980c726df885be42b0cf792a67c19723f5bfacb985841b437e5fc1a3af587
|
|
BLAKE2b-256 checksum How to use checksums |
088ddd6444958cdd5eebc768c5602d3050743cdc3386cc85b8b4fb2a7975fed2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
Release files / vtofg-1.1.1-py3-none-any.whl
| Download URL | vtofg-1.1.1-py3-none-any.whl |
|---|---|
| Size | 17.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
def113b7dfeda925d250f7c0be0569f95326ed3fce0dc39db0bcbbdb2f00833a
|
|
BLAKE2b-256 checksum How to use checksums |
b60681ded40d5a0cae1e5550043c61394a7cfe63e3502ad2f56399c6f01d44fd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.12.1
|
Security for vtofg 1.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.