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

ResampleX v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Resample the x-axis of the data with the requested number of points.

See Also

RebinToWorkspace, Rebin2D, Rebunch, Regroup, RebinByPulseTimes, RebinByTimeAtSample

Properties

Name

Direction

Type

Default

Description

InputWorkspace

Input

MatrixWorkspace

Mandatory

An input workspace.

OutputWorkspace

Output

MatrixWorkspace

Mandatory

An output workspace.

XMin

Input

dbl list

A comma separated list of the XMin for every spectrum. (Optional)

XMax

Input

dbl list

A comma separated list of the XMax for every spectrum. (Optional)

NumberBins

Input

number

Mandatory

Number of bins to split up each spectrum into.

LogBinning

Input

boolean

False

Use logarithmic binning. If false use constant step sizes.

PreserveEvents

Input

boolean

True

Keep the output workspace as an EventWorkspace, if the input has events (default). If the input and output EventWorkspace names are the same, only the X bins are set, which is very quick. If false, then the workspace gets converted to a Workspace2D histogram.

Description

This method will resample the x-axis with the number of specified bins. This is done by setting up appropriate parameters to call Rebin with. If the XMin and XMax parameters are supplied it will use those as the range, they can be supplied as a comma delimited list or as a single value.

The LogBinning option calculates constant delta-X/X binning and rebins using that, otherwise the bins are constant width.

Categories: AlgorithmIndex | Transforms\Rebin

Source

C++ header: ResampleX.h

C++ source: ResampleX.cpp