esrf

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

camera.mac
See other macros in category: Detection Obsolete
Description:
    General features for images acquisition. OBSOLETE: use ccd.mac instead
Documentation:
    WARNING
    A different file, called also camera.mac exists in local/spec/macros at MX beamlines

    DESCRIPTION
    Controls a camera in different ways described below. More particularly, those macros allow images taking during standard scans, handle images saving to files and are able to start the EXPG Image Display program.

    SETUP
    SPEC config must declare:
    CCD-like device type used.


    ATTENTION
    File names are like:
    prefix001_002_003
    when saved from scans
    001 is the camera run number never incremented when scanning.
    002 is the scan number during which the image was taken.
    003 the scan point number at which the image was taken.
    prefix001
    in other cases
    001 is the camera run number incremented at each saving.

    ATTENTION


    DEPENDENCIES
      - The file camera.mac has to be read in 
    


Macros:
    camsetup
    Usage: camsetup [file_prefix] [start_exposure_macro] [stop_exposure_macro]
    Set up macros to work with a given camera. [start_exposure_macro] and [stop_exposure_macro] must be defined separately. The file prefix serves to build a name like described above.

    camnewfile
    Usage: camnewfile
    Sets a new file prefix and initialises the run number.

    camsave
    Usage: camsave
    Saves an image to disk. The file name is automatically processed out of the setup prefix and the run number.

    camtake
    Usage: camtake [exposure_time]
    Does an acquisition using SPEC configured timer for gating the exposure.

    camon
    Usage: camon
    Hook camera commands to standard scans commands.

    camoff
    Usage: camoff
    Get camera commands out of standard scans.

    camlive
    Usage: camlive <exposure_time>
    Unfold acquisitions using SPEC configured timer for gating the exposure. Exit with control-C.

    camsum
    Usage: camsum <exposure_time> <no>
    Takes and sums the specified number of images. Saves the resulting image to disk.

    camroi
    Usage: camroi <flag - use roi> <xmin> <xmax> <ymin> <ymax>
    Defines a roi.

Internal Macros:
    cam_define
    Usage: cam_define (file_prefix,start_exposure_macro,stop_exposure_macro)
    Set up macro and variables.

    cam_takesave
    Usage: cam_takesave
    Reads in an image and save it to disk.
    Hooked to measure1.

    cam_save
    Usage: cam_save (file_name,image_array)
    Saves an image to the specified file.

    camera_online
    Usage: camera_online
    Checks wether the Image Display X program is running, and starts it if need it.

    cam_display
    Usage: cam_display()
    Starts the Image Display X program.

    camera_expose
    Usage: camera_expose <exposure_time>
    Starts the SPEC configured timer with the exposure time value.

Filename: camera.mac
Author: CAMERA.MAC - ICNTL - 96/03/27
Last mod.: 18/02/2008 13:23 by rey