Auxiliary class for map of PMT parameters. More...

#include <JPMTParametersMap.hh>

Inheritance diagram for JDETECTOR::JPMTParametersMap:

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

Public Member Functions
	JPMTParametersMap (const JPMTParameters &parameters=JPMTParameters())
	Constructor.

	JPMTParametersMap (const char *const file_name)
	Constructor.

const JPMTParameters &	getPMTParameters (const JPMTIdentifier &id) const
	Get PMT parameters.

double	getQE (const JPMTIdentifier &id) const
	Get QE of given PMT.

double	getHitProbability (const JPMTIdentifier &id) const
	Get ratio of hit probabilities of given PMT.

const JPMTParameters &	getDefaultPMTParameters () const
	Get default PMT parameters.

JPMTParameters &	getDefaultPMTParameters ()
	Get default PMT parameters.

void	setDefaultPMTParameters (const JPMTParameters &parameters)
	Set default PMT parameters.

double	getQE () const
	Get global QE.

void	setQE (const double QE)
	Set global QE.

double	getMu () const
	Get expectation value for number of photo-electrons given two-fold (or higher) coincidence rate.

bool	is_valid () const
	Check validity of PMT parameters.

void	convertHitProbabilityToQE (const double mu)
	Convert the hit probabilities to QEs for given expectation value.

void	convertQEToHitProbability ()
	Convert the QEs to hit probabilities for given expectation value.

JPMTParameters &	operator[] (const JPMTIdentifier &id)
	Access parameters corresponding to given PMT identifier.

void	load (const char *file_name)
	Load from input file.

void	store (const char *file_name) const
	Store to output file.

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

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

static void	Throw (const bool option)
	Enable/disable throw option.

template<class JException_t >
static int	Throw (const JException_t &error, const int value=-1)
	Throw exception or return error.

Public Attributes
JComment	comment

Protected Attributes
struct {

JPMTParameters parameters
	Default PMT parameters. More...

double QE = 1.0
	Global QE. More...

double mu = 0.0
	Expectation value for number of photo-electrons given two-fold (or higher) coincidence rate. More...

}	internal

Static Protected Attributes
static bool	do_throw = true
	throw option

Friends
std::istream &	operator>> (std::istream &in, JPMTParametersMap &object)
	Stream input.

std::ostream &	operator<< (std::ostream &out, const JPMTParametersMap &object)
	Stream output.

Detailed Description

Auxiliary class for map of PMT parameters.

Input syntax as follows:

           QE=<value>
           mu=<value>

           %.<key>=<value>

           PMT=<module> <pmt> <PMT parameters>

           pmt=<module> <pmt> <key>=<value>[, <key>=<value>]

           file=<file name>

where

QE refers to the global quantum efficiency which is reserved for the overall light scaling;
mu refers to the expectation value for number of photo-electrons given two-fold (or higher) coincidence rate;
'%' to the default values;
<module> to the module identifier;
<pmt> to the readout channel;
<key> to one of the data members of the JDETECTOR::JPMTParameters data structure; and
<value> to the corresponding value.

The global QE is applied as a multiplicative factor to the default and PMT specific QEs. It is set (read overwritten) in the JTriggerEfficiency[RunByRun].sh scripts.

The default values are provided by the method getDefaultPMTParameters and can also be modified using method setDefaultPMTParameters. If no optional values are given, the default values are maintained.

Finally, <PMT parameters> corresponds to the list of PMT parameter values that should be compatible with the I/O methods of the JDETECTOR::JPMTParameters data structure.

Note that multiple input sequences should be seperated by a semicolumn ';' or be terminated by a newline. When multiple input sequences appear for the same target, the last sequence prevails.

Definition at line 89 of file JPMTParametersMap.hh.

Constructor & Destructor Documentation

◆ JPMTParametersMap() [1/2]

JDETECTOR::JPMTParametersMap::JPMTParametersMap ( const JPMTParameters & parameters = JPMTParameters() )

inline

Constructor.

Parameters

parameters PMT parameters

Definition at line 100 of file JPMTParametersMap.hh.

                                                                           :
      JPMTParametersMap_t()
    {
      setDefaultPMTParameters(parameters);
    }

◆ JPMTParametersMap() [2/2]

JDETECTOR::JPMTParametersMap::JPMTParametersMap ( const char *const file_name )

inline

Constructor.

Parameters

file_name file name

Definition at line 112 of file JPMTParametersMap.hh.

                                                   : 
      JPMTParametersMap_t()
    {
      using namespace std;
 
      ifstream in(file_name);
 
      in >> *this;
 
      in.close();
    }

Member Function Documentation

◆ getPMTParameters()

const JPMTParameters & JDETECTOR::JPMTParametersMap::getPMTParameters ( const JPMTIdentifier & id ) const

inline

Get PMT parameters.

This method returns the default PMT parameters if the parameters corresponding to the given PMT identifier have not been defined.

Note that the value of QE as part of the return value has been scaled with the global QE of the PMT parameters map.

Parameters

id	PMT identifier

Returns: PMT parameters

Definition at line 136 of file JPMTParametersMap.hh.

    {
      static JPMTParameters parameters;
      
      JPMTParametersMap_t::const_iterator i = find(id);
 
      if (i != end()) {
        parameters = i->second;
      } else {
        parameters = getDefaultPMTParameters();
      }
 
      parameters.QE *= internal.QE;
      
      return parameters;
    }

◆ getQE() [1/2]

double JDETECTOR::JPMTParametersMap::getQE ( const JPMTIdentifier & id ) const

inline

Get QE of given PMT.

Parameters

id	PMT identifier

Returns: QE

Definition at line 160 of file JPMTParametersMap.hh.

    {
      return getPMTParameters(id).QE;
    }

◆ getHitProbability()

double JDETECTOR::JPMTParametersMap::getHitProbability ( const JPMTIdentifier & id ) const

inline

Get ratio of hit probabilities of given PMT.

Parameters

id	PMT identifier

Returns: ratio

Definition at line 172 of file JPMTParametersMap.hh.

    {
      return JDETECTOR::getHitProbability(getQE(id), internal.mu);
    }

◆ getDefaultPMTParameters() [1/2]

const JPMTParameters & JDETECTOR::JPMTParametersMap::getDefaultPMTParameters ( ) const

inline

Get default PMT parameters.

Returns: PMT parameters

Definition at line 183 of file JPMTParametersMap.hh.

    {
      return internal.parameters;
    }

◆ getDefaultPMTParameters() [2/2]

JPMTParameters & JDETECTOR::JPMTParametersMap::getDefaultPMTParameters ( )

inline

Get default PMT parameters.

Returns: PMT parameters

Definition at line 194 of file JPMTParametersMap.hh.

    {
      return internal.parameters;
    }

◆ setDefaultPMTParameters()

void JDETECTOR::JPMTParametersMap::setDefaultPMTParameters ( const JPMTParameters & parameters )

inline

Set default PMT parameters.

Parameters

parameters PMT parameters

Definition at line 205 of file JPMTParametersMap.hh.

    {
      internal.parameters = parameters;
    }

◆ getQE() [2/2]

double JDETECTOR::JPMTParametersMap::getQE ( ) const

inline

Get global QE.

Returns: QE

Definition at line 216 of file JPMTParametersMap.hh.

    {
      return internal.QE;
    }

◆ setQE()

void JDETECTOR::JPMTParametersMap::setQE ( const double QE )

inline

Set global QE.

Parameters

QE QE

Definition at line 227 of file JPMTParametersMap.hh.

    {
      internal.QE = QE;
    }

◆ getMu()

double JDETECTOR::JPMTParametersMap::getMu ( ) const

inline

Get expectation value for number of photo-electrons given two-fold (or higher) coincidence rate.

Returns: expectation value

Definition at line 238 of file JPMTParametersMap.hh.

    {
      return internal.mu;
    }

◆ is_valid()

bool JDETECTOR::JPMTParametersMap::is_valid ( ) const

inline

Check validity of PMT parameters.

Returns: true if valid; else false

Definition at line 249 of file JPMTParametersMap.hh.

    {
      try {
 
        if (internal.QE < 0.0) {
          THROW(JException, "Invalid global QE " << internal.QE);
        }
 
        if (internal.mu < 0.0) {
          THROW(JException, "Invalid expectation value number of photo-electrons " << internal.mu);
        }
        
        if (!internal.parameters.is_valid()) {
          THROW(JException, "Invalid default PMT parameters");
        }
        
        for (const_iterator i = this->begin(); i != this->end(); ++i) {
          
          if (!i->second.is_valid()) {
            THROW(JException, "Invalid PMT parameters at " << i->first);
          }
 
          if (i->second.QE * internal.QE > 1.0 ||
              i->second.QE * internal.QE < 0.0) {
            THROW(JException, "Invalid PMT QE at " << i->first << ' ' << i->second.QE * internal.QE);
          }
        }
 
        return true;
      }
      catch(const JException& error) {
 
        Throw(error);
 
        return false;
      }
    }

◆ convertHitProbabilityToQE()

void JDETECTOR::JPMTParametersMap::convertHitProbabilityToQE ( const double mu )

inline

Convert the hit probabilities to QEs for given expectation value.

The expectation value corresponds to the number of photo-electrons given the multiplicity range of coincidences as specified at JCalibrateK40.cc.

Parameters

mu	expectation value

Definition at line 296 of file JPMTParametersMap.hh.

    {
      if (internal.mu != 0.0) {
        THROW(JValueOutOfRange, "Non-zero internal expectation value " << internal.mu << "; use first method convertQEToHitProbability().");
      }
 
      const double Pmax = getMaximalHitProbability(mu);
 
      for (JPMTParametersMap::const_iterator i = this->begin(); i != this->end(); ++i) {
        if (i->second.QE > Pmax) {
          THROW(JValueOutOfRange, "Hit probability PMT " << i->first << ' ' << i->second.QE << " > maximum probability given expectation value " << mu);
        }
      }
      
      internal.mu = mu;
 
      for (JPMTParametersMap::iterator i = this->begin(); i != this->end(); ++i) {
        
        if (i->second.QE > 0.0)
          i->second.QE = JDETECTOR::getQE(i->second.QE, internal.mu);
        else
          i->second.QE = 0.0;
      }
    }

◆ convertQEToHitProbability()

void JDETECTOR::JPMTParametersMap::convertQEToHitProbability ( )

inline

Convert the QEs to hit probabilities for given expectation value.

The expectation value is set to zero.

Definition at line 327 of file JPMTParametersMap.hh.

    {
      // backward correction QE -> P
 
      if (internal.mu > 0.0) { 
 
        for (JPMTParametersMap::iterator i = this->begin(); i != this->end(); ++i) {
        
          if (i->second.QE > 0.0)
            i->second.QE = JDETECTOR::getHitProbability(i->second.QE, internal.mu);
          else
            i->second.QE = 0.0;
        }
 
        internal.mu = 0.0;
      }
    }

◆ operator[]()

JPMTParameters & JDETECTOR::JPMTParametersMap::operator[] ( const JPMTIdentifier & id )

inline

Access parameters corresponding to given PMT identifier.

Note: The default PMT parameters are inserted if no parameters for the given PMT identifier are contained at the time of the function call.

Parameters

id	PMT identifier

Returns: parameters

Definition at line 355 of file JPMTParametersMap.hh.

    {
      JPMTParametersMap_t::iterator i = find(id);
 
      if (i == end()) {
        i = this->insert(i, std::make_pair(id, getDefaultPMTParameters()));
      }
      
      return i->second;
    }

◆ getEquationParameters()

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

inlinestatic

Get equation parameters.

Returns: equation parameters

Definition at line 435 of file JPMTParametersMap.hh.

    {
      static JEquationParameters parameters;
 
      return parameters;
    }

◆ setEquationParameters()

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

inlinestatic

Set equation parameters.

Parameters

equation equation parameters

Definition at line 448 of file JPMTParametersMap.hh.

    {
      getEquationParameters() = equation;
    }

◆ load()

template<class T >

void JLANG::JObjectStreamIO< T >::load ( const char * file_name )

inlineinherited

Load from input file.

Parameters

file_name file name

Definition at line 30 of file JObjectStreamIO.hh.

    {
      JLANG::load<std::ifstream>(file_name, static_cast<T&>(*this));
    }

◆ store()

template<class T >

void JLANG::JObjectStreamIO< T >::store ( const char * file_name ) const

inlineinherited

Store to output file.

Parameters

file_name file name

Definition at line 41 of file JObjectStreamIO.hh.

    {
      JLANG::store<std::ofstream>(file_name, static_cast<const T&>(*this));
    }

◆ Throw() [1/2]

template<class T >

static void JLANG::JThrow< T >::Throw ( const bool option )

inlinestaticinherited

Enable/disable throw option.

Parameters

option true enable; false disable

Definition at line 37 of file JThrow.hh.

    {
      do_throw = option;
    }

◆ Throw() [2/2]

template<class T >

template<class JException_t >

static int JLANG::JThrow< T >::Throw	(	const JException_t &	error,
		const int	value = -1 )

inlinestaticinherited

Throw exception or return error.

Parameters

error	exception
value	return code

Returns: return code

Definition at line 51 of file JThrow.hh.

    {
      using namespace std;
      
      if (do_throw) {
        throw error;
      }
 
      cerr << error.what() << endl;
      
      return value;
    }

Friends And Related Symbol Documentation

◆ operator>>

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

friend

Stream input.

Parameters

in	input stream
object	PMT parameters map

Returns: input stream

Definition at line 374 of file JPMTParametersMap.hh.

    {
      using namespace std;
      using namespace JPP;
      
      JStringStream is(in);
 
      if (getFileStatus(is.str().c_str())) {
        is.load();
      }
 
      JProperties properties(getEquationParameters(), 1);
        
      JPMTParametersMapHelper  helper(object, getEquationParameters());
      JProperties              demo = object.internal.parameters.getProperties();
      
      properties["PMT"] = static_cast<JPMTParametersMap_t&>(object);
      properties["pmt"] = helper;
      properties["%"]   = demo;
      properties["QE"]  = object.internal.QE;
      properties["mu"]  = object.internal.mu;
 
      is >> object.comment;
      is >> properties;
      
      return in;
    }

◆ operator<<

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

friend

Stream output.

Parameters

out	output stream
object	PMT parameters map

Returns: output stream

Definition at line 410 of file JPMTParametersMap.hh.

    {
      using namespace JLANG;
      
      JProperties properties(getEquationParameters());
 
      JProperties demo = object.internal.parameters.getProperties();
 
      properties["PMT"] = static_cast<const JPMTParametersMap_t&>(object);
      properties["%"]   = demo;
 
      out << object.comment;
      out << setequation(getEquationParameters()) << JEquation::make_equation("QE", object.internal.QE);
      out << setequation(getEquationParameters()) << JEquation::make_equation("mu", object.internal.mu);
      out << properties;
 
      return out;
    }

Member Data Documentation

◆ comment

JComment JDETECTOR::JPMTParametersMap::comment

Definition at line 454 of file JPMTParametersMap.hh.

◆ parameters

JPMTParameters JDETECTOR::JPMTParametersMap::parameters

Default PMT parameters.

Definition at line 459 of file JPMTParametersMap.hh.

◆ QE

double JDETECTOR::JPMTParametersMap::QE = 1.0

Global QE.

Definition at line 460 of file JPMTParametersMap.hh.

◆ mu

double JDETECTOR::JPMTParametersMap::mu = 0.0

Expectation value for number of photo-electrons given two-fold (or higher) coincidence rate.

Definition at line 461 of file JPMTParametersMap.hh.

◆ [struct]

struct { ... } JDETECTOR::JPMTParametersMap::internal

◆ do_throw

template<class T >

bool JLANG::JThrow< T >::do_throw = true

staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.

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

JPMTParametersMap.hh

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ JPMTParametersMap() [1/2]

◆ JPMTParametersMap() [2/2]

Member Function Documentation

◆ getPMTParameters()

◆ getQE() [1/2]

◆ getHitProbability()

◆ getDefaultPMTParameters() [1/2]

◆ getDefaultPMTParameters() [2/2]

◆ setDefaultPMTParameters()

◆ getQE() [2/2]

◆ setQE()

◆ getMu()

◆ is_valid()

◆ convertHitProbabilityToQE()

◆ convertQEToHitProbability()

◆ operator[]()

◆ getEquationParameters()

◆ setEquationParameters()

◆ load()

◆ store()

◆ Throw() [1/2]

◆ Throw() [2/2]

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ comment

◆ parameters

◆ QE

◆ mu

◆ [struct]

◆ do_throw