Ticket #8737 (closed: fixed)
Improve compton scattering algorithm documentation
| Reported by: | Martyn Gigg | Owned by: | Martyn Gigg |
|---|---|---|---|
| Priority: | blocker | Milestone: | Release 3.1 |
| Component: | Direct Inelastic | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Tester: | Anders Markvardsen |
Description (last modified by Martyn Gigg) (diff)
The algorithm documentation for the following algorithms needs improving:
- NormaliseByPeakArea
- ConvertToYSpace
- CalculateGammaBackground
Change History
comment:3 Changed 7 years ago by Martyn Gigg
Add wiki docs for ConvertToYSpace algorithm
Refs #8737
Changeset: 1e87943af94e6ea1286f128b14e4eac1f30e6d43
comment:6 Changed 7 years ago by Martyn Gigg
- Status changed from inprogress to verify
- Resolution set to fixed
Branch: feature/8737_compton_scatter_alg_docs
Tester: The wiki pages are updated from master so won't be live yet. The only checks here are therefore to review the docs in the cpp files that have changed.
comment:7 Changed 7 years ago by Anders Markvardsen
- Status changed from verify to verifying
- Tester set to Anders Markvardsen
comment:8 Changed 7 years ago by Anders Markvardsen
- Status changed from verifying to closed
Merge remote-tracking branch 'origin/feature/8737_compton_scatter_alg_docs'
Full changeset: 72575e29fb9a0316299ce568a628aa60b8833e43
comment:9 Changed 7 years ago by Anders Markvardsen
Descriptions added.
One comment: for NormaliseByPeakArea consider adding a link or description of the ComptonPeakProfile function
comment:10 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 9581
Note: See
TracTickets for help on using
tickets.
