engine

class hkl.engine.CalcParameter(param, geometry, *args, **kwargs)

Like calc parameter but needs reference to a geometry object. Updates to the parameter should be propagated back to the geometry.

Parameters
  • param (HklParameter) –

  • geometry (Geomery object) –

property fit

True if the parameter can be fit or not

class hkl.engine.Engine(calc, engine, engine_list)

HKL calculation engine

property engine

The calculation engine

property mode

HKL calculation mode (see also HklCalc.modes)

property units

The units used for calculations

update()

Calculate the pseudo axis positions from the real axis positions

class hkl.engine.Parameter(param, units='user', name=None, inverted=False)

HKL library parameter object

Example:

Parameter(
        name='None (internally: ux)',
        limits=(min=-180.0, max=180.0),
        value=0.0,
        fit=True,
        inverted=False,
        units='Degree')
property default_units

A string representing the default unit type

property fit

True if the parameter can be fit or not

property hkl_parameter

The HKL library parameter object

property inverted

Is the value inverted internally?

property user_units

A string representing the user unit type

class hkl.engine.Solution(engine, list_item, class_)

solution of the conversion from (hkl) to axes