SetUncertainties v1

../_images/SetUncertainties-v1_dlg.png

SetUncertainties dialog.

Table of Contents

Summary

This algorithm creates a workspace which is the duplicate of the input, but where the error value for every bin has been set to zero.

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory  
OutputWorkspace Output MatrixWorkspace Mandatory  
SetError Input string zero How to reset the uncertainties. Allowed values: [‘zero’, ‘sqrt’, ‘sqrtOrOne’, ‘oneIfZero’]

Description

The uncertainties for the entire workspace will be recalculated according to the SetError property.

  • SetError="zero" will change all of the uncertainties to zero
  • SetError="sqrt" will recalculate all of the uncertainties to be the square root of the y value
  • SetError="oneIfZero" will change the uncertainties to one if they are currently zero
  • SetError="sqrtOrOne" will recalculate all of the uncertainties to be the square root of the y value. If the uncertainty is zero it will be set to one.

The result is a Workspace2D (mantid.api.MatrixWorkspace).

Categories: Algorithms | Arithmetic\Errors