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

dataTypeLabel spec for "absolute" moments (TD data) #126

Closed
julien-dubois-k opened this issue Mar 17, 2023 · 5 comments
Closed

dataTypeLabel spec for "absolute" moments (TD data) #126

julien-dubois-k opened this issue Mar 17, 2023 · 5 comments

Comments

@julien-dubois-k
Copy link

The dataTypeLabel spec supports only the changes in moments of the distribution of time of flight (DTOF), with labels:

  • dOD Change in optical density
  • dMean Change in mean time-of-flight
  • dVar Change in variance (2nd central moment)

Would having labels mean and var, so one can export the absolute values of the moments, be agreeable? There is a slight loss of information in the process of computing the changes only.

How about counts or intensity? I'm in particular thinking about TD-nirs gated data or histograms, for which being able to export the absolute quantity (photon counts) rather than the relative quantity (dOD) may be useful.

Note: This is related to a discussion in MNE python's repository, around supporting reading in TD-NIRS data.

@julien-dubois-k
Copy link
Author

may I raise this issue to the top of the stack again? Thank you.

@samuelpowell
Copy link
Collaborator

In a meeting on 17/04/2024, it was proposed to add an optional, per-channel, absolute offset field. When present, absolute data could be represented by the sum of the channel offset and the channel data time series (which would still then be a delta).

This approach was suggested as it avoids the proliferation of different entries in the dataTypeLabel field. Morevoer, it will not break any existing analysis code where absolute values have already been stored using technically incorrect type labels.

@dboas
Copy link
Collaborator

dboas commented Apr 17, 2024

Should we discuss possible implementations for this offset in the spec here?

It could simply be data.dataOffset.

Or we can come up with something a bit more flexible that would allow other types of data to be provided on a per channel basis. For instance something like data.dataMeta that could then have subfields of .name, .data, and .dataLabels much like stim has.

@rob-luke
Copy link
Member

As part of understanding the implications of the simpler proposal from of dataOffset, I wrote out how it might be implemented in #143.

Considering the dataMeta approach, what is something one might want to add there in the future?

@samuelpowell
Copy link
Collaborator

Fixed in #143

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

No branches or pull requests

4 participants