SANSSliceEvent v1

../_images/SANSSliceEvent-v1_dlg.png

SANSSliceEvent dialog.

Summary

Takes an event slice from an event workspace

Properties

Name Direction Type Default Description
SANSState Input Dictionary   A property manager which fulfills the SANSState contract.
InputWorkspace Input MatrixWorkspace Mandatory The input workspace. If it is an event workspace, then the slice is taken. In case of a Workspace2D the original workspace is returned
InputWorkspaceMonitor Input MatrixWorkspace Mandatory The monitor workspace associated with the main input workspace.
DataType Input string Sample The component of the instrument which is to be reduced. Allowed values: [‘Sample’, ‘Can’]
SliceEventFactor Output number   The factor of the event slicing. This corresponds to the proportion of the the total proton charge, which the slice corresponds to.
OutputWorkspace Output MatrixWorkspace Mandatory The sliced workspace
OutputWorkspaceMonitor Output MatrixWorkspace Mandatory The output monitor workspace which has the correct slice factor applied to it.

Description

This algorithm creates a sliced workspaces from an event-based SANS input workspace according to the settings in the state object. The algorithm will extract a slice based on a start and end time which are set in the state object. In addition the data type, ie if the slice is to be taken from a sample or a can workspace can be specified. Note that the monitor workspace is not being sliced but scaled by the ratio of the proton charge of the sliced worspace to the full workspace. Currently the mask mechanism is implemented for SANS2D, LOQ and LARMOR.

Relevant SANSState entries for SANSSlice

The required information for the slice operation is retrieved from a state object.

The elements of the slice state are:

Entry Type Description Mandatory Default value
start_time List of Float The first entry is used as a start time for the slice No None
end_time List of Float The first entry is used as a stop time for the slice No None

Note that these settings should be only populated via the GUI or the Python Interface of ISIS SANS.

Slice options for the data type: Sample, Can

The Sample setting performs regular slicing

The Can setting does not apply slicing to the specified workspaces.

Categories: Algorithm Index | SANS\SliceEvent

Source

Python: SANSSliceEvent.py (last modified: 2018-10-05)