Commit 3610a1ad authored by Kendrick, Coleman's avatar Kendrick, Coleman
Browse files

Update documentation for new option

parent 25c5dd09
......@@ -215,6 +215,19 @@ trajectories inside an integration volume, the peak must be rejected.
If there are masked pixel trajectories inside the background volume, the background
events are scaled by estimating the volume of the ellipsoid on the detector.
ShareBackground option
######################
With this option enabled, satellite peaks will share the integrated background
intensity and volume of its corresponding Bragg peak. The integrated intensity
of satellite peaks will still use the radii set with **SatelliteRegionRadius**
and **SatelitePeakSize** though its background intensity will be borrowed
from its Bragg peak.
In cases where a Bragg peak could not be found for a satellite peak, then the background
for the satellite peak is determined as normal using the values of **SatelliteBackgroundInnerSize**
and **SatelliteBackgroundOuterSize** for background subtraction.
Sigma from the background
#########################
The sigma from the background could be too small because the background contains
......
......@@ -51,6 +51,7 @@ Improvements
- Existing :ref:`MaskPeaksWorkspace <algm-MaskPeaksWorkspace-v1>` now also supports tube-type detectors used at the CORELLI instrument.
- Existing :ref:`SCDCalibratePanels <algm-SCDCalibratePanels-v2>` now retains the value of small optimization results instead of zeroing them.
- Existing :ref:`IntegrateEllipsoids <algm-IntegrateEllipsoids-v1>` now can use a different integrator for satellite peaks.
- New option in :ref:`IntegrateEllipsoids <algm-IntegrateEllipsoids-v1>` to share Bragg peak background with satellite peaks.
Bugfixes
########
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment