4.1. rpscripts package

4.1.1. Subpackages

• 4.1.1.1. rpscripts.lib package
  • 4.1.1.1.1. Submodules
  • 4.1.1.1.2. rpscripts.lib.base module
    • CustomException
    • EventLocation
      • EventLocation.make_str_index()
      • EventLocation.parse_str_index()
    • GeneralSubparser
      • GeneralSubparser.add_arguments()
      • GeneralSubparser.handle()
      • GeneralSubparser.setup()
    • RPData
      • RPData.get_agglomeration_dispersion()
      • RPData.get_events_location()
      • RPData.get_frequency_counter()
      • RPData.get_probability_counter()
      • RPData.load_from_file()
      • RPData.make_class_graph()
      • RPData.save_to_csv()
      • RPData.save_to_file()
      • RPData.to_json()
      • RPData.trim()
    • aux_find_next_measure_number()
    • aux_sum_if_none()
    • clean_filename()
    • convert_texture_data_from_json()
    • convert_texture_data_to_json()
    • convert_to_equal_durations()
    • dump_json_data()
    • file_rename()
    • find_nearest_smaller()
    • fraction_to_string()
    • get_diff_lcm()
    • get_fractions_denominator_lcm()
    • get_number_combinations_pairs()
    • load_json_file()
    • make_fraction()
    • make_general_graph()
    • parse_fraction()
    • parse_pow()
    • save_dict_into_csv_file()
  • 4.1.1.1.3. rpscripts.lib.partition module
    • Partition
      • Partition.as_string()
      • Partition.count_binary_relations()
      • Partition.get_agglomeration_index()
      • Partition.get_density_number()
      • Partition.get_dispersion_index()
      • Partition.get_parts_size()
      • Partition.resize()
      • Partition.revariate()
      • Partition.transfer()
    • PartitionLattice
      • PartitionLattice.save_file()
    • get_lexset()
    • get_partitions()
    • make_ryp_map()
    • make_subseq()
  • 4.1.1.1.4. Module contents

4.1.2. Submodules

4.1.3. rpscripts.annotator module

This module provides annotation features. It adds data such as partition into the XML score data and saves as a MXL file.

class rpscripts.annotator.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.annotator.main(m21_score: Score, rpdata: RPData, outfilename: str, labels_name='partitions') → None

Add data from given RPData into the given Music21 score and save its in a new outfile.

4.1.4. rpscripts.calculator module

This module provides classes and functions to calculate the rhythmic partitions from a given digital score.

class rpscripts.calculator.MusicalEvent(**kwargs)

Bases: object

Auxiliary musical event class.

This class has only the needed attributes of Music21’s Note, Rest and Chord classes.

is_rest()

Check if the current object represents a music21’ rest object.

set_data_from_m21_obj(m21_obj, measure_number, measure_offset, offset=None)

Get data from given Music21 object, set as current object’s attributes, and return offset and duration.

class rpscripts.calculator.Parsema(**kwargs)

Bases: object

Auxiliary Parsema class.

Parsema is the set of adjacent equal partitions. See Gentil-Nunes 2009 for further information.

add_single_events(single_events: list) → None

Set single events, calculate their durations and set partition.

set_partition() → None

Create Partition object from single events attribute and set it to partition attribute.

class rpscripts.calculator.ParsemaeSegment(**kwargs)

Bases: object

Parsema segment class.

get_data() → tuple

Get partitions, agglomeration, and dispersion data and their locations.

make_from_music21_score(m21_score: Score) → None

Create Parsema objects fom given Music21 Score object and store at parsemae class attribute.

make_rpdata(filename: str) → RPData

Return RPData object from parsemae class attribute.

class rpscripts.calculator.PartSoundingMap(**kwargs)

Bases: object

Sounding Map class of a musical part.

get_single_event_by_location(global_offset: Fraction) → SingleEvent

Return a SingleEvent object from its location.

set_from_m21_part(m21_part: Part) → None

Set Music21’s part elements into single_events attribute.

Create MusicEvent objects for each event and then, create SingleEvent objects to add to single_events attribute.

class rpscripts.calculator.ScoreSoundingMap(**kwargs)

Bases: object

Sounding Map class of a musical score. Individual parts are sounding maps.

add_part_sounding_map(m21_part: Part) → None

Creates a PartSoundingMap from a given Music21 Part and add it to sounding_maps and attacks attributes.

add_score_sounding_maps(m21_score: Score) → None

Create PartSoundingMap objects from each part of a given Music21 Score.

This method also get measure offsets and explodes voices into parts.

get_single_events_by_location(global_offset: Fraction) → list

Return a list of SingleEvent objects in different sounding_maps from their locations.

make_parsemae() → list

Return a list of Parsema objects from attacks attribute.

This method also handles merged parsemae.

class rpscripts.calculator.SingleEvent(**kwargs)

Bases: object

Auxiliary single event. It’s more simple than Music21’s note and rest objects and has useful attributes such ass number of pitches and sounding.

class rpscripts.calculator.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.calculator.aux_join_music_events(events: dict) → dict

Join MusicalEvent

This methods join adjacent tied objects as well as adjacent rests.

rpscripts.calculator.aux_make_events_from_part(m21_part: Part) → dict

Return a dictionary with Musical Events and their locations from a given Music21 part object.

rpscripts.calculator.auxiliary_get_duration(m21_obj) → Fraction

Return the duration of the given Music21 object as a Fraction object.

rpscripts.calculator.make_music_events_from_part(m21_part: Part) → dict

Return a dictionary with location and Musical Events from a given Music21 part object. Adjacent rests and tied notes are joined.

rpscripts.calculator.make_offset_map(m21part: Part) → dict

Create map with measure number and global offset value.

rpscripts.calculator.split_part_chords(m21_part: Part) → Part

Return a new Music21 Part object with pitches extracted from chords of a given Music21 Part object.

This function splits chords with notes of distinct durations.

rpscripts.calculator.split_score(filename: str) → Score

Parse a given digital score file, split chords, convert voices to parts and returns a new Music21 Score object.

4.1.5. rpscripts.cli module

This module provides the command line interface.

rpscripts.cli.main() → None

Parse the given command line arguments.

4.1.6. rpscripts.config module

This module contains RP Scripts’ global variables.

These variables are used in multiple modules.

4.1.7. rpscripts.converter module

This module converts calculator’s JSON output into CSV file with or without intermediary equally-sized events.

class rpscripts.converter.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args) → None

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.converter.main(filename: str, equally_sized=False) → None

Create RPData object from given filename and save the data into a csv file.

If equally_sized parameter is true, the events are proportionally divided into smaller events of a unique duration.

4.1.8. rpscripts.info module

This shows information about data.

class rpscripts.info.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.info.main(filename: str) → None

Print basic information about the given filename.

4.1.9. rpscripts.labeler module

This module parses TXT label file and adds this information into the JSON file.

class rpscripts.labeler.Edge(label=None, index=None, global_offset=None)

Bases: object

This class represents the point where a excerpt or section starts.

set_global_offset(offset_map: dict) → None

Set the edge global offset from a given offset map.

set_index(offset_map: dict) → None

Set the edge index (measure_number + global_offset).

class rpscripts.labeler.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.labeler.main(json_filename: str, txt_fname: str) → None

Add the given TXT file labels into the given JSON file.

rpscripts.labeler.parse_txt(filename: str) → list

Return list of Edge objects created from extracted labels information given in TXT file.

4.1.10. rpscripts.plotter module

class rpscripts.plotter.AbstractIndexogramPlotter(rpdata: RPData, image_format='svg', close_bubbles=False, show_labels=False)

Bases: AbstractTimePlotter

Abstract indexogram plotter class.

This class extends AbstractTimePlotter and has dispersion and inverted agglomeration data as attributes to help indexograms plotting.

class rpscripts.plotter.AbstractPartitiogramPlotter(rpdata: RPData, image_format='svg', with_labels=True, **kwargs)

Bases: AbstractPlotter

Abstract partitiogram plotter class.

This class extends AbstractPlotter and has agglomeration, dispersion and quantity attributes to help Partitiogram scatter plotting.

check_given_limits() → bool

Return True if there are value filters defined.

check_labels()

data_filter() → None

Filter the dispersion and agglomeration indexes values for a narrowed plot.

plot()

Extend AbstractPlotter’s method. Set X- and Y-axis labels.

class rpscripts.plotter.AbstractPlotter(rpdata: RPData, image_format='svg')

Bases: object

Main abstract plotter class.

This class has useful attributes and methods to handle RPData objects.

get_subplots()

Return subplots dumped into pickle file.

Useful for multiple chart creation.

plot() → None

Plot Setup.

Depends on the extended classes implementation.

save(close_figure=True) → None

Saves the chart into the RPData outname.

xticks_adjust() → None

Apply tight layout method to the plot object.

It is useful for rotated xlabels charts.

class rpscripts.plotter.AbstractTimePlotter(rpdata: RPData, image_format='svg', show_labels=False)

Bases: AbstractPlotter

Abstract time plotter class.

This class extends AbstractPlotter and handles X-axis to show measure numbers and offsets.

make_xticks() → None

plot()

Extend AbstractPlotter’s method. Set X-axis label and add optional vertical lines for labels if they are available in RPData.

xticks_adjust()

Extend AbstractPlotter’s xticks_adjust method.

Rotates xticks.

class rpscripts.plotter.BubblePartitiogramPlotter(rpdata: RPData, image_format='svg', with_labels=True, bubble_size=2000, **kwargs)

Bases: AbstractPartitiogramPlotter

plot()

Extend AbstractPartitiogramPlotter’s method. Create scatter plot.

class rpscripts.plotter.CombinedIndexogramPlotter(rpdata: RPData, image_format='svg', close_bubbles=False, show_labels=False)

Bases: AbstractIndexogramPlotter

plot()

Extend AbstractPlotter’s method. Set X-axis label and add optional vertical lines for labels if they are available in RPData.

class rpscripts.plotter.ComparativePartitiogramMaker(rpdata: RPData, image_format='svg', with_labels=True)

Bases: AbstractPartitiogramPlotter

plot()

Call ComparativePartitiogramPlotter’s plot method for each plotter object available at plotters attribute.

save()

Saves the chart into the RPData outname.

class rpscripts.plotter.ComparativePartitiogramPlotter(rpdata: RPData, column_1, column_2, image_format='svg', with_labels=True, **kwargs)

Bases: AbstractPartitiogramPlotter

plot()

Extend AbstractPartitiogramPlotter’s method. Create multiple superimposed scatter plots.

class rpscripts.plotter.SimpleIndexogramPlotter(rpdata: RPData, image_format='svg', close_bubbles=False, show_labels=False)

Bases: AbstractIndexogramPlotter

plot()

Extend AbstractPlotter’s method. Set X-axis label and add optional vertical lines for labels if they are available in RPData.

class rpscripts.plotter.SimplePartitiogramPlotter(rpdata: RPData, image_format='svg', with_labels=True, **kwargs)

Bases: AbstractPartitiogramPlotter

plot()

Extend AbstractPartitiogramPlotter’s method. Create scatter plot.

class rpscripts.plotter.StairsIndexogramPlotter(rpdata: RPData, image_format='svg', close_bubbles=False, show_labels=False)

Bases: AbstractIndexogramPlotter

plot()

Extend AbstractPlotter’s method. Set X-axis label and add optional vertical lines for labels if they are available in RPData.

class rpscripts.plotter.StemIndexogramPlotter(rpdata: RPData, image_format='svg', close_bubbles=False, show_labels=False)

Bases: AbstractIndexogramPlotter

plot()

Extend AbstractPlotter’s method. Set X-axis label and add optional vertical lines for labels if they are available in RPData.

class rpscripts.plotter.StepIndexogramPlotter(rpdata: RPData, image_format='svg', close_bubbles=False, show_labels=False)

Bases: AbstractIndexogramPlotter

plot()

Extend AbstractPlotter’s method. Set X-axis label and add optional vertical lines for labels if they are available in RPData.

class rpscripts.plotter.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

4.1.11. rpscripts.stats module

This module provides a few statistical data about the given filename.

class rpscripts.stats.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.stats.main(filename: str, no_plot: bool, split_labels: bool) → None

Make histogram and print statistical summary of agglomeration and dispersion indexes.

4.1.12. rpscripts.trimmer module

This module cuts off a given calc’s JSON output file by given start and end measure numbers and return a new JSON file.

class rpscripts.trimmer.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.trimmer.main(rpdata: RPData, start_measure, end_measure) → None

Trim the given RPData between the given start and end measures.

4.1.13. rpscripts.utils module

This module contains helpful tools for the rhythmic partitioning task.

class rpscripts.utils.Subparser(subparser: ArgumentParser)

Bases: GeneralSubparser

Implements argparser.

add_arguments() → None

Add argparse.ArgumentParser arguments.

handle(args)

Parse arguments and run the module functions.

setup() → None

Basic setup.

Set program_name and help message.

rpscripts.utils.copy_default_lattice_map() → None

Copy lattice map to the default path.

rpscripts.utils.save_map(lexset: int) → None

Create a partition lattice of lexset size and save into the program’s default path.

4.1.14. Module contents

Provide main modules and classes.