scipp / essreflectometry

Reflectometry data reduction for the European Spallation Source
https://scipp.github.io/essreflectometry/
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

docs: add description of data reduction procedure #65

Open jokasimr opened 2 months ago

jokasimr commented 2 months ago

Fixes #7

This is still a bit coarse, but I think it contains the important bits.

~I'm marking this as a draft for now~

jokasimr commented 1 month ago

To avoid making this PR too large. I'll add separate issues for documenting:

jl-wynen commented 1 month ago

In general, splitting PRs into small units is good. But that only works when those units are self-contained. Here, I cannot judge whether the documentation is good without seeing all of it. In the last PR of this series, I would have to read everything again anyway. So can you please combine them into one PR?

jokasimr commented 1 month ago

The risk I see not splitting this effort into manageable pieces is that

  1. It will never get finished, and never reviewed, because it will become to cumbersome. It's already quite a mouthful.
  2. It will get out of sync with the code.
  3. No one will have any use of it before everything is done.

I don't agree that the pieces are not self contained. You don't need to know the geometry of the beamline, the chopper setup etc, to follow what is done here. This part of the documentation assumes there exists some procedure to compute $\lambda, \theta$ etc but doesn't specify how that is done, and I think that is fine.

The same goes for the parts about footprint correction and the resolution function.

jl-wynen commented 2 weeks ago

If this was true, we would not need to do any error propagation at all before we compute a Q histogram.

Yes and we typically don't right?

But I see what you mean. There's something a bit wrong here. The events are weighted. So one > event is actually not a single events, but a "package" of events. Individual packages of events arrive independently, but inside a package the events don't arrive independently. I think we should talk about this in person to get the formulation right here. 👍

We should