This PR changes the format of the BPF files that are stored by PhaseVocoder and FaceWarp to make them directly compatible with deployment in the JONES/revcor app (issue #18)
Why
The revcor online experimentation app expects (1) that parameters are stored in filenames with the same basename as the stimuli and the .txt extension (2) file format with a header (which is used to get column names in the dataframe storing experiment's results) and (3) comma-separated. CLEESE's PhaseVocoder fixed behaviour so far has files as "_bpf.txt", no header, and tab separated. FaceWarp has header and comma-separated, and the ability to change file ext, but default is ".dfm"
How
Added a create_BPF_header function that assembles header str depending on transform and config
modified BPF save to include header and comma-separated
Added a param_ext option in config file syntax, which is now read by PhaseVocoder and replaces the old dfm_extoption in FaceWarp
Changed default FaceWarpext to .txt
Set default PhaseVocoderext to .txt
Added documentation and param_ext
Testing
Tested using the speech and face tutorial, checking correct file format and names in single calls & chained.
What
This PR changes the format of the BPF files that are stored by
PhaseVocoderandFaceWarpto make them directly compatible with deployment in the JONES/revcor app (issue #18)Why
The revcor online experimentation app expects (1) that parameters are stored in filenames with the same basename as the stimuli and the .txt extension (2) file format with a header (which is used to get column names in the dataframe storing experiment's results) and (3) comma-separated. CLEESE's
PhaseVocoderfixed behaviour so far has files as "_bpf.txt", no header, and tab separated.FaceWarphas header and comma-separated, and the ability to change file ext, but default is ".dfm"How
create_BPF_headerfunction that assembles header str depending on transform and configparam_extoption in config file syntax, which is now read byPhaseVocoderand replaces the olddfm_extoption inFaceWarpFaceWarpext to.txtPhaseVocoderext to.txtparam_extTesting
Tested using the speech and face tutorial, checking correct file format and names in single calls & chained.