Skip to content
Snippets Groups Projects
Normal view Permalink
SetCrystalLocation-v1.rst 1.03 KiB
Newer Older
Sullivan, Brendan T's avatar
Re #0 add documentation
Sullivan, Brendan T committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 
.. algorithm::

.. summary::

.. relatedalgorithms::

.. properties::

Description
-----------

This algorithm changes the sample location for an events workspace.  If the InputWorkspace and OutputWorkspace are the same, the position is simply changed.  If the InputWorkspace and OutputWorkspace are different, the InputWorkspace is cloned then the clone's position is changed.  The former is faster, especially for large workspaces. 

Usage
-----

**Example:**

.. testcode:: ExSetCrystalLocation

  events = Load('TOPAZ_3007_bank_37_20_sec.nxs')
  sample = mtd['events'].getInstrument().getSample()
  print('Sample position before SetCrystalLocation: {}'.format(sample.getPos()))
  SetCrystalLocation(InputWorkspace=events, OutputWorkspace=events, NewX=0.1, NewY=0.1, NewZ=0.1)
  print('Sample position after SetCrystalLocation: {}'.format(sample.getPos()))

Output:

.. testoutput:: ExSetCrystalLocation

  Sample position before SetCrystalLocation: [0,0,0]
  Sample position after SetCrystalLocation: [0.1,0.1,0.1]

.. categories::

.. sourcelink::