.. _func-PeakHKLErrors:

=============
PeakHKLErrors
=============

.. index:: PeakHKLErrors

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

This function calculates, for each peak, its h, k, and l offsets from 
an integer using goniometer settings and/or tilt and sample offsets from 
the parameters.

The original PeaksWorkspace is unchanged.

Outputs
#######

The PeaksWorkspace is NOT changed.

The argument out in function1D has ,for each peak, the h,k, and l
offsets from an integer using the current parameter values.

.. attributes::

   OptRuns;;;A list of run numbers whose sample orientations are to be optimized. The list is separated by ``/``
   PeakWorkspaceName;;;The name of the PeaksWorkspace in the AnalysisDataService

.. properties::

#. SampleXOffset- XOffset of Goniometer center from instrument center in
   meters
#. SampleYOffset- YOffset of Goniometer center from instrument center in
   meters
#. SampleZOffset- YOffset of Goniometer center from instrument center in
   meters

#. GonRotx- For Goniometer tilt. Rotation about x-axis in degrees where
   Tilt = Rotx(GonRotx)\*Roty(GonRoty)\*Rotz(GonRotz)
#. GonRoty- For Goniometer tilt. Rotation about y-axis
#. GonRotz- For Goniometer tilt. Rotation about z-axis( done 1st AFTER
   phi-chi-omega rotations)

#. chixxx - xxx is a run number from OptRuns. This is the chi angle in
   degrees that will be used for that run( before tilting)
#. phixxx - xxx is a run number from OptRuns. This is the phi angle in
   degrees that will be used for that run
#. omegaxxx - xxx is a run number from OptRuns. This is the omega angle
   in degrees that will be used for that run

.. note::

   When used in fitting, some or all of the first 6 parameters could
   be tied to zero.

.. categories::

.. sourcelink::