SaveParameterFile-v1.rst

.. algorithm::

.. summary::

.. alias::

.. properties::

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

This algorithm allows instrument parameters to be saved into an
`instrument parameter file <http://www.mantidproject.org/InstrumentParameterFile>`__.
The parameter file can then be inspected and or modified. It can also be loaded back into
Mantid using the :ref:`algm-LoadParameterFile` algorithm.

The LocationParameters property specifies whether or not to save any calibration parameters
used to adjust the location of any components. If enabled, SaveParameterFile may also output
"x", "y", "z", "rotx", "roty", and "rotz" parameters when necessary to update the position and
rotation of the components.

Usage
-----

.. testcode::

  import os

  #Create a path in the user's home directory
  filename = os.path.expanduser("~/params.xml")

  #Load a workspace
  ws = Load(Filename = "MAR11001.raw")

  #Save the workspace's instrument's parameters to the given file.
  SaveParameterFile(Workspace = ws, Filename = filename, LocationParameters = False)

  #Make sure the file was written successfully
  if os.path.isfile(filename):
    print("Parameters written successfully.")

.. testcleanup::

   os.remove(filename)

.. testoutput::

  Parameters written successfully.

Example Output::

    <?xml version="1.0" encoding="UTF-8"?>
    <parameter-file instrument="InstrumentName" valid-from="1900-01-31T23:59:59">
      <component-link name="ComponentName">
        <parameter name="ParameterName">
          <value val="2.17"/>
        </parameter>
      </component-link>
    </parameter-file>

.. categories::

.. sourcelink::