scipp / scipp/scitiff

Rename the `t` dimension to `tof`? (or not?)

Open
#27 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
2
Avg merge
9m
Merged PRs (30d)
1

Description

The workflow that computes time-of-flight expects the data to have a tof coordinate and a tof dimension.
When loading data with scitiff, the tof coordinate is there, but the dimension is still t.

Can we rename the dim to tof to make downstream processing easier?

That said, tof is not necessarily a good name, because it isn't really tof that is recorded in the data, but toa (or event event_time_offset) instead of real tof.
In addition, once we have converted the data to real tof, if we save that to a tiff stack, the dimension should now be tof.

So maybe the generic t name, which would fit all of toa, tof and event_time_offset is better?
Maybe the renaming of coordinates/dimensions should be handled in the reduction software and scitiff should just use a generic t everywhere?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review how scitiff loads data and how the time-of-flight workflow consumes its coordinate and dimension names. Decide whether the generic t name or specific tof naming should be used across raw and converted data, then define and verify one consistent convention for downstream processing.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.