PSCalib::CSPad2x2CalibPars Class Reference
[PSCalib package]

CSPad2x2CalibPars class loads/holds/provides access to the CSPad2x2 geometry calibration parameters. More...

#include <CSPad2x2CalibPars.h>

List of all members.

Public Member Functions
	CSPad2x2CalibPars (bool isTestMode=false)
	Default and test constructor.
	CSPad2x2CalibPars (const std::string &calibDir, const std::string &typeGroupName, const std::string &source, const unsigned long &runNumber)
	DEPRICATED constructor, which use string& source.
	CSPad2x2CalibPars (const std::string &calibDir, const std::string &typeGroupName, const Pds::Src &src, const unsigned long &runNumber)
	Regular constructor, which use Pds::Src& src.
virtual	~CSPad2x2CalibPars ()
	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	openCalibFile ()
	Open calibration file.
void	closeCalibFile ()
	Close calibration file.
void	readCalibPars ()
	Read parameters from calibration file to vector.
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.
void	printCalibParsStatus ()
	Prints calibration parameters status.
double	getCenterX (size_t sect)
	Returns x-coordinate [pix] of the 2x1 section center.
double	getCenterY (size_t sect)
	Returns y-coordinate [pix] of the 2x1 section center.
double	getCenterZ (size_t sect)
	Returns z-coordinate [pix] of the 2x1 section center.
double	getTilt (size_t sect)
	Returns the tilt angle [degree] of the 2x1 section.
int	getCalibTypeStatus (const std::string &type)
	Returns status of the calibration constants, 0-default, 1-loaded from file.
Static Public Member Functions
static double	getRowSize_um ()
	Returns 109.92 um.
static double	getColSize_um ()
	Returns 109.92 um.
static double	getGapRowSize_um ()
	Returns 274.80 um.
static double	getGapSize_um ()
	Returns size of the gap.
static double	getOrtSize_um ()
	Returns 500 um.
static double	getRowUmToPix ()
	Returns 1 / 109.92 um.
static double	getColUmToPix ()
	Returns 1 / 109.92 um.
static double	getOrtUmToPix ()
	Returns 1.

---

Detailed Description

CSPad2x2CalibPars 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:

CalibFileFinder

Version:

Id

CSPad2x2CalibPars.h 8068 2014-04-29 17:23:05Z dubrovin@SLAC.STANFORD.EDU

Author:

Mikhail S. Dubrovin

Interface Description

• Include and typedef

    #include "PSCalib/CSPad2x2CalibPars.h"
    typedef PSCalib::CSPad2x2CalibPars CALIB;
  

• Instatiation
  For default constructor:

    CALIB *calibpars = new CALIB();  
  

  
  For regular constructor:

    const std::string calibDir   = "/reg/d/psdm/xpp/xpptut13/calib/";
    const std::string groupName  = "CsPad2x2::CalibV1/";
    unsigned long     runNumber  = 10;
    Pds::Src src; env.get(...,&src);
    CALIB *calibpars = new CALIB(calibDir, groupName, src, runNumber);  
  

  
  For explicit constructor (depricated):

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

• Printing methods

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

• Access methods

    size_t sect=1; // for example...
    int status  = calibpars -> getCalibTypeStatus("center") // Returns status: 0-default, 1-loaded from file
    double xc   = calibpars -> getCenterX(sect);
    double tilt = calibpars -> getTilt(sect);
    ... etc. for all other access methods
  

See also:

CalibFileFinder

Definition at line 108 of file CSPad2x2CalibPars.h.

---

Constructor & Destructor Documentation

PSCalib::CSPad2x2CalibPars::CSPad2x2CalibPars

(

bool

isTestMode = false

)

Default and test constructor.

Definition at line 47 of file CSPad2x2CalibPars.cpp.

References fillCalibNameVector(), and loadCalibPars().

PSCalib::CSPad2x2CalibPars::CSPad2x2CalibPars	(	const std::string &	calibDir,
		const std::string &	typeGroupName,
		const std::string &	source,
		const unsigned long &	runNumber
	)

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.

Definition at line 68 of file CSPad2x2CalibPars.cpp.

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

PSCalib::CSPad2x2CalibPars::CSPad2x2CalibPars	(	const std::string &	calibDir,
		const std::string &	typeGroupName,
		const Pds::Src &	src,
		const unsigned long &	runNumber
	)

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.

Definition at line 89 of file CSPad2x2CalibPars.cpp.

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

PSCalib::CSPad2x2CalibPars::~CSPad2x2CalibPars

(

)

[virtual]

Destructor.

Definition at line 298 of file CSPad2x2CalibPars.cpp.

---

Member Function Documentation

void PSCalib::CSPad2x2CalibPars::closeCalibFile

(

)

Close calibration file.

Definition at line 186 of file CSPad2x2CalibPars.cpp.

Referenced by loadCalibPars().

void PSCalib::CSPad2x2CalibPars::fatalMissingFileName

(

)

Generate error message in the log and abort.

Definition at line 227 of file CSPad2x2CalibPars.cpp.

Referenced by fillDefaultCalibParsV1().

void PSCalib::CSPad2x2CalibPars::fillCalibNameVector

(

)

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

Definition at line 110 of file CSPad2x2CalibPars.cpp.

Referenced by CSPad2x2CalibPars().

void PSCalib::CSPad2x2CalibPars::fillCalibParsV1

(

)

Fill calibration parameters from vector.

Definition at line 207 of file CSPad2x2CalibPars.cpp.

Referenced by loadCalibPars().

void PSCalib::CSPad2x2CalibPars::fillDefaultCalibParsV1

(

)

Fill default calibration parameters.

Definition at line 215 of file CSPad2x2CalibPars.cpp.

References fatalMissingFileName().

Referenced by loadCalibPars().

void PSCalib::CSPad2x2CalibPars::getCalibFileName

(

)

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

Definition at line 146 of file CSPad2x2CalibPars.cpp.

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

Referenced by loadCalibPars().

int PSCalib::CSPad2x2CalibPars::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 223 of file CSPad2x2CalibPars.h.

double PSCalib::CSPad2x2CalibPars::getCenterX

(

size_t

sect

)

[inline]

Returns x-coordinate [pix] of the 2x1 section center.

Parameters:

[in]

sect

- 2x1 section number 0 or 1

Definition at line 187 of file CSPad2x2CalibPars.h.

double PSCalib::CSPad2x2CalibPars::getCenterY

(

size_t

sect

)

[inline]

Returns y-coordinate [pix] of the 2x1 section center.

Parameters:

[in]

sect

- 2x1 section number 0 or 1

Definition at line 190 of file CSPad2x2CalibPars.h.

double PSCalib::CSPad2x2CalibPars::getCenterZ

(

size_t

sect

)

[inline]

Returns z-coordinate [pix] of the 2x1 section center.

Parameters:

[in]

sect

- 2x1 section number 0 or 1

Definition at line 193 of file CSPad2x2CalibPars.h.

static double PSCalib::CSPad2x2CalibPars::getColSize_um

(

)

[inline, static]

Returns 109.92 um.

Definition at line 202 of file CSPad2x2CalibPars.h.

Referenced by getColUmToPix(), and printCalibPars().

static double PSCalib::CSPad2x2CalibPars::getColUmToPix

(

)

[inline, static]

Returns 1 / 109.92 um.

Definition at line 217 of file CSPad2x2CalibPars.h.

References getColSize_um().

Referenced by CSPadPixCoords::PixCoordsCSPad2x2::getPixCoor_pix().

static double PSCalib::CSPad2x2CalibPars::getGapRowSize_um

(

)

[inline, static]

Returns 274.80 um.

Definition at line 205 of file CSPad2x2CalibPars.h.

Referenced by getGapSize_um(), and printCalibPars().

static double PSCalib::CSPad2x2CalibPars::getGapSize_um

(

)

[inline, static]

Returns size of the gap.

Definition at line 208 of file CSPad2x2CalibPars.h.

References getGapRowSize_um(), and getRowSize_um().

static double PSCalib::CSPad2x2CalibPars::getOrtSize_um

(

)

[inline, static]

Returns 500 um.

Definition at line 211 of file CSPad2x2CalibPars.h.

static double PSCalib::CSPad2x2CalibPars::getOrtUmToPix

(

)

[inline, static]

Returns 1.

Definition at line 220 of file CSPad2x2CalibPars.h.

static double PSCalib::CSPad2x2CalibPars::getRowSize_um

(

)

[inline, static]

Returns 109.92 um.

Definition at line 199 of file CSPad2x2CalibPars.h.

Referenced by CSPadPixCoords::PixCoordsCSPad2x2::fillPixelCoordinateArrays(), getGapSize_um(), getRowUmToPix(), and printCalibPars().

static double PSCalib::CSPad2x2CalibPars::getRowUmToPix

(

)

[inline, static]

Returns 1 / 109.92 um.

Definition at line 214 of file CSPad2x2CalibPars.h.

References getRowSize_um().

Referenced by CSPadPixCoords::PixCoordsCSPad2x2::getPixCoor_pix().

double PSCalib::CSPad2x2CalibPars::getTilt

(

size_t

sect

)

[inline]

Returns the tilt angle [degree] of the 2x1 section.

Parameters:

[in]

sect

- 2x1 section number 0 or 1

Definition at line 196 of file CSPad2x2CalibPars.h.

void PSCalib::CSPad2x2CalibPars::loadCalibPars

(

)

Load all known calibration parameters.

Definition at line 119 of file CSPad2x2CalibPars.cpp.

References closeCalibFile(), fillCalibParsV1(), fillDefaultCalibParsV1(), getCalibFileName(), msgUseDefault(), openCalibFile(), and readCalibPars().

Referenced by CSPad2x2CalibPars().

void PSCalib::CSPad2x2CalibPars::msgUseDefault

(

)

Generate warning message in the log.

Definition at line 240 of file CSPad2x2CalibPars.cpp.

Referenced by loadCalibPars().

void PSCalib::CSPad2x2CalibPars::openCalibFile

(

)

Open calibration file.

Definition at line 173 of file CSPad2x2CalibPars.cpp.

References GeometryAccess::msg.

Referenced by loadCalibPars().

void PSCalib::CSPad2x2CalibPars::printCalibPars

(

)

Prints calibration parameters.

Definition at line 251 of file CSPad2x2CalibPars.cpp.

References getColSize_um(), getGapRowSize_um(), getRowSize_um(), and print().

Referenced by main(), and test03().

void PSCalib::CSPad2x2CalibPars::printCalibParsStatus

(

)

Prints calibration parameters status.

Definition at line 279 of file CSPad2x2CalibPars.cpp.

Referenced by main().

void PSCalib::CSPad2x2CalibPars::printInputPars

(

)

Prints input parameters of the object.

Definition at line 266 of file CSPad2x2CalibPars.cpp.

Referenced by CSPad2x2CalibPars().

void PSCalib::CSPad2x2CalibPars::readCalibPars

(

)

Read parameters from calibration file to vector.

Definition at line 193 of file CSPad2x2CalibPars.cpp.

Referenced by loadCalibPars().

---

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

• PSCalib/include/CSPad2x2CalibPars.h
• PSCalib/src/CSPad2x2CalibPars.cpp

---