esrf

Beamline Instrument Software Support
SPEC Macro documentation: [ Macro Index | BCU Home ]

MINIKAPPA.MAC
See other macros in category: MX
Description:
    %B%minikappa.mac%B% - set of macros to handle the EMBL minikappa.
Documentation:
Macros:
    minikappasetup
    Usage: minikappasetup [omega kappa phi offset position]
    Set the minikappa omega, kappa and phi motor mnemonics and the kappa motor offset from the home switch [deg] and loading position when using the sample changer [deg].

    minikappa_on
    Usage: minikappa_on
    Define the minikappa as present.

    minikappa_off
    Usage: minikappa_off
    Define the minikappa as absent.

    minikappa_translation_correction_on
    Usage: minikappa_translation_correction_on
    Activate the translation correction when moving minikappa motors.

    minikappa_translation_correction_off
    Usage: minikappa_translation_correction_off
    Deactivate the translation correction when moving minikappa motors.

    syncMove
    Usage: syncMove (names,positions)
    Give a space separated list of motor names to move and space separated list of new motor positions to arrive to.

    minikappa_init
    Usage: minikappa_init
    Initialise the minikappa - move the kappa, phi and omega motors to their init positions. Set these positions as zero.

Internal Macros:
    kappa_prepare
    Usage: kappa_prepare ()
    Take out some of the minidiff equipment before initialising the kappa motor.

    kappa_print
    Usage: kappa_print (msg)


    sampleRotateSnapshots
    Usage: sampleRotateSnapshots (startPhi,endPhi,stepPhi,directory,prefix)


    kappa_takeimage
    Usage: kappa_takeimage(directory,fname)


    _syncMove
    Usage: _syncMove (names,positions)
    Give a space separated list of motor names to move and space separated list of new motor positions to arrive to. This function is used with minidiff configuration.

    _syncMove_udiff
    Usage: _syncMove_udiff (names,positions)
    Give a space separated list of motor names to move and space separated list of new motor positions to arrive to. This function is used with microdiff configuration.

    readMiniKappaCalibration
    Usage: readMiniKappaCalibration


    moveMiniKappaCentered_mm
    Usage: moveMiniKappaCentered_mm(mne,pos)


    moveKappaCentered
    Usage: moveKappaCentered(Kappa)


    movePhiCentered
    Usage: movePhiCentered(Phi)


    moveMiniKappaCentered
    Usage: moveMiniKappaCentered(Kappa,Phi)


    getCurrentSamplePosition
    Usage: getCurrentSamplePosition ()
    Location vector: normalised motor positions to get a point centred. Normalisation is done to get location vectors in an isotropic (orthogonal and uniscale) right handed coordinate system. Note that the location vector of a point is orientation depended, this is why we need Translation correction when moving Kappa/Phi. Sample Position: inverse of the location vector at zero datum. Hence the Sample Position is an orientation independent identifier of a unique place of a sample.

    getSamplePosition
    Usage: getSamplePosition (sx,sy,sz)
    Without changing the orientation, it identifies the Sample Position (X,Y,Z) which would become centred at given motor settings (sx,sy,sz).

    moveToSamplePosition
    Usage: moveToSamplePosition (X,Y,Z)
    Without changing the orientation, it moves a specific Sample Position (X,Y,Z) to the centre.

    get2DSamplePosition
    Usage: get2DSamplePosition (X,Y,Z)


    centerprepare
    Usage: centerprepare


    motioncommand_eval
    Usage: motioncommand_eval(cmd,motorname,pos)


    mv_eval
    Usage: mv_eval(motorname,pos)


    mvr_eval
    Usage: mvr_eval(motorname,pos)


    _kappa_test
    Usage: _kappa_test(dir,motorname)


    create_gimp_cmd
    Usage: create_gimp_cmd(dir)


    kappa_test
    Usage: kappa_test()


    kappa_reinstate
    Usage: kappa_reinstate()


    kappa_init
    Usage: kappa_init
    Initialise the minikappa kappa motor.

    _kappa_init
    Usage: _kappa_init ()
    Search for the DPAP negative limit signal. Move the kappa motor to the reference position and set it as zero position. Set the speed. Calculate and set the motor limits.

    _kappa_init_udiff
    Usage: _kappa_init_udiff ()
    Initialise the minikappa kappa motor using the MD2 device server

    kphi_init
    Usage: kphi_init
    Initialise the minikappa phi motor.

    _kphi_init
    Usage: _kphi_init ()
    Set the minikappa phi motor speed to the configuration one. Move the motor 200 degdrees back and forth. Set the position to zero.

    _kphi_init_udiff
    Usage: _kphi_init_udiff ()
    Move the minikappa phi motor to zero.

    minikappa_manualload
    Usage: minikappa_manualload ()
    Move the kappa motor to the loading position, when doing manual load. Take out the cryostat head.

    minikappa_home
    Usage: minikappa_home ()
    Move the kappa motor home(zero) position. Put in the cryostat head.

    minikappa_autoload
    Usage: minikappa_autoload ()
    Move the kappa motor to the loading position, when using the sample changer.

    kappa_set_load_position
    Usage: kappa_set_load_position (pos)
    Set the kappa motor loading position pos in degrees.

    kappa_get_load_position
    Usage: kappa_get_load_position ()
    Return the kappa motor loading position in degrees

    minikappa_cleanup
    Usage: minikappa_cleanup()


Filename: minikappa.mac
Author: A.Beteva $Revision: 1.9 $$Date: 2012/07/18 09:26:29 $
Last mod.: 12/09/2014 11:10 by beteva