Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

encode table parameters with colors #25

Open
isfmiho opened this issue Jan 14, 2021 · 1 comment
Open

encode table parameters with colors #25

isfmiho opened this issue Jan 14, 2021 · 1 comment
Milestone

Comments

@isfmiho
Copy link
Collaborator

isfmiho commented Jan 14, 2021

encode parameters with colors in the tables of the conventions, consider inheritations, limitations, ... ?
any more ideas?

planned for SOFA 3.0

@isfmiho isfmiho added this to the 3.0 milestone Jan 14, 2021
@f-brinkmann
Copy link
Contributor

f-brinkmann commented Mar 22, 2022

Seems to be a good idea for me. Color coding would make it easier to comprehend, inheriting would make it less prone to errors. What we should consider is that any changes have to be communicated to APIs that are also using the csv files as their basis. At the time I think only https://github.com/pyfar/sofar

What about the following idea:
We define subconventions for common sets of data, e.g., the subconvention GLOBAL_ATTRIBUTES would contain the global attributes that every convention uses. In each convention, e.g., GeneralFIR the common global attributes could then be 'impoted' for example through the line import GLOBAL_ATTRIBUTES, which would be fairly ease to parse.

Such subconventions could be generated for

  • global attributes
  • data types (FIR, FIR-E, TF, TF-E, SOS)
  • Listener, and
  • Source

We could then simplify conventions by importing all of these and than only add or override things that are new or different. This would make differences between conventions more clear as a side effect. Moreover we could generate those subconventions based on a relatively easy to write script, that first reads all unique attributes from all conventions and counts how often they appear.

In addition, we could have optional subconventions such as ROOM_DESCRIBTION which could be added to any convention in case the user wants to provide detailed information about the room.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants