Newer
Older
.. algorithm::
.. summary::
.. alias::
.. properties::
Description
-----------
Uses the binary operation algorithms :ref:`algm-Multiply` or
:ref:`algm-Plus` to scale the input workspace by the amount requested.
This algorithm is provided as a simple, but less powerful, alternative
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
to the python `workspace algebra <http://www.mantidproject.org/MatrixWorkspace_Attributes#Workspace_algebra>`__ functionality.
Usage
-----
**Example: Adding an offset**
.. testcode:: ExOffsetScale
ws = CreateSampleWorkspace(BankPixelWidth=1)
print "Every 10th bin value of " + ws.getName()
print ws.readY(0)[0:100:10]
# Add 2 using scale
wsOffset = Scale(ws,2,"Add")
print "Every 10th bin value of " + wsOffset.getName()
print wsOffset.readY(0)[0:100:10]
# Add 2 using the workspace operator overloads
wsOffset2 = ws + 2
print "Every 10th bin value of " + wsOffset2.getName()
print wsOffset2.readY(0)[0:100:10]
Output:
.. testoutput:: ExOffsetScale
Every 10th bin value of ws
[ 0.3 0.3 0.3 0.3 0.3 10.3 0.3 0.3 0.3 0.3]
Every 10th bin value of wsOffset
[ 2.3 2.3 2.3 2.3 2.3 12.3 2.3 2.3 2.3 2.3]
Every 10th bin value of wsOffset2
[ 2.3 2.3 2.3 2.3 2.3 12.3 2.3 2.3 2.3 2.3]
**Example: Multiplying by a value**
.. testcode:: ExOffsetScale
ws = CreateSampleWorkspace(BankPixelWidth=1)
print "Every 10th bin value of " + ws.getName()
print ws.readY(0)[0:100:10]
# Multiply by 10 using scale
wsScaled = Scale(ws,10,"Multiply")
print "Every 10th bin value of " + wsScaled.getName()
print wsScaled.readY(0)[0:100:10]
# Multiply by 10 using the workspace operator overloads
wsScaled2 = ws * 10
print "Every 10th bin value of " + wsScaled2.getName()
print wsScaled2.readY(0)[0:100:10]
Output:
.. testoutput:: ExOffsetScale
Every 10th bin value of ws
[ 0.3 0.3 0.3 0.3 0.3 10.3 0.3 0.3 0.3 0.3]
Every 10th bin value of wsScaled
[ 3. 3. 3. 3. 3. 103. 3. 3. 3. 3.]
Every 10th bin value of wsScaled2
[ 3. 3. 3. 3. 3. 103. 3. 3. 3. 3.]
.. categories::