Skip to content

RFC: Choice of enumerated types for data outcomes #2

Description

@AlexHenderson

REQUEST FOR COMMENTS
I've been writing a few parsers for vendor file formats and realised I needed a context to describe the type of output these should emit.

For example, the Renishaw Raman file format can contain a single spectrum, a collection of spectra, or a 2D spectral image. It is possible it can contain other data structures too, but these are ones I’ve encountered.

The Agilent FTIR format(s) can accommodate single spectra, multiple spectra, spectral maps (spectra at specific coordinates), line scans, and images (in two different modes – single and multiple tiles).

In order to have some consistency, I would like to define the output of a piece of code. This would need to be applicable across different computer languages, since we need parsers in Python, MATLAB, C++, C#, Java, Rust etc, etc. I know this sound very basic, but getting the foundations right is important.

Below is the list I’ve considered. I would like you to look at these and determine whether they:

1 Are easy to understand
2 Are easy to implement in the language or your choice
3 Have missed some important experimental modality you need/are aware of

Items 1 and 3 are most important

The Python code for this available here:
code

Can you please respond to this either by replying to this issue, sending me a private message by email (alex.henderson@manchester.ac.uk) or via the FAIRSpectra Zulip interface, according to your preference. I will try to respond via your chosen platform, and will put outcomes into both this channel and on Zulip.

Thanks, Alex

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions