Update Absorption Concept Page #39232
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
searscr
added
Documentation
Kvieta1990
reviewed
Apr 23, 2025
|
|
||
| The gauge volume refers to the region of the sample that is both illuminated by the incident neutron beam and visible to the detector. Only neutrons that are scattered within this volume and reach the detector contribute to the measured signal. Therefore, accurate absorption corrections must account for the size and shape of the gauge volume to avoid over- or under-estimating path lengths through absorbing material. | ||
|
|
||
| In many experimental setups, especially for complex geometries or partial beam coverage, the gauge volume may be significantly smaller than the full sample volume. To accommodate this, Mantid provides multiple methods for defining the gauge volume. These methods are prioritized in the following order: |
There was a problem hiding this comment.
The gauge volume refers to the region of the sample that is both illuminated by the incident neutron beam and visible to the detector. Only neutrons that are scattered within this volume and reach the detector contribute to the measured signal. Therefore, accurate absorption corrections must account for the size and shape of the gauge volume to avoid over- or under-estimating the absorption evaluation.
In normal experimental setups, the neutron beam only partially covers the sample and therefore the gauge volume has to be defined to be smaller than the sample volume. To accommodate this, Mantid provides multiple methods for defining the gauge volume. These methods are prioritized in the following order:
Kvieta1990
approved these changes
Apr 24, 2025
searscr
added a commit
that referenced
this pull request
Apr 25, 2025
* Update Absorption Concept Page * update doc
glass-ships
pushed a commit
that referenced
this pull request
Apr 25, 2025
* Update Absorption Concept Page * update doc
searscr
added a commit
that referenced
this pull request
Apr 25, 2025
* Update BeamProfileFactory (#39135) * Update BeamProfileFactory * Make requested changes * Add Gauge Volume to Monte Carlo Absorption (#39158) * optional gauge volume passed to interaction vol * added initial test that nothing has broken and gv is used * ensure point generated in gauge vol * adjust sptr behaviour and scoped variables * updated mc-strategy tests * now check gv point in sample + added tests * fixed cylinder orientation in test * added release note * amended so gauge volume overrides active region * made scattering sample only when gv and updated docs * changed information to conditional warning * fix cpp check? * fix incorrect virtual method construction * fix new cppcheck fail * create factory init * fix docs warning * revert number of samples to 1 as changes powder references * added comments explaining 'create' change * add bullet point to release note * add nodiscard and compact setActiveRegion * move nodiscard before virtual * warn to check gauge vol if attempts fail * AnyShapeAbsorption uses beam description to determine volume (#39208) * Update BeamProfileFactory * Make requested changes * Added use of IBeamProfile in AnyShapeAbsorption as an option to determine gauge volume. Updated getIntersectionWithSample in IBeamProfile to not need beam direction. Added unit test for AnyShapeAbsorption * Swapped integration volume and sample object when doing Rasterize::calculate() * Fixed IBeamProfileTest * Added release notes * Fixed release notes * Updated function comment * Addressed PR comments * Undid change making raster object const ref * Address PR comments * Undid small change --------- Co-authored-by: Carson Sears <searscr@ornl.gov> * Update Absorption Concept Page (#39232) * Update Absorption Concept Page * update doc * Update PaalmanPingsAbsorptionCorrection (#39210) * Update BeamProfileFactory * Make requested changes * Swapped integration volume and sample object when doing Rasterize::calculate() * Update PaalmanPings * cppCheck and release notes * fix whole sample illuminated by beam * fix cppcheck * address review comments * fix cppcheck * correct Raster::Calculate call * fix cppcheck * add comment for V3D comparison * remove unused variable --------- Co-authored-by: Daniel Caballero <dlcaballero16@gmail.com> --------- Co-authored-by: andy-bridger <71634246+andy-bridger@users.noreply.github.com> Co-authored-by: Daniel Caballero <132241327+dlcaballero16@users.noreply.github.com> Co-authored-by: Daniel Caballero <dlcaballero16@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of work
Update Absorption Concept page to explain about Gauge Volume and include work done in #39210 and #39208
Summary of work
Relates to EWM 10072
Further detail of work
The HTML document can be seen below
To test:
Reviewer
Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.
Code Review
Functional Tests
Does everything look good? Mark the review as Approve. A member of
@mantidproject/gatekeeperswill take care of it.Gatekeeper
If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.