dcase_util.datasets.SoundEventDataset

class dcase_util.datasets.SoundEventDataset(*args, **kwargs)[source]

Sound event dataset baseclass

Constructor

Parameters

namestr

Dataset name Default value ‘dataset’

storage_namestr

Name to be used when storing dataset on disk Default value ‘dataset’

data_pathstr

Root path where the dataset is stored. If None, os.path.join(tempfile.gettempdir(), ‘dcase_util_datasets’) is used Default value None

local_pathstr

Direct storage path setup for the dataset. If None, data_path and storage_name are used to create one Default value None

show_progress_in_consolebool

Show progress in console Default value True

log_system_progressbool

Show progress in log Default value True

use_ascii_progress_barbool

Show progress bar using ASCII characters. Use this if your console does not support UTF-8 characters. Default value True

dataset_groupstr

Dataset group label, one of [‘scene’, ‘event’, ‘tag’] Default value ‘base class’

dataset_metadict

Dictionary containing metadata about the dataset, e.g., collecting device information, dataset authors. Default value None

evaluation_setup_folderstr

Directory name where evaluation setup files are stores Default value ‘evaluation_setup’

evaluation_setup_file_extensionstr

Setup file extension Default value ‘txt’

meta_filenamestr

Filename to be used for main meta file (contains all files with their reference data) of the dataset Default value ‘meta.txt’

error_meta_filenamestr

Filename for the error annotation file Default value ‘error.txt’

filelisthash_filenamestr

Filename for filelist hash file Default value ‘filelist.python.hash’

filelisthash_exclude_dirsstr

Directories to be excluded from filelist hash calculation Default value None

crossvalidation_foldsint

Count fo cross-validation folds. Indexing starts from one. Default value None

package_listlist of dict

Package list, remote files associated to the dataset. Item format: {

‘content_type’: ‘documentation’, # Possible values [‘all’, ‘audio’, ‘video’, ‘features’, ‘meta’, ‘code’,

‘documentation’, ‘examples’]: ‘remote_file’: ‘https://zenodo.org/record/45759/files/TUT-sound-events-2016-development.doc.zip’, # URL ‘remote_bytes’: 70918, # Size of remote file in bytes ‘remote_md5’: ‘33fd26a895530aef607a07b08704eacd’, # MD5 hash of remote file ‘filename’: ‘TUT-sound-events-2016-development.doc.zip’, # Filename relative to self.local_path always

} Default value None

package_extract_parametersdict

Extra parameters for package extraction. Default value None

included_content_typeslist of str or str

Indicates what content type should be processed. One or multiple from [‘all’, ‘audio’, ‘video’, ‘features’, ‘meta’, ‘code’, ‘documentation’, ‘examples’]. If None given, [‘all’] is used. Parameter can be also comma separated string. Default value None

audio_pathslist of str

List of paths to include audio material associated to the dataset. If None given, [‘audio’] is used. Default value None

default_audio_extensionstr

Default audio extension Default value ‘wav’

reference_data_presentbool

Reference data is delivered with the dataset Default value True

check_metabool

Check meta data during the initilization. Default value True

active_scenes: list of str

List of active scene classes, if none given all classes are considered. Default value None

active_events: list of str

List of active event classes, if none given all classes are considered. Default value None

__init__(*args, **kwargs)[source]