PSCalib::CalibParsStore Class Reference
[PSCalib package]

class CalibParsStore has a static factory method Create for CalibPars More...

#include <CalibParsStore.h>

List of all members.

Static Public Member Functions
static PSCalib::CalibPars *	Create (const std::string &calibdir, const std::string &group, const std::string &str_src, const unsigned long &runnum, unsigned print_bits=255)
	Regular constructor, which use const std::string& str_src.
static PSCalib::CalibPars *	Create (const std::string &calibdir, const std::string &group, const Pds::Src &src, const unsigned long &runnum, unsigned print_bits=255)
	Regular constructor, which use Pds::Src& src.

---

Detailed Description

class CalibParsStore has a static factory method Create for CalibPars

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

Version:

Id

CalibParsStore.h 12199 2016-07-01 01:04:24Z dubrovin@SLAC.STANFORD.EDU

Author:

Mikhail S. Dubrovin

See also:

CalibPars

Interface Description

• Includes

    #include "psana/Module.h" // for evt, env, get,  etc.
    #include "PSCalib/CalibPars.h"
    #include "PSCalib/CalibParsStore.h"
  

• Instatiation
  Here we assume that code is working inside psana module where evt and env variables are defined through input parameters of call-back methods. Code below instateates calibpars object using factory static method PSCalib::CalibParsStore::Create:

    std::string calib_dir = env.calibDir(); // or "/reg/d/psdm/<INS>/<experiment>/calib"
    std::string  group = std::string(); // or something like "PNCCD::CalibV1";
    const std::string source = "Camp.0:pnCCD.1";
    const std::string key = ""; // key for raw data
    Pds::Src src; env.get(source, key, &src);
    PSCalib::CalibPars* calibpars = PSCalib::CalibParsStore::Create(calib_dir, group, src, PSCalib::getRunNumber(evt));
  

• Access methods

    calibpars->printCalibPars();
    const PSCalib::CalibPars::pedestals_t*    peds_data = calibpars->pedestals();
    const PSCalib::CalibPars::pixel_gain_t*   gain_data = calibpars->pixel_gain();
    const PSCalib::CalibPars::pixel_mask_t*   mask_data = calibpars->pixel_mask();
    const PSCalib::CalibPars::pixel_bkgd_t*   bkgd_data = calibpars->pixel_bkgd();
    const PSCalib::CalibPars::pixel_rms_t*    rms_data  = calibpars->pixel_rms();
    const PSCalib::CalibPars::pixel_status_t* stat_data = calibpars->pixel_status();
    const PSCalib::CalibPars::common_mode_t*  cmod_data = calibpars->common_mode();
  

Definition at line 112 of file CalibParsStore.h.

---

Member Function Documentation

static PSCalib::CalibPars* PSCalib::CalibParsStore::Create	(	const std::string &	calibdir,
		const std::string &	group,
		const Pds::Src &	src,
		const unsigned long &	runnum,
		unsigned	print_bits = 255
	)			[inline, static]

Regular constructor, which use Pds::Src& src.

Parameters:

[in]	calibdir	Calibration directory for current experiment.
[in]	group	Data type and group names.
[in]	src	The data source object, for example Pds::Src m_src; defined in the env.get(...,&m_src)
[in]	runnum	Run number to search the valid file name.
[in]	print_bits	Print control bit-word.

Definition at line 253 of file CalibParsStore.h.

References Create().

static PSCalib::CalibPars* PSCalib::CalibParsStore::Create	(	const std::string &	calibdir,
		const std::string &	group,
		const std::string &	str_src,
		const unsigned long &	runnum,
		unsigned	print_bits = 255
	)			[inline, static]

Regular constructor, which use const std::string& str_src.

Parameters:

[in]	calibdir	Calibration directory for current experiment.
[in]	group	Data type and group names.
[in]	str_src	The data source name, ex.: Camp.0:pnCCD.0
[in]	runnum	Run number to search the valid file name.
[in]	print_bits	Print control bit-word.

Definition at line 129 of file CalibParsStore.h.

References GeometryAccess::msg.

Referenced by Create().

---

The documentation for this class was generated from the following file:

• PSCalib/include/CalibParsStore.h

---