Skip to content
Snippets Groups Projects
Commit 6c43079e authored by Elliot Oram's avatar Elliot Oram
Browse files

add total scattering function to polaris reference file

Refs #21294
parent 3462cde6
No related branches found
No related tags found
No related merge requests found
...@@ -161,8 +161,33 @@ Example ...@@ -161,8 +161,33 @@ Example
polaris_example.set_sample(sample=sample_obj) polaris_example.set_sample(sample=sample_obj)
.. _create_total_scattering_pdf_polaris-isis-powder-ref:
create_total_scattering_pdf
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. warning:: Total scattering support is not yet fully implemented.
Any results obtaining from using the below routine in its current
state should not be considered accurate or complete.
The *create_total_scattering_pdf* method allows a user to create a Pair Distribution Function (PDF)
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.
Example
=======
.. code-block:: python
polaris_example.set_sample(focused_workspace=focused_ws,
merge_banks=False)
.. _calibration_mapping_polaris-isis-powder-ref: .. _calibration_mapping_polaris-isis-powder-ref:
Calibration Mapping File Calibration Mapping File
------------------------- -------------------------
The calibration mapping file holds the mapping between The calibration mapping file holds the mapping between
......
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