Lookup for the meaning of short parameter names

[pisarik]

Hi!

Would it be nice to have a lookup in opusfc for the meaning of short parameter names (e.g. "NSS" is "Number of sample scans")?

I extracted the parameter codes and their corresponding full names from Opus Reference Manual Version 6 (2006 year). You can find them in the attached json file opus_parameter_codes.zip. The file contains in total 284 unique codes. There are no duplicates among the codes, so it is fine to remove category and subcategory levels, I just preserved them as they are in the reference manual.

Note

This is not a full list of the parameter codes. My opus files still contain 19 unknown codes like "ADT", "AQM"... so perhaps there is a more recent version of the reference manual, but I could not find it.

Json format

{
  "Category_N":  {
    "Subcategory_M": {
       "Code_K": "Full name",
    }
  }
} 

[stuart-cls]

Hi!

Thanks for the suggestion and the list. In fact, such a look up exists at opusFC.paramDict' which you can use as 'paramDict['NSS']. It is not as complete as your list however.

I see it is only briefly mentioned in the docs so I will leave this open to

• Improve documentation for parameter name lookup
• Improve coverage of parameter name lookup

Thanks!

[stuart-cls]

Even better, I forgot in v1.3.0 that I added a complete listing from Jacob Filik under OpusDict.

However, it is all lower-case, targeted at automatic translation, not user-facing. Do you have a preference to continue the sentence case version, or is lower-case sufficient?

[pisarik]

Great! For me OpusDict does the job, thanks!

Though I think it would be nice to add a user-facing functions. Then the "sentence case version" is more user-friendly. I also think these two names are good candidates, since they are easy to guess and find using autocomplete and scanning through documentation.

parameterNamesLookup: dict  # or paramDict also good
def getParameterName(shortCode: str) -> str:
    return parameterNamesLookup[shortCode]