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

SANSBeamFinder v1

Summary

Beam finder workflow algorithm for SANS instruments.

Properties

Name	Direction	Type	Default	Description
Filename	Input	string	Mandatory	Data filed used to find beam center. Allowed extensions: [‘_event.nxs’, ‘.xml’]
BeamCenterX	Input	number	Optional	Beam position in X pixel coordinates
BeamCenterY	Input	number	Optional	Beam position in Y pixel coordinates
UseDirectBeamMethod	Input	boolean	True	If true, the direct beam method will be used
BeamRadius	Input	number	3	Beam radius in pixels, used with the scattered beam method
FoundBeamCenterX	Output	number
FoundBeamCenterY	Output	number
PersistentCorrection	Input	boolean	True	If true, the algorithm will be persistent and re-used when other data sets are processed
ReductionProperties	Input	string	__sans_reduction_properties
OutputMessage	Output	string

Description

Beam finder workflow algorithm for SANS instruments. This algorithm is rarely called directly. It is called by SANSReduction or HFIRSANSReduction.

This algorithm abstracts out the details of how to call the FindCenterOfMassPosition algorithm. By using the ReductionProperties property, the algorithm will store previously calculated results so that the center doesn’t have to be recalculated every time we load a new file.

Categories: AlgorithmIndex | Workflow\SANS\UsesPropertyManager

Source

C++ header: SANSBeamFinder.h

C++ source: SANSBeamFinder.cpp