FindDetectorsInShape

From MantidProject

Contents 1 Summary 2 Properties 3 Description 4 Source Code

Summary

An algorithm for finding which detectors are contained within a user defined 3 dimensional shape within the instrument.

Properties

Order	Name	Direction	Type	Default	Description
1	Workspace	Input	Workspace	Mandatory	The input workspace.
2	ShapeXML	Output	string	Mandatory	The XML definition of the user defined shape. HowToDefineGeometricShape provides a description of the syntax.
3	IncludeMonitors	Input	Boolean	Default false	Whether monitors should be included if they are contained in the shape.
4	DetectorList	Output	Vector of integers		The list of detector ids included within the shape.

Description

The algorithm places the user defined geometric shape within the virtual instrument and reports back the detector id of every detector that in contained within it. A detector is considered to be contained it its central location point is contained within the shape.

Source Code

Header FindDetectorsInShape.h

Source FindDetectorsInShape.cpp