esrf

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

maxipix.mac
See other macros in category: Detection Ccd
Description:
    Macros to extend ccd.mac for maxipix functionality %BRIEF% MAXIPIX macros to extend ccd.mac
Documentation:
    DESCRIPTION
    This macro extend ccd.mac for maxipix. The acquisition control is still used through ccd.mac. This macros adds:
    * Configuration menu
    * Medipix Dac pseudo motor
    * Special mpxtake which is a ccdtake optimized for soft multiframe

    SETUP
    mpxsetup for general setup.
    mpxdacsetup to add a medipix dac as a pseudo-motor.

Macros:
    mpxsetup
    Usage: mpxsetup <ccd_spec_unit>


    mpxdacsetup
    Usage: mpxdacsetup <motor_mne> <dac_name>
    Add the specified medipix DAC as a pseudo-motor
    Several pseudo-motors can be added.

    mpxmenu
    Usage: mpxmenu
    Gives access to all maxipix parameters not used in standard ccd interface. It includes:
    * extra control parameters like shutter
    * detector configuration files
    * medipix chip DACs
    * medipix ROI setup

    mpxset
    Usage: mpxset <type> <name> <value>
    Set any maxipix specific parameter

    mpxget
    Usage: mpxget <type> <name>
    Get any maxipix specific parameter

    mpxtakesum
    Usage: mpxtakesum
    Same as mpxtake plus computes a sum of frames and save it if saving enabled (ccdmenu)

    mpxtake
    Usage: mpxtake

    Take a serie of images in multi-frame mode (most efficient than ccdtake with maxipix) with:
    * Possible setting of interval time between frames
    * Reading of frame for display during acquisition (~4 frames/sec read independant of acquisition rate or at specified display rate)
    * Saving of frame if enabled (ccdmenu)

    mpxroi
    Usage: mpxroi <roimne> <xbeg> <xend> <ybeg> <yend>
    Defines a new roi. If no argument given, runs a menu.
    Arguments are:
    roimne : counter mnemonic for the roi (to be defined in spec config)
    xbeg :
    xend :
    ybeg :
    yend :

    _mpx_roireset
    Usage: _mpx_roireset()
    Resets ROI definition.

    _mpx_roimenu
    Usage: _mpx_roimenu()
    Menu to Add/Modify/Delete/Save/Load rois

    mpxroisave
    Usage: mpxroisave [<filename>]
    Save rois definition in a file. If <filename> is not specified, save to the standard location

    mpxroiload
    Usage: mpxroiload [<filename>]
    Load rois from a file. If <filename> is not specified, load from the standard location
    Loading rois from file will erase current roi settings.

Internal Macros:
    _mpx_initccd
    Usage: _mpx_initccd()


    _mpx_initpars
    Usage: _mpx_initpars()


    _mpx_initmsg
    Usage: _mpx_initmsg()


    _mpx_init_getpars
    Usage: _mpx_init_getpars(type)


    mpxdacunsetup
    Usage: mpxdacunsetup


    _mpx_checkname
    Usage: _mpx_checkname(type, name)


    mpxcntsetup
    Usage: mpxcntsetup


    mpxcntunsetup
    Usage: mpxcntunsetup


    _mpx_getcnt
    Usage: _mpx_getcnt(cntmne)


    _mpx_dacget
    Usage: _mpx_dacget(motmne)


    _mpx_dacmove
    Usage: _mpx_dacmove(motmne)


    _mpx_config_menu
    Usage: _mpx_config_menu(type)


    _mpx_getpar
    Usage: _mpx_getpar(type, name)


    _mpx_setpar
    Usage: _mpx_setpar(type, name, value)


    mpxsaveall
    Usage: mpxsaveall
    Save all frames for last acquisition. Usefull after a ccdtake 0.1 1000 for example. Filename as to be correctly defined in ccdmenu. Better to use mpxtake instead.

    _mpxtake
    Usage: _mpxtake(expo, nimg, it_time, drate, sumit)


    _mpxtake_cleanup
    Usage: _mpxtake_cleanup(etrig, itstr)


    _mpxtake_initsum
    Usage: _mpxtake_initsum()


    _mpxtake_addtosum
    Usage: _mpxtake_addtosum(arrname)


    _mpxtake_savesum
    Usage: _mpxtake_savesum(expo, nimg, it_time)


    _mpxtake_sumheader
    Usage: _mpxtake_sumheader(expo, nimg, it_time)


    _mpx_wait
    Usage: _mpx_wait(rate, sumit)


    _mpx_wait_loop
    Usage: _mpx_wait_loop


    _mpx_wait_read
    Usage: _mpx_wait_read(from, to)


    _mpx_wait_msg
    Usage: _mpx_wait_msg


    _mpx_roiadd
    Usage: _mpx_roiadd (mne, xmin, xmax, ymin, ymax)
    Add a new ROI or modify any existing one. Returns the index of the roi.

    _mpx_roirename
    Usage: _mpx_roirename (mne)
    Change the name of an existing Roi.

    _mpx_roishow
    Usage: _mpx_roishow ()
    Shows ROI definition

    _mpx_roiremove
    Usage: _mpx_roiremove(cmne)
    Remove roi definition

    _mpx_print
    Usage: _mpx_print(a,b)


    _mpx_getcounts
    Usage: _mpx_getcounts(mne,_cb,_ce,_rb,_re)
    sum counts over ROI into corresponding spec counter.

Filename: maxipix.mac
Author: E.Papillon, $Revision: 1.15 $, $Date: 2010/02/10 16:16:41 $
Last mod.: 01/10/2010 12:37 by papillon