API#

Tasks#

Heartbeat Counting task#

Parameters#

getParameters([participant, session, ...])

Create Heartbeat Counting task parameters.

Scripts#

run(parameters[, runTutorial])

Run the entire task sequence.

trial(condition, duration, nTrial, parameters)

Run one trial.

tutorial(parameters)

Run tutorial for the Heartbeat Counting Task.

rest(parameters[, duration])

Run a resting state period for heart rate variability before running the Heart Beat Counting Task.

Languages#

english()

Create the text dictionary with instruction in English

german()

Create the text dictionary with instruction in German

Heart Rate Discrimination task#

Parameters#

getParameters([participant, session, ...])

Create Heart Rate Discrimination task parameters.

Scripts#

run(parameters[, confidenceRating, runTutorial])

Run the Heart Rate Discrimination task.

trial(parameters, alpha, modality[, ...])

Run one trial of the Heart Rate Discrimination task.

waitInput(parameters)

Wait for participant input before continue

tutorial(parameters)

Run tutorial before task run.

responseDecision(this_hr, parameters, ...)

Recording response during the decision phase.

confidenceRatingTask(parameters)

Confidence rating scale, using keyboard or mouse inputs.

Languages#

english(device, setup, exteroception)

Create the text dictionary with instruction in Danish

danish(device, setup, exteroception)

Create the text dictionary with instruction in Danish

danish_children(device, setup, exteroception)

Create the text dictionary with instruction in Danish (simplified version for children).

french(device, setup, exteroception)

Create the text dictionary with instruction in french

german(device, setup, exteroception)

Create the text dictionary with instruction in German

Recording devices#

LSLRecorder([name, stream_type, channel, ...])

Record ECG or PPG from an LSL stream, with the surface of Oximeter.

Reports#

report(result_path[, report_path, task])

From the results folders, create HTML reports of behavioural and physiological data.

preprocessing(results)

From the main behavioural data frame, extract summary metrics of behavioural, metacognitive and interoceptive performances.