scipp / scipp/ess

Absorption correction for cylindrical samples

Open
#533 3 comments 0 reactions 1 assignee View on GitHub

@jokasimr is already working on this.

Since Jul 24, 2024.

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

Description

Executive summary

Calculate and apply absorption correction for cylindrical samples in Powder Diffraction

Context and background knowledge

For example, see algorithms in Mantid

AbsorptionCorrection

CylinderAbsorption

SNSPowderReduction in Mantid to check when the absorption correction is applied within the whole workflow

Inputs

Scipp data structure from loaded NeXus or csv file(s)

Assumption: the input should be expressed in wavelength

Note that information about the sample (chemical formula, geometry, mass density, number density...) might be stored in the sample log of the file or must have to be provided by the user when using the algorithm.

Methodology

See source code from (Mantid) references above

Assumption: we consider only cylindrical samples for this first implementation

Acceptance criterion
Absorption correction step is implemented in ESS Diffraction worflow (https://scipp.github.io/ess/instruments/external/powgen/powgen.html)

Outputs

This requirement should provide the absorption correction term and the corrected sample data

Which interfaces are required?

Integrated into reduction workflow, Python module / function

Test cases
  • As input file, use POWGEN event file provided in Mantid (PG3_4866_event.nxs or PG3_4844_event.nxs) and already used in ESS Diffraction workflow.
    In this case, the output from the implementation in Scipp could be compared with what we get from Mantid.
  • CSV files from DREAM (also available in Scipp documentation)
Comments

Followup Work: Extend this implementation to:

  • other sample shapes
  • several components (sample, container)
  • using other assumptions (like ‘FullPaalmanPings’)

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.