scipp / scipp/ess

[Requirement] Tools for processing time-dependent instrument parameters

Open
#153 1 comment 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

Instrument parameters are time dependent, this needs to be processed before, e.g., associating neutron events with parameter values

Context and background knowledge

Version 0.1 of summary written by @g5t:

time_parameter_report.pdf

Inputs

1-D DataArray, typically loaded from an NXlog in a NeXus file.

Methodology

To be determined for individual cases. See also attached PDF.

Outputs

Processed DataArray that can be used, e.g., with Scipp's event filtering.

Which interfaces are required?

Python module / function

Test cases

Creating synthetic data is easy and a good start, but we should consider testing robustness on real data.

Comments

This is likely very generic functionality and may result in addition of basic tools in Scipp as well as ScippNeutron.

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 reading the attached time_parameter_report.pdf and the Scipp event-filtering documentation. Define the individual processing cases for 1-D DataArray inputs loaded from NXlog data before choosing the Python module or function interface. Use synthetic data first, then assess robustness on real data; done means the processed DataArray can be used for event filtering.

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.