Table of Contents
Name | Direction | Type | Default | Description |
---|---|---|---|---|
InputWorkspace | Input | IMDWorkspace | Mandatory | Any input MDWorkspace. |
Scaling | Input | dbl list | 1 | Scaling value multiplying each coordinate. Default 1. Either a single value or a list for each dimension. |
Offset | Input | dbl list | 0 | Offset value to add to each coordinate. Default 0. Either a single value or a list for each dimension. |
OutputWorkspace | Output | IMDWorkspace | Mandatory | Name of the output MDWorkspace. |
This algorithm applies a simple linear transformation to a MDWorkspace or MDHistoWorkspace. This could be used, for example, to scale the Energy dimension to different units.
Each coordinate is transformed so that
where:
You can specify either a single value for Scaling and Offset, in which case the same m_scaling or m_offset are applied to each dimension; or you can specify a list with one entry for each dimension.
The relationship between the workspace and the original MDWorkspace, for example when the MDHistoWorkspace is the result of BinMD v1, is lost. This means that you cannot re-bin a transformed MDHistoWorkspace.
No units are not modified by this algorithm.
Categories: Algorithm Index | MDAlgorithms\Transforms
C++ source: TransformMD.cpp (last modified: 2018-12-14)
C++ header: TransformMD.h (last modified: 2018-10-05)