Data structure for PMT parameters. More...

#include <JPMTParameters.hh>

Inheritance diagram for JDETECTOR::JPMTParameters:

Classes
class	JPMTParametersHelper
	Auxiliary class for I/O of PMT parameters. More...

Public Member Functions
	JPMTParameters ()
	Default constructor. More...

	JPMTParameters (const double QE, const double gain, const double gainSpread, const double riseTime_ns, const double TTS_ns, const double threshold, const double slope, const double saturation, const bool slewing=true)
	Constructor. More...

const JPMTParameters &	getPMTParameters () const
	Get PMT parameters. More...

void	setPMTParameters (const JPMTParameters &parameters)
	Set PMT parameters. More...

bool	is_valid () const
	Check validity of PMT parameters. More...

JProperties	getProperties (const JEquationParameters &equation=JPMTParameters::getEquationParameters())
	Get properties of this class. More...

JProperties	getProperties (const JEquationParameters &equation=JPMTParameters::getEquationParameters()) const
	Get properties of this class. More...

Static Public Member Functions
static JEquationParameters &	getEquationParameters ()
	Get equation parameters. More...

static void	setEquationParameters (const JEquationParameters &equation)
	Set equation parameters. More...

Public Attributes
double	QE
	relative quantum efficiency More...

double	gain
	gain [unit] More...

double	gainSpread
	gain spread [unit] More...

double	riseTime_ns
	rise time of analogue pulse [ns] More...

double	TTS_ns
	transition time spread [ns] More...

double	threshold
	threshold [npe] More...

double	slope
	slope [ns/npe] More...

double	saturation
	saturation [ns] More...

bool	slewing
	time slewing of analogue signal More...

Friends
std::istream &	operator>> (std::istream &in, JPMTParameters &object)
	Stream input of PMT parameters. More...

std::ostream &	operator<< (std::ostream &out, const JPMTParameters &object)
	Stream output of PMT parameters. More...

Detailed Description

Data structure for PMT parameters.

Definition at line 29 of file JPMTParameters.hh.

Constructor & Destructor Documentation

◆ JPMTParameters() [1/2]

JDETECTOR::JPMTParameters::JPMTParameters ( )

inline

Default constructor.

This constuctor provides for default values of all PMT parameters. Note that only when the value of TTS_ns is positive, it will be used to generate the PMT transition times. In this case, a normal distribution is used with a sigma equal to the specified value. By default, the value is negative. As a consequence, the PMT transition times will be generated according the measured distribution (see JPMTTransitTimeGenerator.hh).

Definition at line 41 of file JPMTParameters.hh.

     {
       this->QE           =   1.0;        // [unit]
       this->gain         =   0.9;        // [unit]
       this->gainSpread   =   0.3;        // [unit]
       this->riseTime_ns  =   8.5;        // [ns]
       this->TTS_ns       =  -1.0;        // [ns]
       this->threshold    =   0.33;       // [npe]
       this->slope        =   7.0;        // [ns/npe]
       this->saturation   =   210;        // [ns]
       this->slewing      =  true;        //
     }

◆ JPMTParameters() [2/2]

JDETECTOR::JPMTParameters::JPMTParameters	(	const double	QE,
		const double	gain,
		const double	gainSpread,
		const double	riseTime_ns,
		const double	TTS_ns,
		const double	threshold,
		const double	slope,
		const double	saturation,
		const bool	slewing = `true`
	)

inline

Constructor.

Parameters

QE	relative quantum efficiency
gain	gain [unit]
gainSpread	gain spread [unit]
riseTime_ns	rise time of analogue pulse [ns]
TTS_ns;	transition time spread [ns]
threshold	threshold [npe]
slope	slope [ns/npe]
saturation	saturation [ns]
slewing	time slewing of analogue signal

Definition at line 68 of file JPMTParameters.hh.

     {
       this->QE          = QE;
       this->gain        = gain;
       this->gainSpread  = gainSpread;
       this->riseTime_ns = riseTime_ns;
       this->TTS_ns      = TTS_ns;
       this->threshold   = threshold; 
       this->slope       = slope;
       this->saturation  = saturation;
       this->slewing     = slewing;
     }

Member Function Documentation

◆ getPMTParameters()

const JPMTParameters& JDETECTOR::JPMTParameters::getPMTParameters ( ) const

inline

Get PMT parameters.

Returns: PMT parameters

Definition at line 95 of file JPMTParameters.hh.

     {
       return static_cast<const JPMTParameters&>(*this);
     }

◆ setPMTParameters()

void JDETECTOR::JPMTParameters::setPMTParameters ( const JPMTParameters & parameters )

inline

Set PMT parameters.

Parameters

parameters PMT parameters

Definition at line 106 of file JPMTParameters.hh.

     {
       static_cast<JPMTParameters&>(*this) = parameters;
     }

◆ is_valid()

bool JDETECTOR::JPMTParameters::is_valid ( ) const

inline

Check validity of PMT parameters.

Returns: true if valid; else false

Definition at line 117 of file JPMTParameters.hh.

     {
       if (this->QE         < 0.0 ||
           this->gain       < 0.0 ||
           this->gainSpread < 0.0 ||
           this->threshold  < 0.0) {
         return false;
       }
  
       return true;
     }

◆ getEquationParameters()

static JEquationParameters& JDETECTOR::JPMTParameters::getEquationParameters ( )

inlinestatic

Get equation parameters.

Returns: equation parameters

Definition at line 175 of file JPMTParameters.hh.

     {
       static JEquationParameters equation("=", ",", "./", "#");
  
       return equation;
     }

◆ setEquationParameters()

static void JDETECTOR::JPMTParameters::setEquationParameters ( const JEquationParameters & equation )

inlinestatic

Set equation parameters.

Parameters

equation equation parameters

Definition at line 188 of file JPMTParameters.hh.

     {
       getEquationParameters() = equation;
     }

◆ getProperties() [1/2]

JProperties JDETECTOR::JPMTParameters::getProperties ( const JEquationParameters & equation = JPMTParameters::getEquationParameters() )

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 199 of file JPMTParameters.hh.

     {
       return JPMTParametersHelper(*this, equation);
     }

◆ getProperties() [2/2]

JProperties JDETECTOR::JPMTParameters::getProperties ( const JEquationParameters & equation = JPMTParameters::getEquationParameters() ) const

inline

Get properties of this class.

Parameters

equation equation parameters

Definition at line 210 of file JPMTParameters.hh.

     {
       return JPMTParametersHelper(*this, equation);
     }

Friends And Related Function Documentation

◆ operator>>

std::istream& operator>>	(	std::istream &	in,
		JPMTParameters &	object
	)

friend

Stream input of PMT parameters.

Parameters

in	input stream
object	PMT parameters

Returns: input stream

Definition at line 137 of file JPMTParameters.hh.

     {
       return in >> object.QE
                 >> object.gain       
                 >> object.gainSpread
                 >> object.riseTime_ns
                 >> object.TTS_ns
                 >> object.threshold;
     }

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const JPMTParameters &	object
	)

friend

Stream output of PMT parameters.

Parameters

out	output stream
object	PMT parameters

Returns: output stream

Definition at line 155 of file JPMTParameters.hh.

     {
       JFlags flags(out);
  
       out << FIXED(5,3) << object.QE          << ' '
           << FIXED(5,3) << object.gain        << ' '
           << FIXED(5,3) << object.gainSpread  << ' '
           << FIXED(5,2) << object.riseTime_ns << ' '
           << FIXED(5,2) << object.TTS_ns      << ' '
           << FIXED(5,3) << object.threshold;
       
       return out;
     }

Member Data Documentation

◆ QE

double JDETECTOR::JPMTParameters::QE

relative quantum efficiency

Definition at line 216 of file JPMTParameters.hh.

◆ gain

double JDETECTOR::JPMTParameters::gain

gain [unit]

Definition at line 217 of file JPMTParameters.hh.

◆ gainSpread

double JDETECTOR::JPMTParameters::gainSpread

gain spread [unit]

Definition at line 218 of file JPMTParameters.hh.

◆ riseTime_ns

double JDETECTOR::JPMTParameters::riseTime_ns

rise time of analogue pulse [ns]

Definition at line 219 of file JPMTParameters.hh.

◆ TTS_ns

double JDETECTOR::JPMTParameters::TTS_ns

transition time spread [ns]

Definition at line 220 of file JPMTParameters.hh.

◆ threshold

double JDETECTOR::JPMTParameters::threshold

threshold [npe]

Definition at line 221 of file JPMTParameters.hh.

◆ slope

double JDETECTOR::JPMTParameters::slope

slope [ns/npe]

Definition at line 222 of file JPMTParameters.hh.

◆ saturation

double JDETECTOR::JPMTParameters::saturation

saturation [ns]

Definition at line 223 of file JPMTParameters.hh.

◆ slewing

bool JDETECTOR::JPMTParameters::slewing

time slewing of analogue signal

Definition at line 224 of file JPMTParameters.hh.

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

JPMTParameters.hh

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JPMTParameters() [1/2]

◆ JPMTParameters() [2/2]

Member Function Documentation

◆ getPMTParameters()

◆ setPMTParameters()

◆ is_valid()

◆ getEquationParameters()

◆ setEquationParameters()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

Friends And Related Function Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ QE

◆ gain

◆ gainSpread

◆ riseTime_ns

◆ TTS_ns

◆ threshold

◆ slope

◆ saturation

◆ slewing