$$\renewcommand\AA{\unicode{x212B}}$$

# SetSampleFromLogs v1¶

## Summary¶

This algorithm looks through the logs to automatically determine the sample geometry and material

SetSample

## Properties¶

Name

Direction

Type

Default

Description

InputWorkspace

InOut

Workspace

Mandatory

A workspace whose sample properties will be updated

Geometry

Input

Dictionary

A dictionary of geometry parameters for the sample.

Material

Input

Dictionary

A dictionary of material parameters for the sample. See SetSampleMaterial for all accepted parameters

Environment

Input

Dictionary

A dictionary of parameters to configure the sample environment

ContainerGeometry

Input

Dictionary

A dictionary of geometry parameters for the container.

ContainerMaterial

Input

Dictionary

A dictionary of material parameters for the container.

FindGeometry

Input

boolean

True

Whether to look for the ‘Height’ parameter in the logs

FindSample

Input

boolean

True

Whether to look for the sample material in the logs

FindEnvironment

Input

boolean

True

Whether to look for the sample container in the logs

## Description¶

This is a workflow algorithm that reads information from the sample logs before calling SetSample.

## Usage¶

Example - get all information from logs

This assumes that all of the logs are present and contain valid information. The environment is partially specified as InAir so the framework knows to look into the correct environement file.

material = {}
environment = {"Name": "InAir"}
geometry = {}
SetSampleFromLogs(InputWorkspace=wksp, Environment=environment,
Material=material, Geometry=geometry)


Example - specify all information

This could done using SetSample directly.

material = {"ChemicalFormula": "Si", "SampleMassDensity": 1.165}
environment = {"Name": "InAir", "Container": "PAC06"}
geometry = {"Height": 4.}  # cm

SetSampleFromLogs(InputWorkspace=wksp, Environment=environment,
Material=material, Geometry=geometry)


Categories: AlgorithmIndex | Sample

## Source¶

Python: SetSampleFromLogs.py