Table of Contents
Name | Direction | Type | Default | Description |
---|---|---|---|---|
InputWorkspace | Input | MatrixWorkspace | Mandatory | The name of the workspace containing the instrument to add the Environment |
Filename | Input | string | Mandatory | The path name of the file containing the Environment. Allowed extensions: [‘.stl’] |
OutputWorkspace | Output | MatrixWorkspace | Mandatory | The name of the workspace that will contain the loaded Environment of the sample |
EnvironmentName | Input | string | Environment | |
Add | Input | boolean | False | |
TranslationVector | Input | dbl list | 0,0,0 | Vector by which to translate the loaded environment |
RotationMatrix | Input | dbl list | 1,0,0,0,1,0,1,0,0 | Rotation Matrix in format x1,x2,x3,y1,y2,y3,z1,z2,z3 |
SetMaterial | Input | boolean | False | |
ChemicalFormula | Input | string | The chemical formula, see examples in documentation | |
AtomicNumber | Input | number | 0 | The atomic number |
MassNumber | Input | number | 0 | Mass number if ion (use 0 for default mass sensity) |
SampleNumberDensity | Input | number | Optional | This number density of the sample in number of atoms per cubic angstrom will be used instead of calculated |
ZParameter | Input | number | Optional | Number of formula units in unit cell |
UnitCellVolume | Input | number | Optional | Unit cell volume in Angstoms^3. Will be calculated from the OrientedLattice if not supplied. |
CoherentXSection | Input | number | Optional | Optional: This coherent cross-section for the sample material in barns will be used instead of tabulated |
IncoherentXSection | Input | number | Optional | Optional: This incoherent cross-section for the sample material in barns will be used instead of tabulated |
AttenuationXSection | Input | number | Optional | Optional: This absorption cross-section for the sample material in barns will be used instead of tabulated |
ScatteringXSection | Input | number | Optional | Optional: This total scattering cross-section (coherent + incoherent) for the sample material in barns will be used instead of tabulated |
SampleMassDensity | Input | number | Optional | Measured mass density in g/cubic cm of the sample to be used to calculate the number density. |
NumberDensityUnit | Input | string | Atoms | Choose which units SampleNumberDensity referes to. Allowed values: [‘Atoms’, ‘Formula Units’] |
Loads an environment into the sample of a workspace, either replacing the current environment, or adding to it. you may also set a material for the environment to be loaded, this follows the same inputs as SetSampleMaterial v1.
The following types of input file are supported:
Categories: Algorithm Index | DataHandling\Instrument
C++ source: LoadSampleEnvironment.cpp (last modified: 2019-03-04)
C++ header: LoadSampleEnvironment.h (last modified: 2019-02-10)