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

SaveSampleEnvironmentAndShape v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

The algorithm saves the environment and sample shape from the instrument of a workspace.

See Also

LoadSampleEnvironment, SetSampleMaterial, LoadSampleShape

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

The name of the workspace containing the environment to save

Filename

Input

string

Mandatory

The path name of the file to save. Allowed extensions: [‘.stl’, ‘.3mf’]

Scale

Input

string

m

The scale of the stl: m, cm, or mm

Description

Saves out the sample and environment on a workspace as a binary .stl file, the sample shape and environment must have been set using LoadSampleShape and LoadSampleEnvironment, as this algorithm only supports shapes stored as a mesh.

The output is of the following type:

  • *.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 will be in Binary format, the Header will contain information about when the file was created, and the normals and attribute code are unset. The vertices are in the standard order (counter clockwise when viewed from the 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: SaveSampleEnvironmentAndShape.h

C++ source: SaveSampleEnvironmentAndShape.cpp