giuthas / satkit Goto Github PK

From a conversation with Matthew yesterday.
There are various points where variable and function naming could be clearer.

• Anything currently called 'token' as part of its name should more likely more appropriately be called 'recording'.
• 'of' as a function name makes for slightly confucing code and may potentially clash with future Python reserved words.

Since different formats of ultrasound data save synchronisation information in different ways, handling timestamp generation or reading should be part of the import functions instead of the processing algorithms.

Currently of_cli.py and pd_cli.py work differently: of_cli contains most of the interface code and pd_cli is just a wrapper for package modules. Latter is preferrable, but getting both to work with minimal code replication requires a bit of a rethink in how commandline interfaces are implemented in SATKIT.

Citations.bib doesn't contain all the references it should and the ones in it are not referred to in README.