Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • A few configuration parameters are common to all modules, and their default values are set to be the same, but can also be set differentlyindividually for each module.
    Code Block
    none
    none
    # parameter name   default value   comment
      plot_every_n      = 10          # If 0, don't plot till the end of the job. Else, display every N events
      fignum            = 1           # "base" number for matplotlib figure numbering scheme
    
  • pyana_plotter: This module is added to the end of the job, after other modules. It does nothing (yet) than control the display mode. Default is SlideShow mode.
    Code Block
    none
    none
      display_mode = 2    #= 2           #  Interactive (1) or SlideShow (2) or NoDisplay (0)
    
    pyana_scan: This module is
    )
      ipython           = False       #  Drop into ipython after each plot (to allow further investigation of data)
    
  • pyana_bld
    Code Block
    none
    none
    
     do_ebeam           = False       #  Plot data from EBeam object
     do_gasdetector     = False       #  Plot data from GasDetector
     do_phasecavity     = False       #  Plot data from PhaseCavity
     do_ipimb     
    different from the others. It does a "motor scan", displays certain values as a function of scan step of a motor scan. The motor name is given in the xtc file as the Control PV. There may be more than one control PV. It currently takes two scalar type inputs to evaluate the scan:
    Code Block
    
    input_epics         # Name(s) of other scalars to correlate in scan
    input_scalars      = # Name(s) of other scalars to correlate in scan
    False       #  Plot data from SharedIpimb
    
    Image Added Image Added Beam energy and position. Gas detector energy measurements
  • Image Removed pyana_waveform: Plots waveform data from Acqiris digitizers. Takes a list of addresses, currently will make one plot for each channel of each device. To run this module by itself with pyana:
    Code Block
    none
    none
     pyana -m XtcExplorer/src/pyana_waveform.py <xtc files>
    
    Configurable options:
    Code Block
    none
    none
      sources           =             # string, space-separated list of addresses (Detector-Id|Device-ID)
    
  • pyana_cspad: CsPad data is reconstructed in pyana_cspad.py. The image plot value limits are adjusted automatically, but if
    you want to change them, click on the color bar (left-click for low limit, right-click for high limit).
    The successive events will be plotted with the new limits. Revert to the original by middle-clicking.
    To run this module by itself with pyana:
    Code Block
     pyana -m XtcExplorer/src/pyana_cspad.py <xtc files>
    
    Options must be specified in a configuration file, or the default values will be used, e.g.:
    Code Block
      image_source      =             # string, Address of Detector-Id|Device-ID
    dark_img_file  dark_img_file     =             # filename, Dark image file to be loaded, if any
    output  out_img_file      =             # filename (If collecting: write the average image to this file)
      plot_vrange       =             # range=vmin-vmax of values for plotting (pixel intensity)
    threshold
      threshold         =             # lower threshold for image intensity in threshold area of the plot
      thr_area          =             # range=xmin,xmax,ymin,ymax defining threshold area
    

    Image display of the CSPad detector, background subtracted. This is currently the only display that has interactive features. A filter allows you to select events within requested intensity range.

...

  • pyana_epics
    Code Block
    pv                  # Name(s) of the EPICS PV(s) to dump
    
    pyana_bld
    (s) of the EPICS PV(s) to dump
    
  • pyana_scan: This module is different from the others. It does a "motor scan", displays certain values as a function of scan step of a motor scan. The motor name is given in the xtc file as the Control PV. There may be more than one control PV. It currently takes two scalar type inputs to evaluate the scan:
    Code Block
    
    input_epics
    Code Block
    
     do_ebeam            # Plot data from EBeam object
     do_gasdetector  Name(s) of other scalars to correlate in scan
    input_scalars    # Plot data from GasDetector
     do_phasecavity      # Plot data from PhaseCavity
    
    Image Removed Image Removed Beam energy and position. Gas detector energy measurements
    # Name(s) of other scalars to correlate in scan
    
    Image Added

xtcscanner

This tool also belongs to the XtcExplorer package, and is used by the GUI. But the tool can also be run directly from the command line:

...