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

ExportSpectraMask v1

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Returns list of spectra numbers which are masked on a workspace and can save these numbers as legacy .msk file.

See Also

SaveMask, ExportSpectraMask

Properties

Name	Direction	Type	Default	Description
Workspace	Input	Workspace	Mandatory	The workspace to export masks from.
Filename	Input	string		The name or full path to the file to save mask to. If empty, the name of the input workspace and default save directory are used. Allowed extensions: [‘.msk’]
ExportMaskOnly	Input	boolean	False	If true, algorithm will not save mask in a fileand only returns the list containing numbers of masked spectra.
SpectraMasks	Output	long list		List of the masked spectra numbers.

Description

The algorithm extracts list of the spectra numbers which are masked on the input workspace and, if requested, saves these spectra as legacy .msk file in ISIS ASCII format.

The format is described on LoadMask algorithm pages.

Note It is not recommended to use exported .msk files for masking workspaces during reduction as the result of applying such mask will be different depending on the stage of reduction of the source and target files. You need to make additional efforts (see LoadMask algorithm description) to avoid this effect. It is better to use SaveMask algorithm instead. This algorithm produces .xml files, containing lists of masked detectors, which will produce identical masking regardless of the workspace grouping and spectra-detector map, defined for data acquisition electronics during experiment.

Usage

Example: Export Spectra Masks

import sys
#prepare the data:
masks = [1,4,8,10,11,12,12,198,199,200]
test_ws = CreateSampleWorkspace()
test_ws.maskDetectors(masks)

f_name = 'test_ws_mask.msk'

#extract mask:
r_masks = ExportSpectraMask(test_ws,Filename=f_name)

# Compare results:
wmsk = ''
final_fname = os.path.join(config.getString('defaultsave.directory'),f_name)
with open(final_fname,'r') as res_file:
    for line in res_file:
        wmsk = line
os.remove(final_fname)

sys.stdout.write("Input mask: {0}\n".format(masks))
sys.stdout.write("Extracted mask: {0}\n".format(r_masks))
sys.stdout.write("Saved mask: {0}".format(wmsk))

Output:

Input mask: [1, 4, 8, 10, 11, 12, 12, 198, 199, 200]
Extracted mask: [  1   4   8  10  11  12 198 199 200]
Saved mask: 1 4 8 10-12 198-200

Categories: AlgorithmIndex | DataHandling\Masking

Source

Python: ExportSpectraMask.py