Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refs #11325
- Loading branch information
Showing
2 changed files
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
Code/Mantid/docs/source/algorithms/CylinderPaalmanPingsCorrection-v1.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. algorithm:: | ||
|
||
.. summary:: | ||
|
||
.. alias:: | ||
|
||
.. properties:: | ||
|
||
Description | ||
----------- | ||
|
||
Calculates absorption corrections for a cylindrical or annular sample giving | ||
output in the Paalman & Pings absorption factors: :math:`A_{s,s}` (correction | ||
factor for scattering and absorption in sample), :math:`A_{s,sc}` (scattering in | ||
sample and absorption in sample and container), :math:`A_{c,sc}` (scattering in | ||
container and absorption in sample and container) and :math:`A_{c,c}` | ||
(scattering and absorption in container). | ||
|
||
Restrictions on the input workspace | ||
################################### | ||
|
||
The input workspace must have a fully defined instrument that has X axis units | ||
of wavelength. | ||
|
||
Usage | ||
----- | ||
|
||
**Example:** | ||
|
||
.. code-block:: python | ||
# Create a sample workspace | ||
sample = CreateSampleWorkspace(NumBanks=1, BankPixelWidth=1, | ||
XUnit='Wavelength', | ||
XMin=6.8, XMax=7.9, | ||
BinWidth=0.1) | ||
# Copy and scale it to make a can workspace | ||
can = CloneWorkspace(InputWorkspace=sample) | ||
can = Scale(InputWorkspace=can, Factor=1.2) | ||
# Calculate absorption corrections | ||
corr = CylinderPaalmanPingsCorrection(SampleWorkspace=sample, | ||
SampleChemicalFormula='H2-O', | ||
SampleInnerRadius=0.05, | ||
SampleOuterRadius=0.1, | ||
CanWorkspace=can, | ||
CanChemicalFormula='V', | ||
CanOuterRadius=0.15, | ||
BeamHeight=0.1, | ||
BeamWidth=0.1, | ||
StepSize=0.002, | ||
Emode='Indirect', | ||
Efixed=1.845) | ||
print 'Correction workspaces: %s' % (', '.join(corr.getNames())) | ||
Output: | ||
|
||
.. code-block:: none | ||
Correction workspaces: corr_ass, corr_assc, corr_acsc, corr_acc | ||
.. categories:: |