PSCalib::CSPad2x2CalibIntensity Class Reference
[PSCalib package]

CSPad2x2CalibIntensity class loads/holds/provides access to the CSPAD2x2 geometry calibration parameters. More...

#include <CSPad2x2CalibIntensity.h>

Inheritance diagram for PSCalib::CSPad2x2CalibIntensity:


Public Member Functions
	CSPad2x2CalibIntensity (bool isTestMode=false)
	Default and test constructor.
	CSPad2x2CalibIntensity (const std::string &calibDir, const std::string &typeGroupName, const std::string &source, const unsigned long &runNumber, unsigned print_bits=255)
	DEPRICATED constructor, which use string& source.
	CSPad2x2CalibIntensity (const std::string &calibDir, const std::string &typeGroupName, const Pds::Src &src, const unsigned long &runNumber, unsigned print_bits=255)
	Regular constructor, which use Pds::Src& src.
virtual	~CSPad2x2CalibIntensity ()
	Destructor.
void	fillCalibNameVector ()
	Makes member data vector with all supported calibration types such as center, tilt, ...
void	getCalibFileName ()
	Define the path to the calibration file based on input parameters.
void	loadCalibPars ()
	Load all known calibration parameters.
void	fillCalibParsV1 ()
	Fill calibration parameters from vector.
void	fillDefaultCalibParsV1 ()
	Fill default calibration parameters.
void	fatalMissingFileName ()
	Generate error message in the log and abort.
void	msgUseDefault ()
	Generate warning message in the log.
void	printCalibPars ()
	Prints calibration parameters.
void	printInputPars ()
	Prints input parameters of the object.
int	getCalibTypeStatus (const std::string &type)
	Returns status of the calibration constants, 0-default, 1-loaded from file.
virtual void	printCalibParsStatus ()
	Prints calibration parameters status.
virtual const size_t	ndim ()
virtual const size_t	size ()
virtual const unsigned *	shape ()
ndarray< CalibPars::pedestals_t, 3 >	pedestals_ndarr ()
	Returns ndarray of CSPAD2x2 pedestals.
virtual const CalibPars::pedestals_t *	pedestals ()
	Returns the pointer to array with pedestals.
ndarray< CalibPars::pixel_status_t, 3 >	pixel_status_ndarr ()
	Returns ndarray of CSPAD2x2 pixel status.
virtual const CalibPars::pixel_status_t *	pixel_status ()
	Returns the pointer to array with pixel_status.
ndarray< CalibPars::common_mode_t, 1 >	common_mode_ndarr ()
	Returns ndarray of CSPAD2x2 common mode.
virtual const CalibPars::common_mode_t *	common_mode ()
	Returns the pointer to array with common_mode.
ndarray< CalibPars::pixel_gain_t, 3 >	pixel_gain_ndarr ()
	Returns ndarray of CSPAD2x2 pixel gain.
virtual const CalibPars::pixel_gain_t *	pixel_gain ()
	Returns the pointer to array with pixel_gain.
ndarray< CalibPars::pixel_rms_t, 3 >	pixel_rms_ndarr ()
	Returns ndarray of CSPAD2x2 pixel rms.
virtual const CalibPars::pixel_rms_t *	pixel_rms ()
	Returns the pointer to array with pixel_gain.

Detailed Description

CSPad2x2CalibIntensity class loads/holds/provides access to the CSPAD2x2 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: CSPad2x2CalibIntensity.h 8068 2014-04-29 17:23:05Z dubrovin@SLAC.STANFORD.EDU

Author:: Mikhail S. Dubrovin

Interface Description

Include and typedef

  #include "PSCalib/CSPad2x2CalibIntensity.h"
  typedef PSCalib::CSPad2x2CalibIntensity 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  = "Cspad2x2::CalibV1";
  const std::string source     = "Camp.0:Cspad2x2.1";
  unsigned long     runNumber  = 10;
  Pds::Src src; env.get(source, key, &src);
  CALIB *calibpars = new CALIB(calibDir, groupName, src, runNumber);

For explicit constructor (depricated):

  const std::string calibDir   = "/reg/d/psdm/AMO/amoa1214/calib";
  const std::string groupName  = "Cspad2x2::CalibV1";
  const std::string source     = "Camp.0:Cspad2x2.1";
  unsigned long     runNumber  = 10;
  CALIB *calibpars = new CALIB(calibDir, groupName, source, runNumber);

or for the same list of parameters using polymorphism:

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

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::pixel_status_t* p_pixel_stat  = calibpars -> pixel_status()
  const CalibPars::common_mode_t*  p_common_mode = calibpars -> common_mode()
  const CalibPars::pixel_gain_t*   p_pixel_gain  = calibpars -> pixel_gain()
  const CalibPars::pixel_rms_t*    p_pixel_rms   = calibpars -> pixel_rms()
  ... etc. for all other access methods

See also:: CalibFileFinder

Definition at line 130 of file CSPad2x2CalibIntensity.h.

Constructor & Destructor Documentation

PSCalib::CSPad2x2CalibIntensity::CSPad2x2CalibIntensity ( bool isTestMode = false )

Default and test constructor.

Definition at line 47 of file CSPad2x2CalibIntensity.cpp.

References fillCalibNameVector(), and loadCalibPars().

PSCalib::CSPad2x2CalibIntensity::CSPad2x2CalibIntensity	(	const std::string &	calibDir,
		const std::string &	typeGroupName,
		const std::string &	source,
		const unsigned long &	runNumber,
		unsigned	print_bits = `255`
	)

DEPRICATED constructor, which use string& source.

Parameters:

`[in]`	calibDir	Calibration directory for current experiment.
`[in]`	typeGroupName	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 69 of file CSPad2x2CalibIntensity.cpp.

References fillCalibNameVector(), loadCalibPars(), and printInputPars().

PSCalib::CSPad2x2CalibIntensity::CSPad2x2CalibIntensity	(	const std::string &	calibDir,
		const std::string &	typeGroupName,
		const Pds::Src &	src,
		const unsigned long &	runNumber,
		unsigned	print_bits = `255`
	)

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

Parameters:

`[in]`	calibDir	Calibration directory for current experiment.
`[in]`	typeGroupName	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 92 of file CSPad2x2CalibIntensity.cpp.

References fillCalibNameVector(), loadCalibPars(), and printInputPars().

PSCalib::CSPad2x2CalibIntensity::~CSPad2x2CalibIntensity ( ) [virtual]

Destructor.

Definition at line 281 of file CSPad2x2CalibIntensity.cpp.

Member Function Documentation

virtual const CalibPars::common_mode_t* PSCalib::CSPad2x2CalibIntensity::common_mode ( ) [inline, virtual]

Returns the pointer to array with common_mode.

Reimplemented from PSCalib::CalibPars.

Definition at line 226 of file CSPad2x2CalibIntensity.h.

Referenced by common_mode_ndarr().

ndarray<CalibPars::common_mode_t, 1> PSCalib::CSPad2x2CalibIntensity::common_mode_ndarr ( ) [inline]

Returns ndarray of CSPAD2x2 common mode.

Definition at line 225 of file CSPad2x2CalibIntensity.h.

References common_mode().

void PSCalib::CSPad2x2CalibIntensity::fatalMissingFileName ( )

Generate error message in the log and abort.

Definition at line 207 of file CSPad2x2CalibIntensity.cpp.

Referenced by fillDefaultCalibParsV1().

void PSCalib::CSPad2x2CalibIntensity::fillCalibNameVector ( )

Makes member data vector with all supported calibration types such as center, tilt, ...

Definition at line 116 of file CSPad2x2CalibIntensity.cpp.

Referenced by CSPad2x2CalibIntensity().

void PSCalib::CSPad2x2CalibIntensity::fillCalibParsV1 ( )

Fill calibration parameters from vector.

Definition at line 181 of file CSPad2x2CalibIntensity.cpp.

Referenced by loadCalibPars().

void PSCalib::CSPad2x2CalibIntensity::fillDefaultCalibParsV1 ( )

Fill default calibration parameters.

Definition at line 192 of file CSPad2x2CalibIntensity.cpp.

References fatalMissingFileName().

Referenced by loadCalibPars().

void PSCalib::CSPad2x2CalibIntensity::getCalibFileName ( )

Define the path to the calibration file based on input parameters.

Definition at line 152 of file CSPad2x2CalibIntensity.cpp.

References CalibFileFinder::CalibFileFinder(), and CalibFileFinder::findCalibFile().

Referenced by loadCalibPars().

int PSCalib::CSPad2x2CalibIntensity::getCalibTypeStatus ( const std::string & type ) [inline]

Returns status of the calibration constants, 0-default, 1-loaded from file.

Parameters:

[in] type - calibration type string-name, for example "center" or "tilt"

Definition at line 201 of file CSPad2x2CalibIntensity.h.

void PSCalib::CSPad2x2CalibIntensity::loadCalibPars ( )

Load all known calibration parameters.

Definition at line 128 of file CSPad2x2CalibIntensity.cpp.

References fillCalibParsV1(), fillDefaultCalibParsV1(), getCalibFileName(), and msgUseDefault().

Referenced by CSPad2x2CalibIntensity().

void PSCalib::CSPad2x2CalibIntensity::msgUseDefault ( )

Generate warning message in the log.

Definition at line 220 of file CSPad2x2CalibIntensity.cpp.

Referenced by loadCalibPars().

virtual const size_t PSCalib::CSPad2x2CalibIntensity::ndim ( ) [inline, virtual]

Definition at line 210 of file CSPad2x2CalibIntensity.h.

References pdscalibdata::CsPad2x2BaseV2::Ndim.

virtual const CalibPars::pedestals_t* PSCalib::CSPad2x2CalibIntensity::pedestals ( ) [inline, virtual]

Returns the pointer to array with pedestals.

Reimplemented from PSCalib::CalibPars.

Definition at line 217 of file CSPad2x2CalibIntensity.h.

Referenced by pedestals_ndarr(), and shape().

ndarray<CalibPars::pedestals_t, 3> PSCalib::CSPad2x2CalibIntensity::pedestals_ndarr ( ) [inline]

Returns ndarray of CSPAD2x2 pedestals.

Definition at line 216 of file CSPad2x2CalibIntensity.h.

References pedestals().

virtual const CalibPars::pixel_gain_t* PSCalib::CSPad2x2CalibIntensity::pixel_gain ( ) [inline, virtual]

Returns the pointer to array with pixel_gain.

Reimplemented from PSCalib::CalibPars.

Definition at line 230 of file CSPad2x2CalibIntensity.h.

Referenced by pixel_gain_ndarr().

ndarray<CalibPars::pixel_gain_t, 3> PSCalib::CSPad2x2CalibIntensity::pixel_gain_ndarr ( ) [inline]

Returns ndarray of CSPAD2x2 pixel gain.

Definition at line 229 of file CSPad2x2CalibIntensity.h.

References pixel_gain().

virtual const CalibPars::pixel_rms_t* PSCalib::CSPad2x2CalibIntensity::pixel_rms ( ) [inline, virtual]

Returns the pointer to array with pixel_gain.

Reimplemented from PSCalib::CalibPars.

Definition at line 234 of file CSPad2x2CalibIntensity.h.

Referenced by pixel_rms_ndarr().

ndarray<CalibPars::pixel_rms_t, 3> PSCalib::CSPad2x2CalibIntensity::pixel_rms_ndarr ( ) [inline]

Returns ndarray of CSPAD2x2 pixel rms.

Definition at line 233 of file CSPad2x2CalibIntensity.h.

References pixel_rms().

virtual const CalibPars::pixel_status_t* PSCalib::CSPad2x2CalibIntensity::pixel_status ( ) [inline, virtual]

Returns the pointer to array with pixel_status.

Reimplemented from PSCalib::CalibPars.

Definition at line 222 of file CSPad2x2CalibIntensity.h.

Referenced by pixel_status_ndarr().

ndarray<CalibPars::pixel_status_t, 3> PSCalib::CSPad2x2CalibIntensity::pixel_status_ndarr ( ) [inline]

Returns ndarray of CSPAD2x2 pixel status.

Definition at line 221 of file CSPad2x2CalibIntensity.h.

References pixel_status().

void PSCalib::CSPad2x2CalibIntensity::printCalibPars ( ) [virtual]

Prints calibration parameters.

Reimplemented from PSCalib::CalibPars.

Definition at line 231 of file CSPad2x2CalibIntensity.cpp.

References print().

Referenced by main().

void PSCalib::CSPad2x2CalibIntensity::printCalibParsStatus ( ) [virtual]

Prints calibration parameters status.

Definition at line 262 of file CSPad2x2CalibIntensity.cpp.

Referenced by main().

void PSCalib::CSPad2x2CalibIntensity::printInputPars ( )

Prints input parameters of the object.

Definition at line 248 of file CSPad2x2CalibIntensity.cpp.

Referenced by CSPad2x2CalibIntensity(), and main().

virtual const unsigned* PSCalib::CSPad2x2CalibIntensity::shape ( ) [inline, virtual]

Definition at line 212 of file CSPad2x2CalibIntensity.h.

References pedestals().

virtual const size_t PSCalib::CSPad2x2CalibIntensity::size ( ) [inline, virtual]

Definition at line 211 of file CSPad2x2CalibIntensity.h.

References pdscalibdata::CsPad2x2BaseV2::Size.

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

PSCalib/include/CSPad2x2CalibIntensity.h
PSCalib/src/CSPad2x2CalibIntensity.cpp

Generated on 19 Dec 2016 for PSANAmodules by

1.4.7

PSCalib::CSPad2x2CalibIntensity Class Reference [PSCalib package]

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

PSCalib::CSPad2x2CalibIntensity Class Reference
[PSCalib package]