PSCalib::GenericCalibPars< TBASE > Class Template Reference
[PSCalib package]

GenericCalibPars class loads/holds/provides access to the pnCCD geometry calibration parameters. More...

#include <GenericCalibPars.h>

Inheritance diagram for PSCalib::GenericCalibPars< TBASE >:


Public Types
typedef PSCalib::CalibPars::shape_t	shape_t
Public Member Functions
	GenericCalibPars (const std::string &calibDir, const std::string &groupName, const std::string &source, const unsigned long &runNumber, unsigned print_bits=255)
	Constructor, which use string& source.
	GenericCalibPars (const std::string &calibDir, const std::string &groupName, const Pds::Src &src, const unsigned long &runNumber, unsigned print_bits=255)
	Constructor, which use Pds::Src& src.
virtual	~GenericCalibPars ()
virtual const size_t	ndim (const CALIB_TYPE &calibtype=PEDESTALS)
	INTERFACE METHODS.
virtual const size_t	size (const CALIB_TYPE &calibtype=PEDESTALS)
	Returns size (number of elements) in calibration type.
virtual const shape_t *	shape (const CALIB_TYPE &calibtype=PEDESTALS)
	Returns shape of the ndarray with calibration parameters.
virtual const int	status (const CALIB_TYPE &calibtype)
	Returns status of the ndarray with calibration parameters.
virtual const CalibPars::pedestals_t *	pedestals ()
	Returns the pointer to array with pedestals.
virtual const CalibPars::pixel_gain_t *	pixel_gain ()
	Returns the pointer to array with pixel_gain.
virtual const CalibPars::pixel_mask_t *	pixel_mask ()
	Returns the pointer to array with pixel_mask.
virtual const CalibPars::pixel_bkgd_t *	pixel_bkgd ()
	Returns the pointer to array with pixel_mask.
virtual const CalibPars::pixel_rms_t *	pixel_rms ()
	Returns the pointer to array with pixel_gain.
virtual const CalibPars::pixel_status_t *	pixel_status ()
	Returns the pointer to array with pixel_status.
virtual const CalibPars::common_mode_t *	common_mode ()
	Returns the pointer to array with common_mode.
virtual void	printCalibPars ()
	Partial print of all types of calibration parameters.
const size_t	size_of_ndarray ()
	ADDITIONAL METHODS.
const shape_t *	shape_of_ndarray ()
void	printInputPars ()
void	printCalibParsStatus ()
std::string	str_shape ()

Detailed Description

template<typename TBASE>
class PSCalib::GenericCalibPars< TBASE >

GenericCalibPars class loads/holds/provides access to the pnCCD geometry calibration parameters.

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

See also:: CalibPars, CalibParsStore

Version:

Id: GenericCalibPars.h 10156 2015-05-23 00:00:36Z dubrovin@SLAC.STANFORD.EDU

Author:: Mikhail S. Dubrovin

Interface Description

Include and typedef

  #include "PSCalib/GenericCalibPars.h"

  #include "pdscalibdata/CsPadBaseV2.h"
  #include "pdscalibdata/CsPad2x2BaseV2.h"
  #include "pdscalibdata/PnccdBaseV1.h"
  #include "pdscalibdata/PrincetonBaseV1.h"
  #include "pdscalibdata/AndorBaseV1.h"
  #include "pdscalibdata/Opal1000BaseV1.h"
  #include "pdscalibdata/Opal4000BaseV1.h"
  ...

  typedef PSCalib::GenericCalibPars<pdscalibdata::PnccdBaseV2>  CALIB;
  typedef PSCalib::GenericCalibPars<pdscalibdata::...BaseV2> ...CALIB;
  ...

Instatiation
For default constructor:

  CALIB *calibpars = new CALIB();

For regular constructor:

  const std::string calibDir   = "/reg/d/psdm/AMO/amoa1214/calib";
  const std::string groupName  = "PNCCD::CalibV1";
  const std::string source     = "Camp.0:pnCCD.1";
  unsigned long     runNumber  = 10;
  unsigned          print_bits = 255;
  Pds::Src src; env.get(source, key, &src);
  CALIB *calibpars = new CALIB(calibDir, groupName, src, runNumber, print_bits);

or similar for explicit constructor (depricated):

  CALIB *calibpars = new CALIB(calibDir, groupName, source, runNumber, print_bits);

or for the same list of parameters using polymorphism:

  PSCalib::CalibPars *calibpars = new CALIB(calibDir, groupName, source, runNumber, print_bits);

In this case all virtual methods defined in the base class PSCalib::CalibPars will be accessible through the calibpars pointer.

Printing methods

  calibpars -> printInputPars();
  calibpars -> printCalibPars();
  calibpars -> printCalibParsStatus();

Access methods

  const size_t    ndim = calibpars -> ndim();
  const size_t    size = calibpars -> size();
  const unsigned* p_shape = calibpars -> shape();
  const CalibPars::pedestals_t*    p_pedestals   = calibpars -> pedestals()
  const CalibPars::common_mode_t*  p_common_mode = calibpars -> common_mode()
  const CalibPars::pixel_status_t* p_pixel_stat  = calibpars -> pixel_status()
  const CalibPars::pixel_gain_t*   p_pixel_gain  = calibpars -> pixel_gain()
  const CalibPars::pixel_mask_t*   p_pixel_mask  = calibpars -> pixel_mask()
  const CalibPars::pixel_bkgd_t*   p_pixel_bkgd  = calibpars -> pixel_bkgd()
  const CalibPars::pixel_rms_t*    p_pixel_rms   = calibpars -> pixel_rms()
  ... etc. for all other access methods

See also:: CalibFileFinder

Definition at line 136 of file GenericCalibPars.h.

Member Typedef Documentation

template<typename TBASE>

typedef PSCalib::CalibPars::shape_t PSCalib::GenericCalibPars< TBASE >::shape_t

Reimplemented from PSCalib::CalibPars.

Definition at line 141 of file GenericCalibPars.h.

Constructor & Destructor Documentation

template<typename TBASE>

PSCalib::GenericCalibPars< TBASE >::GenericCalibPars	(	const std::string &	calibDir,
		const std::string &	groupName,
		const std::string &	source,
		const unsigned long &	runNumber,
		unsigned	print_bits = `255`
	)

Constructor, which use string& source.

Parameters:

`[in]`	calibDir	Calibration directory for current experiment.
`[in]`	groupName	Data type and group names.
`[in]`	source	The name of the data source.
`[in]`	runNumber	Run number to search the valid file name.
`[in]`	print_bits	=0-print no messages; +1-input parameters, +2-print msges from PSCalib::CalibFileFinder, +4-use default, +8-missing type

Definition at line 60 of file GenericCalibPars.cpp.

template<typename TBASE>

PSCalib::GenericCalibPars< TBASE >::GenericCalibPars	(	const std::string &	calibDir,
		const std::string &	groupName,
		const Pds::Src &	src,
		const unsigned long &	runNumber,
		unsigned	print_bits = `255`
	)

Constructor, which use Pds::Src& src.

Parameters:

`[in]`	calibDir	Calibration directory for current experiment.
`[in]`	groupName	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]`	runNumber	Run number to search the valid file name.
`[in]`	print_bits	=0-print no messages; +1-input parameters, +2-print msges from PSCalib::CalibFileFinder, +4-use default, +8-missing type

Definition at line 79 of file GenericCalibPars.cpp.

template<typename TBASE>

PSCalib::GenericCalibPars< TBASE >::~GenericCalibPars ( ) [virtual]

Definition at line 464 of file GenericCalibPars.cpp.

Member Function Documentation

template<typename TBASE>

const CalibPars::common_mode_t * PSCalib::GenericCalibPars< TBASE >::common_mode ( ) [virtual]

Returns the pointer to array with common_mode.

Reimplemented from PSCalib::CalibPars.

Definition at line 243 of file GenericCalibPars.cpp.

References PSCalib::COMMON_MODE, and pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray().

Referenced by main().

template<typename TBASE>

const size_t PSCalib::GenericCalibPars< TBASE >::ndim ( const CALIB_TYPE & calibtype = PEDESTALS ) [virtual]

INTERFACE METHODS.

Reimplemented from PSCalib::CalibPars.

Definition at line 258 of file GenericCalibPars.cpp.

References PSCalib::COMMON_MODE.

template<typename TBASE>

const CalibPars::pedestals_t * PSCalib::GenericCalibPars< TBASE >::pedestals ( ) [virtual]

Returns the pointer to array with pedestals.

Reimplemented from PSCalib::CalibPars.

Definition at line 147 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), PSCalib::PEDESTALS, PSCalib::GenericCalibPars< TBASE >::shape(), and PSCalib::GenericCalibPars< TBASE >::size().

Referenced by main(), PSCalib::GenericCalibPars< TBASE >::shape_of_ndarray(), and PSCalib::GenericCalibPars< TBASE >::size_of_ndarray().

template<typename TBASE>

const CalibPars::pixel_bkgd_t * PSCalib::GenericCalibPars< TBASE >::pixel_bkgd ( ) [virtual]

Returns the pointer to array with pixel_mask.

Reimplemented from PSCalib::CalibPars.

Definition at line 213 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), PSCalib::PIXEL_BKGD, PSCalib::GenericCalibPars< TBASE >::shape(), and PSCalib::GenericCalibPars< TBASE >::size().

template<typename TBASE>

const CalibPars::pixel_gain_t * PSCalib::GenericCalibPars< TBASE >::pixel_gain ( ) [virtual]

Returns the pointer to array with pixel_gain.

Reimplemented from PSCalib::CalibPars.

Definition at line 183 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), PSCalib::PIXEL_GAIN, PSCalib::GenericCalibPars< TBASE >::shape(), and PSCalib::GenericCalibPars< TBASE >::size().

Referenced by main().

template<typename TBASE>

const CalibPars::pixel_mask_t * PSCalib::GenericCalibPars< TBASE >::pixel_mask ( ) [virtual]

Returns the pointer to array with pixel_mask.

Reimplemented from PSCalib::CalibPars.

Definition at line 198 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), PSCalib::PIXEL_MASK, PSCalib::GenericCalibPars< TBASE >::shape(), and PSCalib::GenericCalibPars< TBASE >::size().

template<typename TBASE>

const CalibPars::pixel_rms_t * PSCalib::GenericCalibPars< TBASE >::pixel_rms ( ) [virtual]

Returns the pointer to array with pixel_gain.

Reimplemented from PSCalib::CalibPars.

Definition at line 228 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), PSCalib::PIXEL_RMS, PSCalib::GenericCalibPars< TBASE >::shape(), and PSCalib::GenericCalibPars< TBASE >::size().

Referenced by main().

template<typename TBASE>

const CalibPars::pixel_status_t * PSCalib::GenericCalibPars< TBASE >::pixel_status ( ) [virtual]

Returns the pointer to array with pixel_status.

Reimplemented from PSCalib::CalibPars.

Definition at line 165 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), PSCalib::PIXEL_STATUS, PSCalib::GenericCalibPars< TBASE >::shape(), and PSCalib::GenericCalibPars< TBASE >::size().

Referenced by main().

template<typename TBASE>

void PSCalib::GenericCalibPars< TBASE >::printCalibPars ( ) [virtual]

Partial print of all types of calibration parameters.

Reimplemented from PSCalib::CalibPars.

Definition at line 440 of file GenericCalibPars.cpp.

References PSCalib::GenericCalibPars< TBASE >::printCalibParsStatus(), PSCalib::GenericCalibPars< TBASE >::printInputPars(), and PSCalib::GenericCalibPars< TBASE >::str_shape().

template<typename TBASE>

void PSCalib::GenericCalibPars< TBASE >::printCalibParsStatus ( )

Definition at line 422 of file GenericCalibPars.cpp.

Referenced by PSCalib::GenericCalibPars< TBASE >::printCalibPars().

template<typename TBASE>

void PSCalib::GenericCalibPars< TBASE >::printInputPars ( )

Definition at line 371 of file GenericCalibPars.cpp.

References PSCalib::GenericCalibPars< TBASE >::str_shape().

Referenced by main(), and PSCalib::GenericCalibPars< TBASE >::printCalibPars().

template<typename TBASE>

const CalibPars::shape_t * PSCalib::GenericCalibPars< TBASE >::shape ( const CALIB_TYPE & calibtype = PEDESTALS ) [virtual]

Returns shape of the ndarray with calibration parameters.

Reimplemented from PSCalib::CalibPars.

Definition at line 281 of file GenericCalibPars.cpp.

References PSCalib::COMMON_MODE, and PSCalib::GenericCalibPars< TBASE >::shape_of_ndarray().

Referenced by PSCalib::GenericCalibPars< TBASE >::pedestals(), PSCalib::GenericCalibPars< TBASE >::pixel_bkgd(), PSCalib::GenericCalibPars< TBASE >::pixel_gain(), PSCalib::GenericCalibPars< TBASE >::pixel_mask(), PSCalib::GenericCalibPars< TBASE >::pixel_rms(), PSCalib::GenericCalibPars< TBASE >::pixel_status(), and PSCalib::GenericCalibPars< TBASE >::str_shape().

template<typename TBASE>

const CalibPars::shape_t * PSCalib::GenericCalibPars< TBASE >::shape_of_ndarray ( )

Definition at line 348 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), and PSCalib::GenericCalibPars< TBASE >::pedestals().

Referenced by PSCalib::GenericCalibPars< TBASE >::shape().

template<typename TBASE>

const size_t PSCalib::GenericCalibPars< TBASE >::size ( const CALIB_TYPE & calibtype = PEDESTALS ) [virtual]

Returns size (number of elements) in calibration type.

Reimplemented from PSCalib::CalibPars.

Definition at line 267 of file GenericCalibPars.cpp.

References PSCalib::COMMON_MODE, and PSCalib::GenericCalibPars< TBASE >::size_of_ndarray().

Referenced by PSCalib::GenericCalibPars< TBASE >::pedestals(), PSCalib::GenericCalibPars< TBASE >::pixel_bkgd(), PSCalib::GenericCalibPars< TBASE >::pixel_gain(), PSCalib::GenericCalibPars< TBASE >::pixel_mask(), PSCalib::GenericCalibPars< TBASE >::pixel_rms(), and PSCalib::GenericCalibPars< TBASE >::pixel_status().

template<typename TBASE>

const size_t PSCalib::GenericCalibPars< TBASE >::size_of_ndarray ( )

ADDITIONAL METHODS.

Definition at line 326 of file GenericCalibPars.cpp.

References pdscalibdata::NDArrIOV1< TDATA, NDIM >::get_ndarray(), and PSCalib::GenericCalibPars< TBASE >::pedestals().

Referenced by PSCalib::GenericCalibPars< TBASE >::size().

template<typename TBASE>

const int PSCalib::GenericCalibPars< TBASE >::status ( const CALIB_TYPE & calibtype ) [virtual]

Returns status of the ndarray with calibration parameters.

Reimplemented from PSCalib::CalibPars.

Definition at line 304 of file GenericCalibPars.cpp.

References PSCalib::COMMON_MODE, PSCalib::PEDESTALS, PSCalib::PIXEL_BKGD, PSCalib::PIXEL_GAIN, PSCalib::PIXEL_MASK, PSCalib::PIXEL_RMS, and PSCalib::PIXEL_STATUS.

template<typename TBASE>

std::string PSCalib::GenericCalibPars< TBASE >::str_shape ( )

Definition at line 393 of file GenericCalibPars.cpp.

References PSCalib::GenericCalibPars< TBASE >::shape().

Referenced by PSCalib::GenericCalibPars< TBASE >::printCalibPars(), and PSCalib::GenericCalibPars< TBASE >::printInputPars().

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

PSCalib/include/GenericCalibPars.h
PSCalib/src/GenericCalibPars.cpp

Generated on 19 Dec 2016 for PSANAmodules by

1.4.7

PSCalib::GenericCalibPars< TBASE > Class Template Reference [PSCalib package]

Public Types

Public Member Functions

Detailed Description

template<typename TBASE> class PSCalib::GenericCalibPars< TBASE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

PSCalib::GenericCalibPars< TBASE > Class Template Reference
[PSCalib package]

template<typename TBASE>
class PSCalib::GenericCalibPars< TBASE >