\(\renewcommand\AA{\unicode{x212B}}\)

LoadSampleEnvironment v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

The algorithm loads an Environment into the instrument of a workspace at the sample.

See Also

CopySample, SetSampleMaterial, LoadSampleShape

Properties

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’, ‘.3mf’]
Scale	Input	string	cm	The scale of the stl: m, cm, or mm
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
XDegrees	Input	number	0	The degrees to rotate on the x axis by
YDegrees	Input	number	0	The degrees to rotate on the y axis by
ZDegrees	Input	number	0	The degrees to rotate on the z axis by
TranslationVector	Input	dbl list	0,0,0	Vector by which to translate the loaded environment
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
AttenuationProfile	Input	string		The path name of the file containing the attenuation profile. Allowed extensions: [‘.dat’]
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’]

Description

Loads an environment into the sample of a workspace, either replacing the current environment, or adding to it. The newly added Environment can be translated by a vector, and rotated by an angle along each axis applied in order X,Y,Z, rotation applies before translation. 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:

• *.stl stereolithography https://en.wikipedia.org/wiki/STL_(file_format) This is a file format consisting of a list of faces specified by their vertex coordinates. The file may be in ASCII or Binary format, and all the faces must be triangular. The normals are ignored, but the vertices must be in the order required by the standard (counter-clockwise when viewed from outside).

• *.3mf https://3mf.io This is a 3D printing format that allows multiple objects to be stored in a single file, each with a representation similar to the .stl format ie a list of faces and vertices

Categories: AlgorithmIndex | DataHandling\Instrument

Source

C++ header: LoadSampleEnvironment.h

C++ source: LoadSampleEnvironment.cpp