musif package

Subpackages

• musif.cache package
  • Submodules
  • musif.cache.cache module
    • CallableArguments
    • MethodCache
      • MethodCache.cache
      • MethodCache.check_reference_changes
      • MethodCache.name
      • MethodCache.reference
      • MethodCache.special_method
      • MethodCache.target_addresses
    • ObjectReference
      • ObjectReference.args
      • ObjectReference.name
      • ObjectReference.parent
      • ObjectReference.reference
      • ObjectReference.resurrect_reference
    • SmartModuleCache
      • SmartModuleCache.SPECIAL_METHODS_NAME
      • SmartModuleCache.cache
      • SmartModuleCache.ischanged()
      • SmartModuleCache.smartforcecache()
  • musif.cache.utils module
    • FileCacheIntoRAM
    • hasattr()
    • iscache()
    • isinstance()
    • load_score_df()
    • store_score_df()
    • wrap_module_objects()
• musif.common package
  • Submodules
  • musif.common.constants module
    • BLACK
    • BLUE
    • BOLD_SEQ
    • CYAN
    • GREEN
    • LEVEL_CRITICAL
    • MAGENTA
    • RED
    • WHITE
    • YELLOW
  • musif.common.didone_utils module
    • get_gender()
    • get_role()
  • musif.common.exceptions module
    • CannotResurrectObject
    • FeatureError
    • MissingFileError
    • ParseFileError
    • SmartCacheModified
  • musif.common.sort module
    • sort_columns()
    • sort_dataframe()
    • sort_dict()
    • sort_list()
  • musif.common.translate module
• musif.extract package
  • Submodules
  • musif.extract.common module
  • musif.extract.constants module
    • GLOBAL_TIME_SIGNATURE
    • ID
    • MUSIC21_FILE_EXTENSIONS
    • PLAYTHROUGH
    • REQUIRE_MSCORE
    • VOICES_LIST
    • WINDOW_ID
    • WINDOW_RANGE
  • musif.extract.extract module
    • FeaturesExtractor
      • FeaturesExtractor.__init__()
      • FeaturesExtractor.extract()
    • find_files()
    • parse_filename()
    • parse_musescore_file()
  • musif.extract.utils module
    • expand_score_repetitions()
    • extract_global_time_signature()
    • process_musescore_file()
• musif.musescore package
  • Submodules
  • musif.musescore.common module
    • extract_harmonic_analysis()
  • musif.musescore.constants module
    • MUSESCORE_FILE_EXTENSION
• musif.musicxml package
  • Submodules
  • musif.musicxml.common module
    • fix_repeats()
    • get_notes_and_measures()
    • is_voice()
    • name_parts()
    • split_layers()
  • musif.musicxml.constants module
    • FAMILY_TO_ABBREVIATION
    • SCORING_FAMILY_ORDER
    • SCORING_ORDER
    • SOUND_TO_ABBREVIATION
    • SOUND_TO_FAMILY
  • musif.musicxml.key module
    • get_key_and_mode()
    • get_key_signature_type()
    • get_name_from_key()
  • musif.musicxml.repeat module
  • musif.musicxml.scoring module
    • extract_sound()
    • to_abbreviation()
  • musif.musicxml.tempo module
    • TempoGroup2
      • TempoGroup2.FAST
      • TempoGroup2.MODERATE
      • TempoGroup2.NA
      • TempoGroup2.SLOW
    • extract_numeric_tempo()
    • get_number_of_beats()
    • get_tempo_grouped_1()
    • get_tempo_grouped_2()
    • get_time_signature_type()
• musif.process package
  • Submodules
  • musif.process.constants module
    • PRESENCE
    • voices_list
    • voices_list_prefixes
  • musif.process.processor module
    • DataProcessor
      • DataProcessor.data
      • DataProcessor.info
      • DataProcessor.__init__()
      • DataProcessor.delete_files_without_harmony()
      • DataProcessor.delete_undesired()
      • DataProcessor.group_columns()
      • DataProcessor.process()
      • DataProcessor.save()
      • DataProcessor.separate_instrumentation_column()
  • musif.process.utils module
    • merge_dataframes()

Submodules

musif.config module

class musif.config.ExtractConfiguration(*args, **kwargs)

Bases: GenericConfiguration

Configuration object used by :class: musif.extract.extract.FeatureExtractor

It additionaly sets the following properties:

from musif.musicxml import constants as musicxml_c
self.scoring_family_order = musicxml_c.SCORING_FAMILY_ORDER
self.scoring_order = musicxml_c.SCORING_ORDER
self.sound_to_family = musicxml_c.SOUND_TO_FAMILY
self.family_to_abbreviation = musicxml_c.FAMILY_TO_ABBREVIATION
self.sound_to_abbreviation = musicxml_c.SOUND_TO_ABBREVIATION

The above settings can be overriden by the user both by changing the variables in musicxml.constants and by adding them to the configuration.

is_requested_feature_category(feature: str) → bool

Returns True if feature is among the requeste features, according to the configuration. Returns False otherwise.

is_requested_musescore_file() → bool

Returns True if any of the requested features needs musescore files for the harmonic annotations. Returns False otherwise.

class musif.config.GenericConfiguration(arg, **kwargs)

Bases: object

Generic class for configuration objects.

When subclassing, you should override the _get_fallback method.

__init__(arg, **kwargs)

It set up the Configuration object in this way:

1. it sets the default values returned by self._get_fallback() as filed of the object (i.e. in the __dict__ dictionary)

2. it load the configuration file arg provided by the user

3. it overrides the configuration file with the keyword arguments

4. it sets the values obtained, overriding the one already available, in __dict_, making them avilable as usual fields

to_dict() → dict

Returns a dictionary having as keys the public fields of this object.

class musif.config.PostProcessConfiguration(arg, **kwargs)

Bases: GenericConfiguration

Configuration object used by :class: musif.process.DataProcessor

musif.logs module