4.2

MaskBinsIf v1

../_images/MaskBinsIf-v1_dlg.png

MaskBinsIf dialog.

Summary

Masks bins based on muparser expression

Properties

Name Direction Type Default Description
InputWorkspace Input MatrixWorkspace Mandatory An input workspace.
Criterion Input string   Masking criterion as a muparser expression; y: bin count, e: bin error, x: bin center, dx: bin center error, s: spectrum axis value.
OutputWorkspace Output MatrixWorkspace Mandatory An output workspace.

Description

This algorithm masks bins according to the criteria specified as a muparser expression. The variables entering the criteria are reserved as follows:

  • y : count in a bin (arbitrary units)
  • x : the bin center (arbitrary units)
  • e : the standard deviation on the count
  • dx : the error on the bin center
  • s : the value of spectrum axis, which has to be SpectraAxis or NumericAxis.

Usage

Example - MaskBinsIf

CreateSampleWorkspace(BankPixelWidth=100, NumBanks=1, OutputWorkspace='out')
MaskBinsIf(InputWorkspace='out', Criterion='s>10 && s<20 && x>1000 && x<2000', OutputWorkspace='out')

Categories: AlgorithmIndex | Transforms\Masking

Source

C++ source: MaskBinsIf.cpp (last modified: 2019-07-17)

C++ header: MaskBinsIf.h (last modified: 2018-10-10)