Ticket #5804 (closed: fixed)
Clarify AbsorptionCorrection parameters
| Reported by: | Russell Taylor | Owned by: | Russell Taylor |
|---|---|---|---|
| Priority: | minor | Milestone: | Release 2.3 |
| Component: | Mantid | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Wenduo Zhou |
Description
The absorption correction algorithms have a parameter called AttenuationXSection. The unfortunate thing is that it's actually referring to just the absorption cross-section, rather than the sum of the scattering & absorption cross-sections - which is what attenuation usually refers to.
Update the property descriptions in the code and the wiki to make this clear. As the properties have had these names and meanings for ever, we can't really change them.
Also clarify that ScatteringXSection refers to the sum of the incoherent and the coherent scattering.
Change History
comment:2 Changed 8 years ago by Russell Taylor
Re #5804. Clarify absorption correction properties.
Our property called "AttenuationXSection" really refers to the absorption cross-section, so make sure the descriptions says so.
Changeset: 926df2ca1d3a8aac39d471a91160e33efc6100e6
comment:3 Changed 8 years ago by Russell Taylor
- Status changed from accepted to verify
- Resolution set to fixed
All algorithms that derive from or use AbsorptionCorrection have had the property description updated. The following wiki pages have been updated: AbsorptionCorrection, FlatPlateAbsorption, CylinderAbsorption, HRPDSlabCanAbsorption‎ & SphericalAbsorption‎.
comment:4 Changed 8 years ago by Russell Taylor
Re #5804. Clarify absorption correction properties.
Our property called "AttenuationXSection" really refers to the absorption cross-section, so make sure the descriptions says so.
Changeset: 926df2ca1d3a8aac39d471a91160e33efc6100e6
