esrf

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

ccdbpm.mac
See other macros in category: Detection Ccd
Description:
    Macro to use the "beam-positioning-monitor" interface of the ccd device servers when it is available.
Documentation:
    DESCRIPTION
    The following servers support the BPM interface:
    • meteor2
    • frelon
    • sensican
    The Meteor2 device server can be accessed via SPEC as a standart CCD camera. All standart functionality is implemented. Several extra features are available which are accessible via this set of macros as well as ccdmenu. The main features are:
    • Counters on calculated beam parameters (spot center, size, ...)
    • Manual and automatic image intensity calibration
    • Live mode for monitoring
    • Intensity threshold on image


    EXAMPLE
    ccdbpmsetup device_name min_intensity max_intensity threshold
    It will set default calibration parameters for the active BPM CCD camera. You can add this setup into the SPEC setup.
    ccdbpmshow
    Shows all readable parameters for the active BPM camera with their index and actual values. The actual BPM camera set-up is:
    [index] : description : value
    -----------------------------------------
    [0] : Exposure time : 0.000000
    [1] : Threshold : 0
    [9] : Live mode : 0
    [30] : Auto calibration mode : 0
    [2] : Calibrated max. Intensity : 0
    [3] : Full image size X : 0
    [4] : Full image size Y : 0
    [5] : ROI start X : 0
    [6] : ROI start Y : 0
    [7] : ROI end X : 0
    [8] : ROI end Y : 0
    [10] : Number of beam spots : 0
    [11] : Beam intensity : 0
    [29] : Normalized beam intensity : 0
    : (Beam intensity/Exposure time)
    [12] : Beam center X : 0.00
    [13] : Beam center Y : 0.00
    [14] : Beam size FWHM X : 0
    [15] : Beam size FWHM Y : 0
    [16] : Beam size full X : 0
    [17] : Beam size full Y : 0
    [18] : Max. pixel value : 0
    [19] : Max. pixel X : 0
    [20] : Max. pixel Y : 0
    [21] : Beam spot start X : 0
    [22] : Beam spot start Y : 0
    [23] : Beam spot end X : 0
    [24] : Beam spot end Y : 0
    [25] : Beam spot FWHM start X : 0
    [26] : Beam spot FWHM start Y : 0
    [27] : Beam spot FWHM end X : 0
    [28] : Beam spot FWHM end Y : 0
    ccdbpm_counter_add inten "d05/meteor2/eh1" beam_intensity 1
    Configures the counter inten with the beam intensity value (index = 11)
    ccdbpm_counter_add cenx "d05/meteor2/eh1" y_beam_center 1
    Configures the counter cenx with the beam center Y value (index = 12)
    ccdbpm_counter_add ceny "d05/meteor2/eh1" z_beam_center 1
    Configures the counter ceny with the beam center Z value (index = 13)
    ccdbpmon
    Switches on the configured counters during ct and scans.
    ccdbpmoff
    Switches off the configured counters during ct and scans.


Macros:
    meteor_undef
    Usage: meteor_undef
    has to be called at once to undef the obsolate meteor macros.

    ccdbpmon
    Usage: ccdbpmon [ccd unit]
    Switches on the configured counters during ct and scans.

    ccdbpmoff
    Usage: ccdbpmoff [ccd unit]
    Disables the configured counters during ct and scans.

    ccdbpmshow
    Usage: ccdbpmshow
    Shows all readable parameters for the camera with their index and actual values.

    ccdbpm_counter_add
    Usage: ccdbpm_counter_add [ counter_mnemonic ccd_ds signal_name factor ]
    Adds the counter with the given mnemonic which reads the ccd_ds device value specified by the signal_name signal . The signal name can be found by executing "ccdbpmshow"!

    ccdbpm_counter_remove
    Usage: ccdbpm_counter_remove [ counter_mnemonic ]
    Removes the counter with the given mnemonic.

    meteorsetup
    Usage: meteorsetup <device-name> <minimum_intensity> <maximum_intensity> <threshold>
    Setup default parameters of the Meteor2 camera.One can add this setup into the SPEC setup to save the default setting of the camera calibration.

    meteor_liveon
    Usage: meteor_liveon [ccd-unit]
    Start the camera live mode The "Take an image during ct/scan" feature of ccdmenu is disabled because it is incompatible with the live mode.

    meteor_liveoff
    Usage: meteor_liveoff [ccd-unit]
    Stop the camera live mode

    meteor_autocal_on
    Usage: meteor_autocal_on ()
    Switch on the intensity calibration for every image aquired. The camera calibrates the image intensity using the specified range before taking an image by changing the exposure time. see ccdbpmsetup.

    meteor_autocal_off
    Usage: meteor_autocal_off ()
    Switch off the intensity calibration for every image aquired.

    meteorcalibrate
    Usage: meteorcalibrate
    start calibration of the Meteor2 CCD camera exposure time. Apply the min and max intensity set by ccdbpmsetup macro.

    meteor_calibrate_intensity
    Usage: meteor_calibrate_intensity minimum_intensity maximum_intensity
    start calibration of the Meteor2 CCD camera exposure time then return the calibrated maximum intensity and the calibrated exposure time.

    meteor_pixelsize
    Usage: meteor_pixelsize <Y pixelsize> <Z pixelsize>
    store the pixel size in Y and Z into the database through the device server

Internal Macros:
    ccdbpm_private_show
    Usage: ccdbpm_private_show


    _ccdbpm_check
    Usage: _ccdbpm_check(u)


    ccdbpm_private_setup
    Usage: ccdbpm_private_setup


    _ccdbpm_on
    Usage: _ccdbpm_on(u)


    _ccdbpm_off
    Usage: _ccdbpm_off(u)


    _ccdbpm_signal_menu
    Usage: _ccdbpm_signal_menu()


    _ccdbpm_init_siglist
    Usage: _ccdbpm_init_siglist()


    ccdbpm_ct_add
    Usage: ccdbpm_ct_add (counter_mnemonic ccd_ds signal_index signal_factor)
    Adds the counter with the given mnemonic which reads the ccd_ds camera value specified by the index. The index can be found by executing "ccdbpmshow"!

    ccdbpm_ct_remove
    Usage: ccdbpm_ct_remove (counter_mnemonic)
    Removes the counter with the given mnemonic.

    ccdbpm_ct_read
    Usage: ccdbpm_ct_read
    Reads all counters specified for the camera if the reading was eanabled by "ccdbpmon"!

    ccdbpm_is_running
    Usage: ccdbpm_is_running(dev)


    ccdbpm_is_ready
    Usage: ccdbpm_is_ready(dev)


    ccdbpm_getsignals
    Usage: ccdbpm_getsignals(dev)


    ccdbpm_initpar
    Usage: ccdbpm_initpar(dev,unit)
    Initialise the local parameters with the current camera setting.

    _ccdbpm_listchk
    Usage: _ccdbpm_listchk(dev)
    Check the list array has been initialised for the dev device.

    meteor_counter_add
    Usage: meteor_counter_add


    meteor_counter_remove
    Usage: meteor_counter_remove


    meteoron
    Usage: meteoron


    meteoroff
    Usage: meteoroff


    meteor_initpar
    Usage: meteor_initpar(dev)
    Initialise the local parameters with the current camera setting.

    meteor_live_on
    Usage: meteor_live_on(u)


    meteor_live_off
    Usage: meteor_live_off(u)


    _meteor_calibrate_intensity
    Usage: _meteor_calibrate_intensity (minimum_intensity, maximum_intensity)
    start calibration of the Meteor2 CCD camera exposure time.

    meteor_setthreshold
    Usage: meteor_setthreshold (threshold)
    set the threshold.

    meteor_getthreshold
    Usage: meteor_getthreshold(dev)
    Return the threshold.

    meteor_read_beam_center
    Usage: meteor_read_beam_center ()
    return Y and Z beam position + Y Fwhm and Z Fwhm

    meteor_read_intensity
    Usage: meteor_read_intensity(dev)


Filename: ccdbpm.mac
Author: BLISS (L.Claustre) / ESRF 2004
Last mod.: 26/06/2017 16:34 by witsch