\(\renewcommand\AA{\unicode{x212B}}\)
SimpleShapeDiscusInelastic v1¶
Summary¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
ReducedWorkspace |
Input |
Mandatory |
Reduced Workspace |
|
SqwWorkspace |
Input |
Mandatory |
S(Q,w) Workspace for the sample |
|
OutputWorkspace |
Output |
WorkspaceGroup |
MuscatResults |
Name for results workspaces |
Container |
Input |
boolean |
False |
Enable input of container data |
SampleMassDensity |
Input |
number |
Optional |
Sample mass density |
SampleChemicalFormula |
Input |
string |
Sample Chemical formula |
|
ContainerMassDensity |
Input |
number |
Optional |
Container number density |
ContainerChemicalFormula |
Input |
string |
V |
Container Chemical formula |
Shape |
Input |
string |
FlatPlate |
Geometry of sample environment. Options are: FlatPlate, Cylinder, Annulus. Allowed values: [‘FlatPlate’, ‘Cylinder’, ‘Annulus’] |
Height |
Input |
number |
1 |
Height of the sample environment (cm) |
Width |
Input |
number |
1 |
Width of the FlatPlate sample environment (cm) |
Thickness |
Input |
number |
0.1 |
Thickness of the FlatPlate sample environment (cm) |
Angle |
Input |
number |
0 |
Angle of the FlatPlate sample environment with respect to the beam (degrees) |
Front |
Input |
number |
0.1 |
Thickness of the FlatPlate front (cm) |
Back |
Input |
number |
0.1 |
Thickness of the FlatPlate back (cm) |
SampleRadius |
Input |
number |
0.5 |
Sample radius (cm). Default=0.5 |
CanRadius |
Input |
number |
0.6 |
Container outer radius (cm). Default=0.6 |
SampleInnerRadius |
Input |
number |
0.5 |
Sample inner radius (cm). Default=0.5 |
SampleOuterRadius |
Input |
number |
0.6 |
Sample outer radius (cm). Default=0.6 |
CanInnerRadius |
Input |
number |
0.45 |
Container inner radius (cm). Default=0.5 |
CanOuterRadius |
Input |
number |
0.65 |
Container outer radius (cm). Default=0.65 |
NeutronPathsSingle |
Input |
number |
1000 |
Number of paths for single scattering. Default=1000 |
NeutronPathsMultiple |
Input |
number |
1000 |
Number of paths for multiple scattering. Default=1000 |
NumberScatterings |
Input |
number |
1 |
Number of scatterings. Default=1 |
NormalizeStructureFactors |
Input |
boolean |
False |
Enable normalisation of structure factor |
Description¶
Sets up a sample shape and optionally a container shape, along with the required material properties, and runs the DiscusMultipleScatteringCorrection algorithm. This algorithm merely serves as a simpler interface to define the shape & material of the sample\container without having to resort to the more complex SetSample algorithm. The computational part is all taken care of by DiscusMultipleScatteringCorrection. Please see that documentation for more details. Currently the shape geometries supported are:
Flat Plate
Cylinder
Annulus
Below are the properties applicable to each specific shape:
FlatPlate¶
Height
Width
Thickness
Angle
Front
Back
Cylinder¶
Height
SampleRadius
CanRadius stands for the outer radius of the annular container, inner radius of which is the same as the radius of the sample.
Annulus¶
Height
CanInnerRadius
SampleInnerRadius
SampleOuterRadius
CanOuterRadius
Categories: AlgorithmIndex | Workflow\MIDAS
Source¶
Python: SimpleShapeDiscusInelastic.py