sf2_competition_action

Github action and Python code for the SF2 competition.

This action is used by the competition template repository https://github.com/sigproc-classrooms/sf2_competition_template. By keeping it in a separate repository, we can update it with the competition image part-way through the course.

The python code (after being installed with pip install .) can be run as

cued_sf2_compete competition lighthouse bridge flamingo

Where competition is the name of the python package in https://github.com/sigproc-classrooms/sf2_competition_template. This will write out your decoded images as png files into the outputs directory, along with a pickle file containing your encoded data. If you right click out outputs/summary.md in VSCode and click "Open preview", you can see the competition results.

This library comes bundled with past competition images too. To use them, add a cued-sf2:// prefix to the filename:

cued_sf2_compete competition cued-sf2://competition/2021.mat

Demonstrator info

This repository interacts with https://github.com/sigproc-classrooms/sf2_competition_results, which is used to collect the results at the end of the lab.