scipp / scipp/ess

[Requirement] Slicing dataset based on a certain log.

Open
#147 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

essreduce
Dominant language
Python
Stars
1
Forks
3
Avg merge
2d 11h
Merged PRs (30d)
17

Description

Executive summary

Dataset should be split based on the timestamp of the certain logs.

Context and background knowledge

During the measurement, there will be some changes and they will be logged into the files.
They will have timestamps and the dataset should be binned(sliced) based on thaose timestamps.

Inputs

File or dataset that contains NXlog or other time-dependent fields.

Methodology

I think it'll be nice if there is a binning helper that uses foreign key for binning.
For example, we need to use the timestamp of the rotation_angle to slice the data, and the timestamp will be the foreign key.

Otherwise, we can just assume the foreign key will always be the timestamp...?

Outputs

Sliced dataset as....

@scipp/ess-maintainers I'm not sure if it should be a DataGroup or DataArray...

Which interfaces are required?

Python module / function

Test cases

There is a timepix dataset that recorded rotation angle of the sample.
The dataset should be split based on the rotation angle.

Comments

No response

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

Start by inspecting the time-dependent fields in the timepix dataset, especially NXlog and rotation_angle, and determine how their timestamps should define slices. Then identify the Python module and function entry point for the binning helper and clarify whether the output should be a DataGroup or DataArray. Done means the dataset is split reproducibly at the rotation-angle timestamps with test coverage for that case.

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.