Implement MATLAB generator and analysis tools

[naegelejd]

Changes in this pull request

• PETSIRD MATLAB SDK will now be generated alongside Python and C++
• Generator and Analysis tools ported from Python to MATLAB (petsird_generator.m and petsird_analysis.m)
• matlab/build-toolbox.sh script will build a portable MATLAB toolbox containing the tools

Testing performed

From the top-level of the repository, the following script exercises the MATLAB tools, the output of which can be visually compared to the output of the Python tools.

#!/usr/bin/env bash

matlab -batch "addpath('matlab/toolbox/'); petsird_generator('testdata.matlab.petsird');"
python python/petsird_generator.py > testdata.python.petsird

matlab -batch "addpath('matlab/toolbox/'); petsird_analysis('testdata.matlab.petsird');" > matlab2matlab.analysis
matlab -batch "addpath('matlab/toolbox/'); petsird_analysis('testdata.python.petsird');" > python2matlab.analysis

cat testdata.python.petsird | python python/petsird_analysis.py > python2python.analysis
cat testdata.matlab.petsird | python python/petsird_analysis.py > matlab2python.analysis

Related issues

Closes #78

Checklist before requesting a review

• I have performed a self-review of my code
• I have added docstrings/doxygen in line with the guidance in the developer guide
• The code builds and runs on my machine

Contribution Notes

Please read and adhere to the contribution guidelines.

Please tick the following:

• The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in the ETSI software (the Work) under the terms and conditions of the Apache-2.0 License.

[KrisThielemans]

Looks like our pre-commit config is not specific enough, and it reformatted all .m files in crazy ways. I suggest you drop the last commit, fix the pre-commit-config.yaml and push again.

At present, we don't add generated files to this repo. Still for discussion, but feel free to leave them in now for ease-of-use for whoever (@rgwells2023?) wants to try this out.

[naegelejd]

I don't think it's necessary to commit the generated MATLAB files either. Anyone can regenerate them in the devcontainer, then they can be copied elsewhere and used directly in MATLAB.

[KrisThielemans]

This is nice and clean. I think it would be worth merging. Of course, we will have trouble maintaining it.

I suggest the following

• add a README that this is example code, but not necessarily up-to-date.
• add an Action (https://github.com/matlab-actions) that is allowed to fail, but that way, we'll have some feedback.

@rgwells2023, what do you think?

[KrisThielemans]

@naegelejd I've updated this a bit. Feel like checking? I'd like to merge this soon...

[KrisThielemans]

We should ideally exclude CI for mods in matlab/.

Another thing that would need changing is the version number of the toolbox, but I don't know how to do that. Will have to leave it for later.