Skip to content
Snippets Groups Projects
Commit 6a796e59 authored by Harriet Brown's avatar Harriet Brown
Browse files

Add changes in polaris to documentation

parent 460a4e6f
No related branches found
No related tags found
No related merge requests found
......@@ -21,6 +21,7 @@ Improvements
- Geometry definition for LLB 5C1
- :ref:`SNAPReduce <algm-SNAPReduce-v1>` has an additional parameter ``MaxChunkSize`` for customizing the chunking behavior
- :ref:`LorentzCorrection <algm-LorentzCorrection-v1>` has an additional option for single crystal (default) or powder operation
- The create_total_scattering_pdf method in Polaris scripts now supports merging banks with a weighted mean.
Bug Fixes
#########
......
......@@ -168,7 +168,10 @@ The *create_total_scattering_pdf* method allows a user to create a Pair Distribu
from focused POLARIS data, with a view performing further total scattering analysis.
With no merging criteria specified, *merge_banks=False* a PDF will be generated for each bank within
the focused_workspace.
the focused_workspace. If run with *merge_banks=True* a PDF will be generated based on the wighted
sum of the detector banks performed using supplied Q limits *q_lims=q_limits*, Q_limits can be in the
form of a numpy array with shape (2, x) where x is the number rof detectors, or a string containing the
directory of an appropriately formatted `.lim` file.
This function requires the run_number you wish to analyse. The focused file for this run number must
either be loaded in Mantid with the naming format given by the *focus* method:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment