py2lispIDyOM.extract.ExperimentInfo
- class py2lispIDyOM.extract.ExperimentInfo(experiment_folder_path)[source]
An experiment object that contains all data in a single experiment.
- Parameters:
experiment_folder_path (str) – the path to experiment log folder which you want to access.
Public Data Attributes:
experiment_folder_path
Public Methods:
__post_init__
()Get a dictionary of all melodies in the experiment with melody name as the key and all melody info as the value.
access_melodies
([starting_index, ...])Access specific melodies by index or melody names.
__init__
(experiment_folder_path)__repr__
()Return repr(self).
__eq__
(other)Return self==value.
Private Methods:
_get_datasetwise_cpitch_elements
()Get the list of cpitch (full cpitch distribution elements used in IDyOM)
- access_melodies(starting_index=None, ending_index=None, melody_names=None)[source]
Access specific melodies by index or melody names. If all arguments are None, then the default is to access all melodies in the Experiment class
- Parameters:
starting_index (int) – the index of the melody you want to start accessing
ending_index (int) – the index of the melody you want to end accessing
melody_names (list(str)) – list of meldoy names you want to access
- Returns:
a list of MelodyInfo class objects (selected melodies)
- Return type:
list(MelodyInfo)
- melody_dictionary()[source]
Get a dictionary of all melodies in the experiment with melody name as the key and all melody info as the value.
- Returns:
a dictionary consisting of:
melody_name: the name of the melody
MelodyInfo: a MelodyInfo class containing all IDyOM output data of the melody
- Return type:
typed dict -> {melody_name: MelodyInfo}