hkl

Macro library containning diffractometer related macros for the macros server Tango device server as part of the Sardana project.

class br(*args, **kwargs)

Move the diffractometer to the reciprocal space coordinates given by H, K and L. If a fourth parameter is given, the combination of angles to be set is the correspondig to the given index. The index of the angles combinations are then changed.

prepare(H, K, L, AnglesIndex, FlagNotBlocking, FlagPrinting)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L, AnglesIndex, FlagNotBlocking, FlagPrinting)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class ubr(*args, **kwargs)

Move the diffractometer to the reciprocal space coordinates given by H, K and L und update.

prepare(hh, kk, ll, AnglesIndex)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(hh, kk, ll, AnglesIndex)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class ca(*args, **kwargs)

Calculate motor positions for given H K L according to the current operation mode (trajectory 0).

prepare(H, K, L)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class caa(*args, **kwargs)

Calculate motor positions for given H K L according to the current operation mode (all trajectories)

prepare(H, K, L)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class ci(*args, **kwargs)

Calculate hkl for given angle values

prepare(mu, theta, chi, phi, gamma, delta)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(mu, theta, chi, phi, gamma, delta)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class pa(*args, **kwargs)

Prints information about the active diffractometer.

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class wh(*args, **kwargs)

Show principal axes and reciprocal space positions.

Prints the current reciprocal space coordinates (H K L) and the user positions of the principal motors. Depending on the diffractometer geometry, other parameters such as the angles of incidence and reflection (ALPHA and BETA) and the incident wavelength (LAMBDA) may be displayed.

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class freeze(*args, **kwargs)

Set psi value for psi constant modes

prepare(parameter, value)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(parameter, value)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class setmode(*args, **kwargs)

Set operation mode.

prepare(new_mode)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(new_mode)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class getmode(*args, **kwargs)

Get operation mode.

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class setlat(*args, **kwargs)

Set the crystal lattice parameters a, b, c, alpha, beta and gamma for the currently active diffraction pseudo motor controller.

prepare(a, b, c, alpha, beta, gamma)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(a, b, c, alpha, beta, gamma)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class or0(*args, **kwargs)

Set primary orientation reflection.

prepare(H, K, L)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class or1(*args, **kwargs)

Set secondary orientation reflection.

prepare(H, K, L)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class setor0(*args, **kwargs)

Set primary orientation reflection choosing hkl and angle values

prepare(H, K, L, mu, theta, chi, phi, gamma, delta)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L, mu, theta, chi, phi, gamma, delta)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class setor1(*args, **kwargs)

Set secondary orientation reflection choosing hkl and angle values

prepare(H, K, L, mu, theta, chi, phi, gamma, delta)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L, mu, theta, chi, phi, gamma, delta)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class setorn(*args, **kwargs)

Set orientation reflection indicated by the index.

prepare(ref_id, H, K, L, mu, theta, chi, phi, gamma, delta)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(ref_id, H, K, L, mu, theta, chi, phi, gamma, delta)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class setaz(*args, **kwargs)

Set hkl values of the psi reference vector

prepare(PsiH, PsiK, PsiL)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(PsiH, PsiK, PsiL)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class computeub(*args, **kwargs)

Compute UB matrix with reflections 0 and 1

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class addreflection(*args, **kwargs)

Add reflection at the botton of reflections list

prepare(H, K, L, affinement)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(H, K, L, affinement)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class affine(*args, **kwargs)

Affine current crystal. Fine tunning of lattice parameters and UB matrix based on current crystal reflections. Reflections with affinement set to 0 are not used. A new crystal with the post fix (affine) is created and set as current crystal

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class orswap(*args, **kwargs)

Swap values for primary and secondary vectors.

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class newcrystal(*args, **kwargs)

Create a new crystal (if it does not exist) and select it.

prepare(crystal_name)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(crystal_name)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class hscan(*args, **kwargs)

Scan h axis

prepare(start_pos, final_pos, nr_interv, integ_time)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

class kscan(*args, **kwargs)

Scan k axis

prepare(start_pos, final_pos, nr_interv, integ_time)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

class lscan(*args, **kwargs)

Scan l axis

prepare(start_pos, final_pos, nr_interv, integ_time)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

class hklscan(*args, **kwargs)

Scan h k l axes

prepare(h_start_pos, h_final_pos, k_start_pos, k_final_pos, l_start_pos, l_final_pos, nr_interv, integ_time)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

class th2th(*args, **kwargs)

th2th - scan:

Relative scan around current position in del and th with d_th=2*d_delta

run(rel_start_pos, rel_final_pos, nr_interv, integ_time)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class savecrystal(*args, **kwargs)

Save crystal information to file

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class loadcrystal(*args, **kwargs)

Load crystal information from file

prepare()

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run()

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError

class latticecal(*args, **kwargs)

Calibrate lattice parameters a, b or c to current 2theta value

prepare(parameter)

Macro API. Prepare phase. Overwrite as necessary. Default implementation does nothing

run(parameter)

Macro API. Runs the macro. Overwrite MANDATORY! Default implementation raises RuntimeError.

Raises:RuntimeError