Source code for vis.analyzers.experimenter

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Program Name:           vis
# Program Description:    Helps analyze music with computers.
# Filename:               controllers/
# Purpose:                Help with transforming time-attached analytic information to other types.
# Copyright (C) 2013 Christopher Antila
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU Affero General Public License for more details.
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <>.
.. codeauthor:: Christopher Antila <>

This module outlines the Experimenter base class, which helps with transforming time-attached
analytic information to other types.

# noinspection PyUnusedLocal
[docs]class Experimenter(object): """ Run an experiment on an IndexedPiece. Use the "Experimenter.required_indices" attribute to know which Indexer subclasses should be provided to this Experimenter's constructor. If the list is None or [], use the "Experimenter.required_experiments" attribute to know which Experimenter should be provided to the constructor. """ # just the standard instance variables possible_settings = [] default_settings = None # required_score_type = None <-- this may be set by an Experimenter if they require the Score, # as the LilyPondExperimenter does, for example # self._index # pylint: disable=W0613 def __init__(self, index, settings=None): """ Create a new Experimenter. :param index: lists or nested lists of pandas.Series or pandas.DataFrame objects. A list (or list of lists) of Series. The minimum and maximum numbers, and whether to use embedded lists, depends on the Experimenter subclass. :param settings: dict A dict of all the settings required by this Experimenter. All required settings should be listed in subclasses. Default is {}. :raises: RuntimeError, if required settings are not present in the "settings" argument. """ # Call our superclass constructor, then set instance variables super(Experimenter, self).__init__() self._index = index if hasattr(self, u'_settings'): if self._settings is None: self._settings = {} else: self._settings = {}