pulsatrix
Loading...
Searching...
No Matches
pulsatrix::AudioFolderDataset Class Reference

Dataset over a directory tree of the form root_dir/<class_name>/<audio_file.wav>, structurally identical to ImageFolderDataset (Phase 2): sorted subdirectory names are classes, sorted filenames within each are samples, decoded lazily per get() via WavReader. More...

#include <audio_folder_dataset.hpp>

Inheritance diagram for pulsatrix::AudioFolderDataset:
Collaboration diagram for pulsatrix::AudioFolderDataset:

Public Member Functions

 AudioFolderDataset (const std::string &root_dir, DeviceBackend *backend)
 
int64_t size () const override
 Number of samples in this dataset.
 
Sample get (int64_t index) const override
 
const std::vector< std::string > & classes () const
 Sorted class names; classes()[i] is the human-readable name for label i.
 
- Public Member Functions inherited from pulsatrix::Dataset
virtual ~Dataset ()=default
 

Detailed Description

Dataset over a directory tree of the form root_dir/<class_name>/<audio_file.wav>, structurally identical to ImageFolderDataset (Phase 2): sorted subdirectory names are classes, sorted filenames within each are samples, decoded lazily per get() via WavReader.

Constructor & Destructor Documentation

◆ AudioFolderDataset()

pulsatrix::AudioFolderDataset::AudioFolderDataset ( const std::string &  root_dir,
DeviceBackend *  backend 
)
Exceptions
std::runtime_errorif root_dir doesn't exist/isn't a directory, or contains no class subdirectories.

Member Function Documentation

◆ classes()

const std::vector< std::string > & pulsatrix::AudioFolderDataset::classes ( ) const
inline

Sorted class names; classes()[i] is the human-readable name for label i.

◆ get()

Sample pulsatrix::AudioFolderDataset::get ( int64_t  index) const
overridevirtual
Exceptions
std::out_of_rangeif index is out of bounds.
Returns
{waveform (1,channels,num_samples), label (1,) float, the class's sorted-order index}.

Implements pulsatrix::Dataset.

◆ size()

int64_t pulsatrix::AudioFolderDataset::size ( ) const
overridevirtual

Number of samples in this dataset.

Implements pulsatrix::Dataset.


The documentation for this class was generated from the following file: