esrf

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

MAR345.MAC
See other macros in category: Ccd Detection
Description:
    MAR Research scanner commands and utilities.
Documentation:
    DESCRIPTION
    The MAR345 scanner provides a X-ray detection area from 180 to 345 mm with two possible pixel sizes 100 and 150 micro-meter. This scanner is using a unique image-plate that is erased after each exposure-read-out cycle. This is why the mar is used as detector and not as a offline scanner. Read-out cycles range from 108 to 34 (!!!) seconds, depending on pixel size and scanned plate diameter. This is about 3 times faster than other scanners and actually comes close to the performance of CCD-detectors.
    a TACO device server named MarScan345ds is running on the MAR computer and controls the scanner.

    OVERVIEW

    These user macros allow full control of the scanner for doing single scan, enabling spec scan with the mar like pseudo-counter or starting a data collection with spindle/shutter synchronisation.
    marsetup
    setup parameters to get control of the mar
    marnewfile
    set the image filename parameters
    maron
    set on the use of the mar with the spec scan commands
    maroff
    set off the mar use with the spec scan commands
    marscan
    scan the Image Plate.
    marread
    read the image and display it with dis GUI
    marerase
    erase the Image Plate.
    marformat
    change the image saved-format.
    marmode
    set the image size.
    maroptpar
    set the the optional parameters that will be saved into the file header
    marcollect
    Perform a data collection


    DEPENDENCIES
    The file(s) mar345.mac, ccd.mac have to be read in

Macros:
    marsetup
    Usage: marsetup
    Setup parameters for MAR345 scanner

    maron
    Usage: maron
    Activate marscan during scan acquisitions

    maroff
    Usage: maroff
    Deactivate marscan during scan acquisitions

    marscan
    Usage: marscan ["frame number"] ["image directory"] ["filename prefix"]
    Starts a scan command on MAR 345 scanner

    marread
    Usage: marread [binning factor]
    read the last image by applying binning reduction and display it.

    marstop
    Usage: marstop
    Stop once the current command is completed

    marwait
    Usage: marwait
    to get synchronized with the scanner

    marmode
    Usage: marmode ["mode"]
    change the mode

    marformat
    Usage: marformat ["format"]
    Change the format

    marerase
    Usage: marerase
    Start erasure of the image plate, take a while ...

    marnewfile
    Usage: marnewfile
    Set new file parameters.

    marimagepar
    Usage: marimagepar
    Set image parameters, detector distance and wavelength

    marcollect
    Usage: marcollect ["filename prefix"] ["frames number"] ["passes number"] ["oscillation range"] ["oscillation overlap"] ["exposure time"] ["starting position"] ["image directory"] ["erase first"]
    Performs the data collection. will acquire [frames number] images into the ["image directory"] directory with the file names ["filename prefix"]_$$ (where $$ is from [starting frame number] to [starting frame number]+[frames number]. The first position will be [starting position], the angle oscillation for each frame is [oscillation range] and there will be [passes number] passes for each frame in [exposure time] seconds.

Internal Macros:
    mar_cleanup
    Usage: mar_cleanup
    sub-macro to be chained with cleanup_once

    mar_prompt
    Usage: mar_prompt


    _marscan
    Usage: _marscan
    sub-macro calls by the marscan and marcollect macros

    mar_imagepar
    Usage: mar_imagepar()


    mar_filepar
    Usage: mar_filepar()
    internal function that really set the new file parameters. return -1 if the esrf_io failed

    mar_getfilename
    Usage: mar_getfilename()
    internal function that reset the current filename setting return -1 if the esrf_io failed

    mar_wait
    Usage: mar_wait()
    Check for termintaion of command.

    marshow
    Usage: marshow


    mar_getvals
    Usage: mar_getvals


    mar_head
    Usage: mar_head


    mar_loop_frames
    Usage: mar_loop_frames()


    mar_dataloop
    Usage: mar_dataloop


Filename: mar345.mac
Author: L.Claustre / V.Rey, 1997-2002 $Revision: 2.4 $
Last mod.: 31/07/2008 08:53 by rey