algor1th / wintergatan_data_analysis

Wintergatan Timing Data Analysis

The community has long since clamoured for automatic peak detection and generation of timing data for the Wintergata Marble Machine project. An offhand comment during the 2023 Community Meetup colalesced into this project.

View the live version

A live workflow for detection and generation of timing data is live at https://wtg.mcnulty.in

There is a 100M file size limit for upload, and working data will be removed after 7 days on disk.

Getting Started

The main.py file in the top-level of this repository is the best file for use locally and testing. The web/ directory contains the versions currently deployed onto the mcnulty.in endpoint.

main.py will output help:

usage: main.py [-h] [-f FILENAME] [-o OUTPUT_FILENAME] [-t THRESH] [-c CHANNEL] [-en ENVELOPE_SMOOTHNESS] [-ex EXCLUSION] [-p FLOAT_PREC] [-n NPEAKS] [-b NBINS]
               [-l LEN_SERIES] [-w] [-x X_WIDE] [-y Y_HIGH] [-v]

Map transient times

options:
  -h, --help            show this help message and exit
  -f FILENAME, --file FILENAME
                        File to open
  -o OUTPUT_FILENAME, --out OUTPUT_FILENAME
                        Filename to write output values to
  -t THRESH, --threshold THRESH
                        DEFAULT=0.25 Peak detection threshold, lower is rougher
  -c CHANNEL, --channel CHANNEL
                        DEFAULT=1 Channel to get the Waveform from
  -en ENVELOPE_SMOOTHNESS, --envelope-smoothness ENVELOPE_SMOOTHNESS
                        DEFAULT=100 Amount of rounding around the envelope
  -ex EXCLUSION, --exclusion EXCLUSION
                        DEFAULT=30 Exclusion threshold
  -p FLOAT_PREC, --precision FLOAT_PREC
                        DEFAULT=6 Number of decimal places to round measurements to. Ex: -p 6 = 261.51927438
  -n NPEAKS, --number-peaks NPEAKS
                        DEFAULT=3 Number of valid Peaks from which the leftmost is selected for better lining up between transients.
  -b NBINS, --bins NBINS
                        DEFAULT=0 Number of Bins used for the gaussian curve.
  -l LEN_SERIES, --length LEN_SERIES
                        DEFAULT=100 The length of the series of most consistent Beats.
  -w, --web             Get some width/height values from browser objects for graphing. Defaults false.
  -x X_WIDE, --x-width X_WIDE
                        DEFAULT=2000 Fixed width for graphs.
  -y Y_HIGH, --plot-height Y_HIGH
                        DEFAULT=600 Fixed height for single plot.
  -v, --verbose         Set debug logging

Prerequisites

Currently no automated way of installing requirements is available. Check the import statements in the head of app/main.py

Contributing

Any contribution is welcome! Please branch your feature and create a Pull Request when ready for review.

Authors

So far written by Tom and Yan!