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

SANSILLParameterScan v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Integrate SANS scan data along a parameter

Properties

Name

Direction

Type

Default

Description

OutputWorkspace

Output

Workspace

The output workspace containing the 2D reduced data.

OutputJoinedWorkspace

Output

Workspace

The output workspace containing all the reduced data, before grouping.

SampleRun

Input

string

Mandatory

Sample scan file. Allowed values: [‘nxs’]

AbsorberRun

Input

string

Absorber run. Allowed values: [‘nxs’]

ContainerRun

Input

string

Empty container run. Allowed values: [‘nxs’]

SensitivityMap

Input

string

File containing the map of relative detector efficiencies. Allowed values: [‘nxs’]

DefaultMaskFile

Input

string

File containing the default mask to be applied to all the detector configurations. Allowed values: [‘nxs’]

NormaliseBy

Input

string

Time

Choose the normalisation type. Allowed values: [‘None’, ‘Time’, ‘Monitor’]

Observable

Input

string

Omega.value

Parameter from the sample logs along which the scan is made

PixelYMin

Input

long

3

Minimal y-index taken in the integration. Default is based on D16B geometry.

PixelYMax

Input

long

189

Maximal y-index taken in the integration. Default is based on D16B geometry.

MinThreshold

Input

number

0

Minimum threshold for calculated efficiency.

MaxThreshold

Input

number

2

Maximum threshold for calculated efficiency.

Description

This algorithm allows the integration of data along a parameter. It has been designed for D16 along the Omega axis, but it can normally be applied to other instruments and techniques.

Given a file containing a scan, this algorithm performs usual reduction for SANS detectors, and then produces a 2D ouput, with the x-axis being the x-axis of the detector, and the y-axis the parameter used for the scan. The data is thus the sum of each column of pixels of the detector, stacked one above the others and sorted by the integration parameter. The OutputJoinedWorkspace contains, if asked for, the reduced data on one workspace, along the axis defined by the parameter.

Example - full treatment of a sample

# reduce part of an omega scan on D16.
SANSILLParameterScan(SampleRun="066321.nxs",
                     OutputWorkspace="output2d",
                     OutputJoinedWorkspace="reduced",
                     Observable="Omega.value",
                     PixelYmin=3,
                     PixelYMax=189)

Categories: AlgorithmIndex | ILL\SANS | ILL\Auto

Source

Python: SANSILLParameterScan.py