esrf

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

monoscan.mac
See other macros in category: All
Description:
    Macros to perform monochromator scan with the MUSST card
Documentation:
    DEPENDENCIES
    musst.mac $Revision: 1.15 $

Macros:
    monoscan_setup
    Usage: monoscan_setup [[remote_spec] mono_motmne mono_type [mono_ds] [mca_ds] [velocity_reduction_factor] cnt [en_motmne] nb_val [monoenc_cnt]
    Setup the monoscan with the parameters:
    - remote_spec name (e.g.id29:oh)
    - mono_motmne mono motor mnemonic
    - mono_type accepted values - micos or maxe
    - mono_ds device name if micos type (e.g. id29/micos/1)
    - mca_ds device name if mca detector used (e.g id29/mca/0)
    - velocity_reduction_factor if needed
    - cnt counter mnemonic or mca ROI mnemonic
    - en_motmne energy motor mnemonic
    - nb_val values per scan point - monoenc_cnt mono encoder counter mnemonuc

    monoscan_cleanup
    Usage: monoscan_cleanup
    Cleanup procedure executed at the end of the scan of ^C interruption.

    monoscan_setvelocity
    Usage: monoscan_setvelocity velocity
    Set the "mono" motor velocity.

    monoscan_getvelocity
    Usage: monoscan_getvelocity ()
    Get the "mono" motor velocity.

    monoscan
    Usage: monoscan startE endE nb_pts
    Do the monoscan form energy startE to energy endE, for nb_pts points.

Internal Macros:
    _monoscan_getmotnum
    Usage: _monoscan_getmotnum (mne)
    Get the motor number for mne motor.

    monoscan_getstep
    Usage: monoscan_getstep ()
    Get the step size for the "mono" motor.

    _monoscan_setvel
    Usage: _monoscan_setvel (vel)
    Set the "mono" motor velocity to vel.

    _monoscan_getvel
    Usage: _monoscan_getvel ()
    Get the "mono" motor velocity.

    _monoscan_getconst
    Usage: _monoscan_getconst ()
    Get the monochromator constant to conver energy to angle.

    _monoscan_getdial
    Usage: _monoscan_getdial (pos)
    Return the "mono" motor dial position, correspondig to pos user position.

    _monoscan_getpos
    Usage: _monoscan_getpos ()
    Return the "mono" motor user position.

    _monoscan
    Usage: _monoscan (startE, endE, nb_pts)
    Do the monoscan form energy startE to energy endE, for nb_pts points.

    musstmonoscan_init
    Usage: musstmonoscan_init (mono_angle)
    Initialise the musst program and parameters for mono_angle.

    musstmonoscan
    Usage: musstmonoscan (e1, e2, delta)
    Start the scan from e1 to e2, with delta interval between the points - MUSST commands.

    musstmonoscan_getdata
    Usage: musstmonoscan_getdata (mdat_tmp)
    Get the MUSST data in the mdat_tmp array. Return 0 if the MUSST has not finished the program, nb of points if finished.

    musstmonoscan_progress
    Usage: musstmonoscan_progress ()
    Return the number of points red while program in executuion.

    musstmonoscan_done
    Usage: musstmonoscan_done ()
    return 0 if scan in progress, total nb of points if done.

    musstmonoscan_getmono
    Usage: musstmonoscan_getmono ()
    Return the mono angle (dial units) as read from MUSST.

    monoscan_debug
    Usage: monoscan_debug


    musst_getdata
    Usage: musst_getdata(isgname, nlines, npts, lmdat)


Filename: monoscan.mac
Author: M.Guijarro/A.Beteva
Last mod.: 25/07/2011 13:34 by beteva