MaskBins
From MantidProject
Contents |
Summary
Marks bins in a workspace as being masked.
Properties
| Order | Name | Direction | Type | Default | Description |
|---|---|---|---|---|---|
| 1 | InputWorkspace | Input | MatrixWorkspace | Mandatory | The name of the input workspace. Must contain histogram data. |
| 2 | OutputWorkspace | Output | MatrixWorkspace | Mandatory | The name of the Workspace containing the masked bins. |
| 3 | XMin | Input | Double | Mandatory | The value to start masking from. |
| 4 | XMax | Input | Double | Mandatory | The value to end masking at. |
Description
Masks bins in a workspace. Masked bins should properly be regarded as having been completely removed from the workspace. Bins falling within the range given (even partially) are masked, i.e. their data and error values are set to zero and the bin is added to the list of masked bins. This range is masked for all spectra in the workspace (though the workspace does not have to have common X values in all spectra).
At present, though the zeroing of data will obviously be 'seen' by all downstream algorithms, only DiffractionFocussing (version 2) has been modified to take account of masking. Several algorithms (e.g. Rebin, CropWorkspace) have been modified to properly propagate the masking.
Source Code
Header MaskBins.h
Source MaskBins.cpp
