...

This note explains organization and content of the calibration store, tools for maintenance,  application of corrections in psana, access in code to calibration parameters, and relevant references to other confluence documents.

Location

Directory containing calibration files is located at the same level as directories with data xtc or hdf5 files:

<PATH>/reg/d/psdm/<INSTRUMENT>/<experiment>/xtc
<PATH>/reg<INSTRUMENT>/d<experiment>/psdmhdf5
<PATH>/<INSTRUMENT>/<experiment>/hdf5
calib

where <PATH> depends on computer farm:

...

Full path to the calibration file consists of a few sub-directories under the calib directory, representing functional logical layers:

/reg/d/psdm/<PATH>/<INSTRUMENT>/<experiment>/calib/<calib-version>/<data-source>/<type>/<file>

...

• <calib-version> - is a directory reserved for different versions of calibration software. For each detector type it is defined through the dictionary.
• <data-source> - actual source of data. Each detector has an unique name in DAQ, which also includes its position. For example: CxiDs1.0:Cspad.0, CxiDg1.0:Tm6740.0, CxiEndstation.0:Opal2000.1, etc.
• <type>- type of calibration files: 
  • pedestals,
  • pixel_rms,
  • pixel_status,
  • pixel_mask,
  • pixel_gain,
  • pixel_bkgd,
  • common_mode,
  • filter,
  • geometry, etc.
  • (center, tilt, marg_gap_shift, etc. are deprecated types).
• <file> - calibration file name consisting of the validity run range and extension .data. For example: 3-15.data, 1-end.data, 7-end.data, etc.

Example:

/reg/d/psdm/<PATH>/CXI/cxi12315/calib/CsPad::CalibV1/CxiDs1.0:Cspad.0/pedestals/1-end.data
<PATH>/reg/d/psdm/CXI/cxi12315/calib/CsPad2x2::CalibV1/CxiSc2.0:Cspad2x2.0/geometry/5-end.data
/reg/d/psdm/ <PATH>/AMO/amo12313/calib/PNCCD::CalibV1/Camp.0:pnCCD.1/pixel_status/8-22.data

...

Tools

Calibration management tool

...

• Detector Calibration Store
• DEPRECATED - IT WAS NEVER IMPLEMENTED: Calibration Store for LCLS2
• Calibration Management Tool
• Detector Geometry
• CSPAD Alignment
• CSPAD2x2 Alignment
• psana - Module Catalog

...