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

LoadPSIMuonBin v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Loads a data file that is in PSI Muon Binary format into a workspace (Workspace2D class).

Properties

Name

Direction

Type

Default

Description

Filename

Input

string

Mandatory

The name of the Bin file to load. Allowed extensions: [‘.bin’]

TemperatureFilename

Input

string

The name of the temperature file to be loaded, this is optional as it will be automatically searched for if not provided. Allowed extensions: [‘.mon’]

OutputWorkspace

Output

Workspace

Mandatory

An output workspace.

SearchForTempFile

Input

boolean

True

If no temp file has been given decide whether the algorithm will search for the temperature file.

FirstGoodData

Output

number

First good data in the OutputWorkspace’s spectra

LastGoodData

Output

number

Last good data in the OutputWorkspace’s spectra

TimeZero

Output

number

The TimeZero of the OutputWorkspace

DeadTimeTable

Output

Workspace

This property should only be set in the GUI and is present to work with the Muon GUI preprocessor.

MainFieldDirection

Output

number

The field direction of the magnetic field on the instrument

TimeZeroList

Output

dbl list

A vector of time zero values

TimeZeroTable

Output

Workspace

TableWorkspace of time zeros for each spectra

CorrectTime

Input

boolean

True

Boolean flag controlling whether time should be corrected by timezero.

DetectorGroupingTable

Output

Workspace

Table or a group of tables with information about the detector grouping stored in the file (if any).

SpectrumMin

Input

number

0

Index number of the first spectrum to read

SpectrumMax

Input

number

Optional

Index of last spectrum to read (default the last spectrum)

Description

The algorithm LoadPSIMuonBin will read in a .bin file from the PSI facility, from one of the various machines that use that format. The file name can be an absolute or relative path and should have the extension .bin. The file should only be loaded if the first two bytes are “1N” representing it as the format that this will load.

LoadPSIMuonBin is capable of loading in accompanying temperature files. There are two options for achieving this. If no file is provided and the temperature file searching enabled (it is by default), then it will recursively search for the file in the current directory of the data file and up to 3 directories deeper than the file.

Any temperature data loaded in from a separate file will be available from the resultant workspace’s sample logs, as a number series that is plottable.

The times are automatically offset by the value for time zero for each spectra, such that the pulse is at approximatly time equals zero. This is to be consistant with the default behaviour for ISIS measurement data but can be disabled by setting the CorrectTime property to false.

If no group name is recorded in the data file a name of group_specNum will be used, where specNum is the spectrum number.

Errors

For errors the Poisson distribution is used.

Child Algorithms used

The ChildAlgorithms used by LoadPSIMuonBin are:

Categories: AlgorithmIndex | DataHandling\PSI

Source

C++ header: LoadPSIMuonBin.h

C++ source: LoadPSIMuonBin.cpp