This note describes raw intensity correction algorithms in the method Detector.calib and their variation on detector type.

det.calib algorithms

arr = det.calib(evt, cmpars=None, **kwargs)

pedestals subtraction from calib/.../pedestals
common mode correction depending on cmpars or calib/.../common_mode or default from PSCalib.CalibParsBase*V1.py
gain correction with gain factors from calib/.../pixel_gain
apply mask depending on **kwargs
regular formula: (common_mode(raw - peds))/gain * mask(**kwargs)

for all detectors excluding epix10ka and Jungfrau parameter mbits is deprecated, use **kwargs and algorithms from method mask_v2 from AreaDetector.

Spreadsheet below contains comments on detector specific application

Detector type	pedestal subtraction	common mode correction	gain	mask	formula	comments
LCLS (1)
CSPAD	+	default cmpars = (1, 25, 25, 100)	*gainmask det.set_gain_mask_factor(gfactor=6.85)	+		gain map extracted from detector configuration data and applied with gfactor gainmask is applied before regular gain factor
CSPAD2x2	+	shape=(185, 388, 2) → (2, 185, 388) default cmpars = (1, 25, 25, 100)	+			shape is converted before common mode correction in order to apply regular CSPAD algorithm
epix100a	+	default cmpars =(4,6,30,30)
pnCCD	+	default cmpars =(3, 350, 350, 128)
Andor3d		default cmpars =(2,10,10,cols)
Princeton		default cmpars =(1,50,50,100,1,size,1)
Camera		other Cameras default cmpars = cmpars = (0,0,0,0,) `- OFF`
epix10ka		`applied for pixels in high gain mode only in combination with mask` `cmpars=None - default (7,2,10,10)` `(*,0,...) - OFF`	pixel_gain constants are used and per event depending on gain range		(common_mode(raw - peds)/gain * mask	UtilsEpix10ka.calib_epix10ka_any(det, evt, cmpars=None, **kwa) offsets are already accounted at deployment of pedestals in calib/.../pedestals
Jungfrau		applied for pixels in high gain mode only in combination with mask `cmpars=None: default cmpars = (7,1,100,0)` `(*,0,...) - OFF`	pixel_gain and pixel_offset are used and per event depend on gain range		(common_mode(raw - peds - offset))/gain * mask	UtilsJungfrau.calib_jungfrau(det, evt, cmpars=(7,3,200,10), **kwa)

LCLS-II

Method det.calib algorithms