Introduction

In this note we describe the PyCSPadImage python-package which is intended to convert the CSPad raw data from HDF5 file to the geometry-corrected 2-D image array. This package can be used in a stand-alone python code.

Package PyCSPadImage

Content

The python-based PyCSPadImage package consists of modules (in alphabetic order):

• CSPadConfigPars.py - provides access to the CSPad configuration parameters
• CSPadImageProducer.py - receives raw CSPad data 3-D (32, 185, 388) array, uses calibration parameters, produces the 2-D image array
• CalibPars.py - provides access to the CSPad calibration parameters
• CalibParsDefault.py - defines the default CSPad calibration parameters
• Examples.py - contains examples of how to get the CSPad 2-D image array with corrected geometry
• GlobalGraphics.py - a set of useful methods for interactive graphic
• GlobalMethods.py - a set of miscellaneous global modules
• HDF5Methods.py - a set of methods to work with HDF5 files

Functionality

The PyCSPadImage package is intended to convert the CSPad raw data from HDF5 file to the geometry-corrected 2-D image array. Methods of this package provide basic functionality as follows.

• Raw data 3-D (32, 185, 388) array can be be obtained from HDF5 file by its record name using methods from the module HDF5Methods.py. The CSPad dynamic configuration parameters are also uploaded using methods from the class CSPadConfigPars.

• Access to the CSPad geometry calibration parameters are provided by the methods of the classes CalibParsDefault and CalibPars. It is assumed that the geometry calibration files, are available (see CSPad alignment) and located in the user-specified directory.

• Methods of the class CSPadImageProducer allows to get the geometry-corrected CSPad image or its part for specified 2x1 or quad.

How to get this package

Below we assume that all standard environment variable settings are done (otherwise see Analysis Workbook. Account Setup). In order to copy the PyCSPadImage package from SVN repository and run a simple test one has to use commands:

 
log in to psana<XXXX>
kinit
cd <your-favorite-directory>

newrel ana-current <your-release-directory-name>
cd <your-release-directory-name>
sit_setup
addpkg PyCSPadImage HEAD

cd PyCSPadImage/src/          <==== All source-code files are located here
python Examples.py

Example

Module Examples.py demonstrates how to use the PyCSPadImage package. The essential part of the example can be presented as:

 
import sys
import os
import CalibPars          as calp
import CSPadConfigPars    as ccp
import CSPadImageProducer as cip
import GlobalGraphics     as gg # For test purpose in main only
import HDF5Methods        as hm # For test purpose in main only
#----------------------------------------------
def main_example_xpp() :

    print 'Start test in main_example_xpp()'

    path_calib = '/reg/d/psdm/xpp/xpp47712/calib/CsPad::CalibV1/XppGon.0:Cspad.0'
    fname      = '/reg/d/psdm/xpp/xpp47712/hdf5/xpp47712-r0043.h5'
    dsname     = '/Configure:0000/Run:0000/CalibCycle:0000/CsPad::ElementV2/XppGon.0:Cspad.0/data'
    event      = 0

    print 'Load calibration parameters from', path_calib 
    calp.calibpars.setCalibParsForPath ( run  = 1, path = path_calib )

    print 'Get raw CSPad event %d from file %s \ndataset %s' % (event, fname, dsname)
    ds1ev = hm.getOneCSPadEventForTest( fname, dsname, event )
    print 'ds1ev.shape = ',ds1ev.shape

    print 'Make the CSPad image from raw array'
    cspadimg = cip.CSPadImageProducer()
    arr = cspadimg.getImageArrayForCSPadElement( ds1ev )

    print 'Plot CSPad image'
    gg.plotImage(arr,range=(0,2000),figsize=(11.6,10))
    gg.move(200,100)
    gg.plotSpectrum(arr,range=(0,2000))
    gg.move(50,50)
    print 'To EXIT the test click on "x" in the top-right corner of each plot window.'
    gg.show()

Let us consider in detail what needs to be done in order to produce the CSPad image.

First, all necessary modules need to be imported:

 
import CalibPars          as calp
import CSPadConfigPars    as ccp
import CSPadImageProducer as cip
import GlobalGraphics     as gg # For test purpose in main only
import HDF5Methods        as hm # For test purpose in main only

Then, the path to the calibration data types, the HDF5 data file name, and the dataset name in HDF5 structure need to be defined:

 
    path_calib = '/reg/d/psdm/xpp/xpp47712/calib/CsPad::CalibV1/XppGon.0:Cspad.0'
    fname      = '/reg/d/psdm/xpp/xpp47712/hdf5/xpp47712-r0043.h5'
    dsname     = '/Configure:0000/Run:0000/CalibCycle:0000/CsPad::ElementV2/XppGon.0:Cspad.0/data'

Then, calibration parameters need to be loaded:

 
    calp.calibpars.setCalibParsForPath ( run  = 1, path = path_calib )

Then, the raw CSPad dataset needs to be extracted:

 
    ds1ev = hm.getOneCSPadEventForTest( fname, dsname, event )

Finally the 2-D image array can be obtained

 
    cspadimg = cip.CSPadImageProducer()
    arr = cspadimg.getImageArrayForCSPadElement( ds1ev )

and used, for example for plotting

 
    gg.plotImage(arr,range=(0,2000),figsize=(11.6,10))
    gg.plotSpectrum(arr,range=(0,2000))
    gg.show()

References

• CSPad alignment
• Psana CSPad Geometry
• Package CSPadPixCoords for Psana