esrf

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

XSCANS.MAC
See other macros in category: All
Description:
    Expanded scan versions of some standard %B%spec%B% scan macros
Documentation:
    DESCRIPTION
    Expanded scan macros extend the range of standard scans, adding extra points with an optionally different step size. The additional points are placed symetrically at both sides of the `normal' scan range. The original purpose of these macros was to explore in the same scan a central region (a diffraction peak for instance) and the evolution of the background far apart from it.
    New: (16/Oct/1996) dmesh is available

    OVERVIEW
    Names of expanded scan macros are formed by adding an initial 'x' to the name of the corresponding standard macro.
    These macros follow the syntax of the standard scan macros and in addition accept two optional parameters expansion and step_ratio. These parameters are stored in global variables and are not really optional: if they are not entered explicitly, the last values are used.
    The total scan range and the number of intervals after expansion is always larger than the values entered in the macro call.
    The range is expanded a factor approximately defined by the parameter expansion. The step size in the expanded regions is exactly step_ratio times the size in the central non-expanded part.
    The actual total scan range and number of intervals is calculated internally by the macros.

    EXAMPLE
    xascan th -1 +1 20 1 5 8

    This macro will scan the motor `th' taking data with a counting time of 1 second. The total scan range will extend from -5 to +5 (expansion=5). There will be 20 intervals in the central range, [-1,+1], while in the expanded regions, [-5,-1] and [+1,+5], the step size will be 8 times larger.

    DEPENDENCIES
    The file `lineup.mac' has to be loaded if you want to use xlineup.

Macros:
    xascan
    Usage: xascan motor <start> <finish> <intervals> <time> [<expansion>] [<step_ratio>]
    Expanded version of the standard ascan macro.


    xa2scan
    Usage: xa2scan mot1 <s1> <f1> <mot2> <s2> <f2> <intervals> <time> [<expansion>] [<step_ratio>]
    Expanded version of the standard a2scan macro.


    xa3scan
    Usage: xa3scan mot1 <s1> <f1> <mot2> <s2> <f2> <mot3> <s3> <f3> <int> <time> [<exp.>] [<step_ratio>]
    Expanded version of the standard a3scan macro.


    xa4scan
    Usage: xa4scan motor <m1> <s1> <f1> <m2> <s2> <f2> <m3> <s3> <f3> <m4> <s4> <f4> <int> <time> [<exp.>] [<step_ratio>]
    Expanded version of the standard a4scan macro.


    xdscan
    Usage: xdscan motor <start> <finish> <intervals> <time> [<expansion>] [<step_ratio>]
    Expanded version of the standard dscan macro.


    xlineup
    Usage: xlineup motor <start> <finish> <intervals> <time> [<expansion> [<step_ratio> [<thrhold>]]]
    Expanded version of the lineup macro.
    The peak position is determined according to the `LUPmode' variable that can be modified with the lupsetup macro. The lineup and lupsetup macros are defined in the `lineup.mac' macro file.
    An optional parameter <thrhold> forces the macro to further checks. If the peak value is lower than the threshold value the macro prints a `No peak found' error. If <thrhold> is negative the actual threshold is the absolute value of <thrhold>. If <thrhold> is positive the counters are run one time interval before starting the scan and the threshold value is calculated by multiplying <thrhold> by the detector counts. In other words positive values of <thrhold> are relative thresholds.

    dmesh
    Usage: dmesh two-motor relative mesh cscan
    for relative mesh scans. Syntax is like dscan but with mesh

Internal Macros:
    _xascan
    Usage: _xascan
    Expanded version of the _ascan macro.


Filename: xscans.mac
Author: P. Fajardo, (Original 4/94). $Revision: 3.4 $ / $Date: 2017/10/19 14:31:55 $
Last mod.: 19/10/2017 16:32 by guilloud