Tapping demo

For the full set of experiment files, see demos/pipelines/02-tapping in the GitHub repository.

"""
# DEMO: Tapping Experiemnt to Measure Beat Synchronisation
# This experiment investigates rhythmic tapping abilities through two main tasks:
# 1. Isochronous tapping: Participants tap along with regular metronome beats (600ms and 800ms intervals)
# 2. Musical beat synchronisation: Participants tap along with musical excerpts guided by an initial metronome
#
# The experiment includes volume calibration, recording quality checks, and tapping calibration.
# Data is collected using the REPP framework for precise audio analysis of tapping responses.
"""

# TODO: Improve visual sound levels in volume tests (music and tappin)
# TODO: There may be a wierd bug in the plotting/ analysis of tapping (see output analysis plots in dashboard)
# TODO: PsyNet improvement - automatically extracting n_stimuli and stimuli durations instead of hardcoding them

import psynet.experiment
from psynet.timeline import Timeline
from psynet.trial.static import StaticTrialMaker

# custom pre screening tests to make sure REPP works
from .repp_prescreens import (
    REPPMarkersTest,
    REPPTappingCalibration,
    REPPVolumeCalibrationMusic,
)

from .repp_iso import get_isochronous_stimulus, TapTrialISO, iso_tapping_instructions
from .repp_music import get_music_stimuli_loader, TapTrialMusic, music_tapping_instructions


########################################################
# Musical task parameters
########################################################

# Note: The stimuli must all be .wav files
STIMULUS_DIR = "data/music_stimuli"

# Update the trial time estimate (seconds) to match the length of the audio stimuli
# you have provided. Allow some time for page loading etc.
TapTrialMusic.time_estimate = 40

########################################################
# Timeline
########################################################

music_stimuli_loader = get_music_stimuli_loader(STIMULUS_DIR)

def get_timeline():
    return Timeline(
        REPPVolumeCalibrationMusic(),  # calibrate volume with music
        REPPMarkersTest(),  # pre-screening filtering participants based on recording test (markers)
        REPPTappingCalibration(),  # calibrate tapping
        iso_tapping_instructions,
        StaticTrialMaker(
            id_="iso_tapping",
            trial_class=TapTrialISO,
            nodes=isochronous_stimuli,
            expected_trials_per_participant="n_nodes",
        ),
        music_tapping_instructions,
        StaticTrialMaker(
            id_="music_tapping",
            trial_class=TapTrialMusic,
            nodes=music_stimuli_loader,
            expected_trials_per_participant="n_nodes",
        )
    )

########################################################
# Isochronous tapping parameters
########################################################

# In the isochronous task, the paricipant taps along to a steady metronome.
# We use this task as a standardized baseline in advance of the musical task.


TapTrialISO.time_estimate = 40

isochronous_stimuli = [
    get_isochronous_stimulus("iso_800ms", [800] * 15, bot_response="data/iso_bot_responses/example_iso_slow_tap.wav"),
    get_isochronous_stimulus("iso_600ms", [600] * 12, bot_response="data/iso_bot_responses/example_iso_fast_tap.wav"),
]

########################################################
# Experiment
########################################################

class Exp(psynet.experiment.Experiment):
    timeline = get_timeline()