Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
    1. @param release:title=ana-0.10.0|type=string|required=true|desc=Software release

Content

Table of Contents

...

Package PSCalib

Package PSCalib provides an access to the calibration parameters.
For complete reference select Doxygen documentation.

Class CalibFileFinder

Detailed description in Doxygen

CalibFileFinder class finds the path to calibration file. Class constructor creates the object with elements of the path to the calibration file. When all input parameters are provided, the method findCalibFile(...) returns the path/name to the file with requested type of calibration parameters for indicated run number.

Class CSPadCalibPars

Detailed description in Doxygen

CSPadCalibPars class loads/holds/provides access to the CSPad geometry calibration parameters. Class constructor creates an object which loads and holds the calibration parameters of all CSPad geometry types. Access methods allows to extract any of requested parameters.
The CSPad geometry types are defined in the package pdscalibdata by the classes

...

Calibration files location and structure is explained in CsPad calibration in translator.

Class CSPad2x2CalibPars

Detailed description in Doxygen

CSPad2x2CalibPars class loads/holds/provides access to the CSPad2x2 geometry calibration parameters. Class constructor creates an object which loads and holds the calibration parameters of all CSPad2x2 geometry types. Access methods allows to extract any of requested parameters.
The CSPad2x2 geometry types are defined in the package pdscalibdata by the classes

...

Package CSPadPixCoords pre-calculates the 2x1 section, quad, and CSPad pixel coordinates. CSPad image is also produced in combination of the pixel coordinates with event data.
For complete reference select Doxygen documentation.

Class Image2D

Detailed description in Doxygen
Image2D class creates the object with a pointer to the 2D array and its sizes. It is assumed that the 2D array contains image data. Methods of this class provide access to the 2D array and its transformed versions after up-down, left-right flips, transpose, and rotations by n*90 degree.

GlobalMethods

Detailed description in Doxygen

CSPadConfigPars

Detailed description in Doxygen

Class QuadParameters

QuadParameters class object contains current parameters of the CSPad quad.

...

PixCoords2x1 class defines the 2x1 section pixel coordinates in its local frame. Class constructor calculates the X, Y, and Z pixel coordinates for single 2x1 in its own (matrix style) frame; X coordinate is directed along ascending row index from 0 to 388 (from top to botton for 0 rotation angle), Y coordinate is directed alond descending (ONLINE specific...) column index from 184 to 0 (from left to right for 0 rotation angle). The getPixCoorRot...(...) methods return these coordinates for rotated by N*90 degree 2x1 in um(micrometer) or pixels. Rows and columns are defined like described in ONLINE modules: /reg/g/psdm/sw/external/lusi-xtc/2.12.0a/x86_64-rhel5-gcc41-opt/pdsdata/cspad/ElementIterator.hh, Detector.hh
No parameters needed in constructor; everything is defined through the known 2x1 chip geometry.

Class PixCoords2x1V2

Detailed description in Doxygen

Class PixCoordsCSPad2x2

Detailed description in Doxygen

Class PixCoordsCSPad2x2V2

Detailed description in Doxygen

Class PixCoordsQuad

PixCoordsQuad class defines the quad pixel coordinates in its local frame. The coordinate frame coinsides with that of optical measurement, but in "matrix style" geometry:

...

PixCoordsCSPad class defines and provides access to the CSPad pixel coordinates. Class constructor fills the arrays of the CSPad pixel coordinates using the PixCoordsQuad class object and the calibration parameters extracted by the PSCalib package. Access methods return the CSPad pixel coordinate for indicated axis, quad, section, row, and column indexes. Pixel coordinates can be returned in um(micrometers), pix(pixels), or int(integer pixel index).

Class PixCoordsCSPadV2

Detailed description in Doxygen - supports calibration type center_global

...

Module CSPadNDArrProducer

Detailed description in Doxygen

Module CSPad2x2ImageProducer

Detailed description in Doxygen

Interface description

Classes for CSPAD

  • CSPadCalibPars - access to calibration parameters of types center, tilt, rotation, offeset, center_global, etc.
  • CSPadConfigPars - access to the run-time configuration parameters.
  • PixCoords2x1V2 - access to pixel coordinates of the 2x1 section.
  • PixCoordsCSPad - access to pixel coordinates of the CSPAD detector. It uses PixCoordsCSPadV2 if the calibration file for center_global is available.
  • PixCoordsCSPadV2 - supports pixel coordinates of the CSPAD detector for calibration type center_global.
  • CSPadImageProducer - PSANA module which produces image of the CSPAD detector and preserves it in the event (during run-time).
  • CSPadInterpolImageProducer - PSANA module which produces interpolated image of the CSPAD detector and preserves it in the event (during run-time).

Classes for CSPAD2x2

...