Metadata-Version: 2.4
Name: audio_tensor_plotter
Version: 0.4.3
Summary: Simple tools for plotting spectrograms and audio data
Author-email: Ryan Quinn <ryan.quinn@certusinnovations.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/Stonewall-Defense/plot-spec
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib>=3.10
Requires-Dist: numpy>=2.4
Requires-Dist: torch>=2.10
Dynamic: license-file

# Audio Tensor Plotter

Simple tools for plotting spectrograms and audio data.

## Prerequisites

- Python 3.11 runtime
- Pip for package installation

## Installation

Install the dependencies into the environment with [pip](https://pypi.org/project/pip/):

```bash
pip install -r requirements.txt
```

Then install this package:

```bash
pip install .
```

## Usage

Best used with the [`AudioMlSpecTools`](https://pypi.org/project/AudioMlSpecTools/), also from Certus Innovations:

```python
CHANNELS = [
    FeatureChannel(SAMPLE_RATE, n_fft=N_FFT, hop_length=HOP_LEN, n_filters=N_MELS, is_logarithmic=True, is_mel=True),
]
FEATURE_SOURCE = FeatureSource(CHANNELS)
AUDIO = load_wav("fq_example_filename.wav", target_sr=SAMPLE_RATE).squeeze()

specs = FEATURE_SOURCE.forward(AUDIO)
plot_with_time_domain(specs, AUDIO, SAMPLE_RATE, "Plotting Example")
```

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Stonewall-Defense/plot-spec/tags).

## Authors

- **Ryan Quinn** - _Initial work_

## License

MIT.
