scipp / scipp/ess

[Image normalization workflow]: `NormalizedImage` could be renamed to `TransmissionImage`

Open
#23 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

To avoid the 'normalized' name clash between normalized to proton-charge and normalized to open beam, the final NormalizedImage (normalized to open beam) could be renamed to TransmissionImage (name I gto from TBL instrument scientist).
Need to double-check that this term is widely used in the community.

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 locating the image normalization workflow and all uses of NormalizedImage; no specific files or tests are named in the issue. Check whether TransmissionImage is widely used in the neutron-scattering community, then determine whether the rename can be applied consistently and document the terminology decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.