\(\renewcommand\AA{\unicode{x212B}}\)
LogarithmMD v1¶
Summary¶
Perform a natural logarithm of a MDHistoWorkspace.
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
---|---|---|---|---|
InputWorkspace |
Input |
IMDWorkspace |
Mandatory |
A MDEventWorkspace or MDHistoWorkspace on which to apply the operation. |
OutputWorkspace |
Output |
IMDWorkspace |
Mandatory |
Name of the output MDEventWorkspace or MDHistoWorkspace. |
Filler |
Input |
number |
0 |
Some values in a workspace can normally be zeros or may get negative values after transformations log(x) is not defined for such values, so here is the value, that will be placed as the result of log(x<=0) operation Default value is 0 |
Natural |
Input |
boolean |
True |
Switch to choose between natural or base 10 logarithm. Default true (natural). |
Description¶
This executes the natural logarithm operation on a MDHistoWorkspace.
The signal \(a\) becomes \(f = log(a)\)
The error \(da\) becomes \(df^2 = a^2 / da^2\)
This algorithm cannot be run on a MDEventWorkspace. Its equivalent on a MatrixWorkspace is called Logarithm v1.
Categories: AlgorithmIndex | MDAlgorithms\MDArithmetic
Source¶
C++ header: LogarithmMD.h
C++ source: LogarithmMD.cpp