CSPadPixCoords::CSPadConfigPars Class Reference
[CSPadPixCoords package]

CSPadConfigPars is a store for CSPAD configuration parameters. More...

#include <CSPadConfigPars.h>

List of all members.

Public Member Functions

CSPadConfigPars ()

Default constructor.

CSPadConfigPars (PSEvt::Source source)

Constructor using specified source as input parameter.

CSPadConfigPars (uint32_t numQuads, uint32_t quadNumber[], uint32_t roiMask[])

Constructor with explicit defenition of configuration parameters.

virtual ~CSPadConfigPars ()

Destructor.

bool setCSPadConfigPars (PSEvt::Event &evt, PSEnv::Env &env)

Sets CSPAD configuration parameters.

void setCSPadConfigParsDefault ()

Sets CSPAD configuration parameters to their default values.

void printCSPadConfigPars ()

Print input parameters.

std::string name ()

Returns the string with package name for logger.

uint32_t getNum2x1InMask (uint32_t mask)

Returns the number of turned on (1) bits (2x1s) in the binary mask (def.= 8).

uint32_t numberOfQuadsStored ()

Returns the number of quads stored in data array (def.= 4).

uint32_t quadNumber (int iq)

Returns the quad number for its index iq in the range [0,m_numQuads].

uint32_t numberOf2x1Stored (int iq)

Returns the number of 2x1s in the quad with index iq (def.= 8).

uint32_t roiMask (int iq)

Returns the mask for 2x1s in the quad with index iq (def.=0377 for all 8 2x1s).

uint32_t num2x1StoredInData ()

Returns the number of 2x1s available in the CSPAD detector (def.= 32).

bool isSet ()

Returns status: true if configuration parameters are set from env and evt, otherwise false.

template<typename T>

ndarray< T, 3 > getCSPadPixNDArrShapedAsData (ndarray< T, 3 > &arr_det)

Convers entire CSPAD pixel array, ndarray<T,3> with shape (32,185,388), to the data array, ndarray<T,3> shaped as (N,185,388).

template<typename T>

ndarray< T, 3 > getCSPadPixNDArrFromNDArrShapedAsData (ndarray< T, 3 > &arr_data, T default_value=0)

Convers entire CSPAD pixel data array, ndarray<T,3> shaped as (N,185,388) to the entire CSPAD pixel array, ndarray<T,3> with shape (32,185,388),.

Static Public Attributes

static const unsigned NQuadsMax = 4

Protected Member Functions

bool setCSPadConfigParsFromEnv (PSEnv::Env &env)

bool setCSPadConfigParsFromEvent (PSEvt::Event &evt)

Detailed Description

CSPadConfigPars is a store for CSPAD configuration parameters.

Interface Description

Include and typedef

  #include "CSPadPixCoords/CSPadConfigPars.h"
  typedef CSPadPixCoords::CSPadConfigPars CONFIG;

Instatiation
Default constructor; may be used if all 32 2x1 are in working condition and are presented in data

      CONFIG* config = new CONFIG ();

Constructor from specified data source, defined in psana. Prefered use case of this class objects.

      CONFIG* config = new CONFIG ("DetInfo(CxiDs1.0:Cspad.0)");

In this case configuration parameters need to be defined in psana module overloding methods like

      virtual void beginRun(PSEvt::Event& evt, PSEnv::Env& env); 
      virtual void beginCalibCycle(PSEvt::Event& evt, PSEnv::Env& env); 
      // or
      virtual void event(PSEvt::Event& evt, PSEnv::Env& env);

from the PSEvt::Event and PSEnv::Env variables using method

      bool is_set = config -> setCSPadConfigPars (evt, env); 
      // or its separate private methods
      bool is_set = config -> setCSPadConfigParsFromEnv (env); 
      bool is_set = config -> setCSPadConfigParsFromEvent (evt);

Constructor from explicitly defined configuration parameters. It is not recommended to use. Can be used for stable non-complete configuration of the detector or for test purpose.

      uint32_t numQuads     = 4;                
      uint32_t quadNumber[] = {0, 1, 2, 3};      
      uint32_t roiMask[]    = {0377, 0377, 0377, 0377};
      CONFIG* config = new CSPadConfigPars::CSPadConfigPars ( numQuads, quadNumber, roiMask );

Print current configuration parameters

      config -> printCSPadConfigPars();

Get methods for member data

      uint32_t numQuads = config -> numberOfQuadsStored ();
      uint32_t qNum     = config -> quadNumber (iq);  
      uint32_t n2x1     = config -> numberOf2x1Stored (iq);
      uint32_t quadMask = config -> roiMask (iq);

Conversion between entire CSPAD pixel array shaped as (32,185,388) and data array shaped as (N,185,388), where N<=32
Conversion from (32,185,388) to (N,185,388)

     ndarray<double,3> nda_det  = make_ndarray (p_pix_arr_det, N2X1_IN_DET, ROWS2X1, COLS2X1);
     ndarray<double,3> nda_data = cspad_configpars -> getCSPadPixNDArrShapedAsData<double> ( nda_det );

Conversion from (N,185,388) to (32,185,388)

     ndarray<double,3> nda_data = make_ndarray (p_pix_arr_data, N2X1_IN_DATA, ROWS2X1, COLS2X1); 
     ndarray<double,3> nda_det  = cspad_configpars -> getCSPadPixNDArrFromNDArrShapedAsData<double> ( nda_data );

Version:: $Id: CSPadConfigPars.h 8040 2014-04-19 01:00:36Z dubrovin@SLAC.STANFORD.EDU $

Author:: Mikhail S. Dubrovin

Definition at line 133 of file CSPadConfigPars.h.

Constructor & Destructor Documentation

CSPadPixCoords::CSPadConfigPars::CSPadConfigPars ( )

Default constructor.

Definition at line 38 of file CSPadConfigPars.cpp.

References setCSPadConfigParsDefault().

CSPadPixCoords::CSPadConfigPars::CSPadConfigPars ( PSEvt::Source source )

Constructor using specified source as input parameter.

Parameters:

[in] source (def.= "DetInfo(CxiDs1.0:Cspad.0)")

Definition at line 44 of file CSPadConfigPars.cpp.

References setCSPadConfigParsDefault().

CSPadPixCoords::CSPadConfigPars::CSPadConfigPars	(	uint32_t	numQuads,
		uint32_t	quadNumber[],
		uint32_t	roiMask[]
	)

Constructor with explicit defenition of configuration parameters.

Parameters:

`[in]`	numQuads	(def.= 4)
`[in]`	quadNumber[]	(def.= {0,1,2,3})
`[in]`	roiMask[]	(def.= {0377,0377,0377,0377}, or in decimal {255,255,255,255})

Definition at line 50 of file CSPadConfigPars.cpp.

References getNum2x1InMask(), and setCSPadConfigParsDefault().

CSPadPixCoords::CSPadConfigPars::~CSPadConfigPars ( ) [virtual]

Destructor.

Definition at line 71 of file CSPadConfigPars.cpp.

Member Function Documentation

template<typename T>

ndarray<T,3> CSPadPixCoords::CSPadConfigPars::getCSPadPixNDArrFromNDArrShapedAsData	(	ndarray< T, 3 > &	arr_data,
		T	default_value = `0`
	)			`[inline]`

Convers entire CSPAD pixel data array, ndarray<T,3> shaped as (N,185,388) to the entire CSPAD pixel array, ndarray<T,3> with shape (32,185,388),.

Definition at line 321 of file CSPadConfigPars.h.

References CalibPars::shape().

template<typename T>

ndarray<T,3> CSPadPixCoords::CSPadConfigPars::getCSPadPixNDArrShapedAsData ( ndarray< T, 3 > & arr_det ) [inline]

Convers entire CSPAD pixel array, ndarray<T,3> with shape (32,185,388), to the data array, ndarray<T,3> shaped as (N,185,388).

Definition at line 289 of file CSPadConfigPars.h.

References CalibPars::shape().

Referenced by CSPadPixCoords::PixCoordsCSPadV2::getPixCoorNDArrShapedAsData_um().

uint32_t CSPadPixCoords::CSPadConfigPars::getNum2x1InMask ( uint32_t mask )

Returns the number of turned on (1) bits (2x1s) in the binary mask (def.= 8).

Definition at line 78 of file CSPadConfigPars.cpp.

Referenced by CSPadConfigPars().

bool CSPadPixCoords::CSPadConfigPars::isSet ( ) [inline]

Returns status: true if configuration parameters are set from env and evt, otherwise false.

Definition at line 199 of file CSPadConfigPars.h.

std::string CSPadPixCoords::CSPadConfigPars::name ( ) [inline]

Returns the string with package name for logger.

Definition at line 178 of file CSPadConfigPars.h.

Referenced by printCSPadConfigPars(), setCSPadConfigParsFromEnv(), and setCSPadConfigParsFromEvent().

uint32_t CSPadPixCoords::CSPadConfigPars::num2x1StoredInData ( ) [inline]

Returns the number of 2x1s available in the CSPAD detector (def.= 32).

Definition at line 196 of file CSPadConfigPars.h.

uint32_t CSPadPixCoords::CSPadConfigPars::numberOf2x1Stored ( int iq ) [inline]

Returns the number of 2x1s in the quad with index iq (def.= 8).

Definition at line 190 of file CSPadConfigPars.h.

uint32_t CSPadPixCoords::CSPadConfigPars::numberOfQuadsStored ( ) [inline]

Returns the number of quads stored in data array (def.= 4).

Definition at line 184 of file CSPadConfigPars.h.

void CSPadPixCoords::CSPadConfigPars::printCSPadConfigPars ( )

Print input parameters.

Definition at line 112 of file CSPadConfigPars.cpp.

References name().

uint32_t CSPadPixCoords::CSPadConfigPars::quadNumber ( int iq ) [inline]

Returns the quad number for its index iq in the range [0,m_numQuads].

Definition at line 187 of file CSPadConfigPars.h.

uint32_t CSPadPixCoords::CSPadConfigPars::roiMask ( int iq ) [inline]

Returns the mask for 2x1s in the quad with index iq (def.=0377 for all 8 2x1s).

Definition at line 193 of file CSPadConfigPars.h.

bool CSPadPixCoords::CSPadConfigPars::setCSPadConfigPars	(	PSEvt::Event &	evt,
		PSEnv::Env &	env
	)

Sets CSPAD configuration parameters.

Parameters:

`[in]`	evt	pointer to the event store
`[in]`	env	pointer to the environment store

Definition at line 136 of file CSPadConfigPars.cpp.

References setCSPadConfigParsFromEnv(), and setCSPadConfigParsFromEvent().

void CSPadPixCoords::CSPadConfigPars::setCSPadConfigParsDefault ( )

Sets CSPAD configuration parameters to their default values.

Definition at line 90 of file CSPadConfigPars.cpp.

References NQuadsMax.

Referenced by CSPadConfigPars().

bool CSPadPixCoords::CSPadConfigPars::setCSPadConfigParsFromEnv ( PSEnv::Env & env ) [protected]

part of the setCSPadConfigPars(PSEvt::Event& evt, PSEnv::Env& env)

Parameters:

[in] env pointer to the environment store

Definition at line 147 of file CSPadConfigPars.cpp.

References name().

Referenced by setCSPadConfigPars().

bool CSPadPixCoords::CSPadConfigPars::setCSPadConfigParsFromEvent ( PSEvt::Event & evt ) [protected]

part of the setCSPadConfigPars(PSEvt::Event& evt, PSEnv::Env& env)

Parameters:

[in] evt pointer to the event store

Definition at line 164 of file CSPadConfigPars.cpp.

References name().

Referenced by setCSPadConfigPars().

Member Data Documentation

const unsigned CSPadPixCoords::CSPadConfigPars::NQuadsMax = 4 [static]

Definition at line 139 of file CSPadConfigPars.h.

Referenced by setCSPadConfigParsDefault().

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

CSPadPixCoords/include/CSPadConfigPars.h
CSPadPixCoords/src/CSPadConfigPars.cpp

Generated on 19 Dec 2016 for PSANAmodules by

1.4.7


Public Member Functions
	CSPadConfigPars ()
	Default constructor.
	CSPadConfigPars (PSEvt::Source source)
	Constructor using specified source as input parameter.
	CSPadConfigPars (uint32_t numQuads, uint32_t quadNumber[], uint32_t roiMask[])
	Constructor with explicit defenition of configuration parameters.
virtual	~CSPadConfigPars ()
	Destructor.
bool	setCSPadConfigPars (PSEvt::Event &evt, PSEnv::Env &env)
	Sets CSPAD configuration parameters.
void	setCSPadConfigParsDefault ()
	Sets CSPAD configuration parameters to their default values.
void	printCSPadConfigPars ()
	Print input parameters.
std::string	name ()
	Returns the string with package name for logger.
uint32_t	getNum2x1InMask (uint32_t mask)
	Returns the number of turned on (1) bits (2x1s) in the binary mask (def.= 8).
uint32_t	numberOfQuadsStored ()
	Returns the number of quads stored in data array (def.= 4).
uint32_t	quadNumber (int iq)
	Returns the quad number for its index iq in the range [0,m_numQuads].
uint32_t	numberOf2x1Stored (int iq)
	Returns the number of 2x1s in the quad with index iq (def.= 8).
uint32_t	roiMask (int iq)
	Returns the mask for 2x1s in the quad with index iq (def.=0377 for all 8 2x1s).
uint32_t	num2x1StoredInData ()
	Returns the number of 2x1s available in the CSPAD detector (def.= 32).
bool	isSet ()
	Returns status: true if configuration parameters are set from env and evt, otherwise false.
template<typename T>
ndarray< T, 3 >	getCSPadPixNDArrShapedAsData (ndarray< T, 3 > &arr_det)
	Convers entire CSPAD pixel array, ndarray<T,3> with shape (32,185,388), to the data array, ndarray<T,3> shaped as (N,185,388).
template<typename T>
ndarray< T, 3 >	getCSPadPixNDArrFromNDArrShapedAsData (ndarray< T, 3 > &arr_data, T default_value=0)
	Convers entire CSPAD pixel data array, ndarray<T,3> shaped as (N,185,388) to the entire CSPAD pixel array, ndarray<T,3> with shape (32,185,388),.
Static Public Attributes
static const unsigned	NQuadsMax = 4
Protected Member Functions
bool	setCSPadConfigParsFromEnv (PSEnv::Env &env)
bool	setCSPadConfigParsFromEvent (PSEvt::Event &evt)

CSPadPixCoords::CSPadConfigPars Class Reference [CSPadPixCoords package]

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Interface Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

CSPadPixCoords::CSPadConfigPars Class Reference
[CSPadPixCoords package]