flashmatch::PhotonLibHypothesis Class Reference

#include <PhotonLibHypothesis.h>

Inheritance diagram for flashmatch::PhotonLibHypothesis:

Public Member Functions
	PhotonLibHypothesis (const std::string name="PhotonLibHypothesis")
	Default constructor. More...
virtual	~PhotonLibHypothesis ()
	Default destructor. More...
void	FillEstimate (const QCluster_t &, Flash_t &) const
	Method to simply fill provided reference of flashmatch::Flash_t. More...
Public Member Functions inherited from flashmatch::BaseFlashHypothesis
	BaseFlashHypothesis (const std::string name="noname")
	Default constructor. More...
	~BaseFlashHypothesis ()
	Default destructor. More...
Flash_t	GetEstimate (const QCluster_t &) const
	Method to create flashmatch::Flash_t object and return. More...
void	SetChannelMask (std::vector< int > ch_mask)
	Sets the channels to use. More...
void	SetUncoatedPMTs (std::vector< int > ch_uncoated)
	Sets the channels sensitive to visible light. More...
void	SetSemiAnalyticalModel (std::unique_ptr< SemiAnalyticalModel > model)
	Sets the semi analytical model. More...
Public Member Functions inherited from flashmatch::BaseAlgorithm
	BaseAlgorithm (const Algorithm_t type, const std::string name)
	Default constructor. More...
	~BaseAlgorithm ()
	Default destructor. More...
void	Configure (const Config_t &pset)
	Function to accept configuration. More...
Algorithm_t	AlgorithmType () const
	Algorithm type. More...
const std::string &	AlgorithmName () const
	Algorithm name. More...
Public Member Functions inherited from flashmatch::LoggerFeature
	LoggerFeature (const std::string logger_name="LoggerFeature")
	Default constructor. More...
	LoggerFeature (const LoggerFeature &original)
	Default copy constructor. More...
virtual	~LoggerFeature ()
	Default destructor. More...
const flashmatch::logger &	logger () const
	Logger getter. More...
void	set_verbosity (::flashmatch::msg::Level_t level)
	Verbosity level. More...
const std::string &	name () const
	Name getter, defined in a logger instance attribute. More...

Protected Member Functions
void	_Configure_ (const Config_t &pset)

Protected Attributes
double	_global_qe
	Global QE for direct light. More...
double	_global_qe_refl
	Global QE for reflected light. More...
double	_sigma_qe
	Sigma for Gaussian centered on Global QE. More...
std::vector< double >	_qe_v
	PMT-wise relative QE. More...
bool	_use_semi_analytical
	If the semi-analytical approach should be used. More...
phot::PhotonVisibilityService const *const	_vis
Protected Attributes inherited from flashmatch::BaseFlashHypothesis
std::vector< int >	_channel_mask
	The list of channels to use. More...
std::vector< int >	_uncoated_pmt_list
	A list of opdet sensitive to visible (reflected) light. More...
std::unique_ptr < SemiAnalyticalModel >	_semi_model

Private Member Functions
void	FillEstimateSemiAnalytical (const QCluster_t &, Flash_t &) const
	Fills the estimate using the semi analytical approach (SBND) More...
void	FillEstimateLibrary (const QCluster_t &, Flash_t &) const
	Fills the estimate using the photon library (ICARUS, SBND) More...

Detailed Description

User custom analysis class made by SHELL_USER_NAME

Definition at line 43 of file PhotonLibHypothesis.h.

Constructor & Destructor Documentation

flashmatch::PhotonLibHypothesis::PhotonLibHypothesis

(

const std::string

name = "PhotonLibHypothesis"

)

Default constructor.

Definition at line 18 of file PhotonLibHypothesis.cxx.

    : BaseFlashHypothesis(name)
    , _vis(art::ServiceHandle<phot::PhotonVisibilityService const>().get())
  {}

virtual flashmatch::PhotonLibHypothesis::~PhotonLibHypothesis ( )

inlinevirtual

Default destructor.

Definition at line 51 of file PhotonLibHypothesis.h.

{}

Member Function Documentation

void flashmatch::PhotonLibHypothesis::_Configure_ ( const Config_t &  pset )

protectedvirtual

Implements flashmatch::BaseAlgorithm.

Definition at line 23 of file PhotonLibHypothesis.cxx.

  {
    #if USING_LARSOFT == 0
    omp_set_num_threads(NUM_THREADS);
    #endif

    _global_qe = pset.get<double>("GlobalQE");
    _global_qe_refl = pset.get<double>("GlobalQERefl", 0);
    _use_semi_analytical = pset.get<bool>("UseSemiAnalytical", 0);

    _qe_v.clear();
    _qe_v = pset.get<std::vector<double> >("CCVCorrection",_qe_v);
    if(_qe_v.empty()) _qe_v.resize(DetectorSpecs::GetME().NOpDets(),1.0);
    if(_qe_v.size() != DetectorSpecs::GetME().NOpDets()) {
      FLASH_CRITICAL() << "CCVCorrection factor array has size " << _qe_v.size()
                       << " != number of opdet (" << DetectorSpecs::GetME().NOpDets() << ")!" << std::endl;
      throw OpT0FinderException();
    }

    // By default, add all opdets to the channel mask
    // Note that this may be overridden by the manager
    // via the SetChannelMask() method.
    _channel_mask.clear();
    _channel_mask.reserve(DetectorSpecs::GetME().NOpDets());
    for (size_t i = 0; i < DetectorSpecs::GetME().NOpDets(); i++) {
      _channel_mask[i] = i;
    }
  }

void flashmatch::PhotonLibHypothesis::FillEstimate ( const QCluster_t &  , Flash_t &    ) const

virtual

Method to simply fill provided reference of flashmatch::Flash_t.

Implements flashmatch::BaseFlashHypothesis.

Definition at line 57 of file PhotonLibHypothesis.cxx.

  {

    for ( auto& v : flash.pe_v ) v = 0;

    if (_use_semi_analytical) {
      FillEstimateSemiAnalytical(trk, flash);
    } else {
      FillEstimateLibrary(trk, flash);
    }
  }

void flashmatch::PhotonLibHypothesis::FillEstimateLibrary ( const QCluster_t &  trk, Flash_t &  flash  ) const

private

Fills the estimate using the photon library (ICARUS, SBND)

Definition at line 134 of file PhotonLibHypothesis.cxx.

  {

    static double xyz[3] = {0.};

    size_t n_pmt = DetectorSpecs::GetME().NOpDets();

    for ( size_t ipmt = 0; ipmt < n_pmt; ++ipmt) {

      if (std::find(_channel_mask.begin(), _channel_mask.end(), ipmt) == _channel_mask.end()) {
        continue;
      }

      bool is_uncoated = false;
      if (std::find(_uncoated_pmt_list.begin(), _uncoated_pmt_list.end(), ipmt) != _uncoated_pmt_list.end()) {
        is_uncoated = true;
      }

      for (size_t ipt = 0; ipt < trk.size(); ++ipt) {
        auto const& pt = trk[ipt];

        double q = pt.q;

        xyz[0] = pt.x;
        xyz[1] = pt.y;
        xyz[2] = pt.z;

        double q_direct = 0, q_refl = 0;

        // Direct light
        if (is_uncoated) {
          q_direct = 0;
        } else {
          q_direct = q * _vis->GetVisibility(xyz, ipmt) * _global_qe / _qe_v[ipmt];
        }
        // std::cout << "PMT : " << ipmt << " [x,y,z] -> [q] : [" << pt.x << ", " << pt.y << ", " << pt.z << "] -> [" << q << "]" << std::endl;

        // Reflected light
        q_refl = q * _vis->GetVisibility(xyz, ipmt, true) * _global_qe_refl / _qe_v[ipmt];

        flash.pe_v[ipmt] += q_direct;
        flash.pe_v[ipmt] += q_refl;
      }
    }
    return;
  }

void flashmatch::PhotonLibHypothesis::FillEstimateSemiAnalytical ( const QCluster_t &  trk, Flash_t &  flash  ) const

private

Fills the estimate using the semi analytical approach (SBND)

Get the 3D point in space from where photons should be propagated

Definition at line 70 of file PhotonLibHypothesis.cxx.

  {

    for ( size_t ipt = 0; ipt < trk.size(); ++ipt) {

      /// Get the 3D point in space from where photons should be propagated
      auto const& pt = trk[ipt];

      // Get the number of photons produced in such point
      double n_original_photons = pt.q;

      geo::Point_t const xyz = {pt.x, pt.y, pt.z};

      std::vector<double> direct_visibilities;
      _semi_model->detectedDirectVisibilities(direct_visibilities, xyz);

      std::vector<double> reflected_visibilities;
      _semi_model->detectedReflectedVisibilities(reflected_visibilities, xyz);

      //
      // Fill Estimate with Direct light
      //
      for (size_t op_det=0; op_det<direct_visibilities.size(); ++op_det) {

        const double visibility = direct_visibilities[op_det];

        double q = n_original_photons * visibility * _global_qe / _qe_v[op_det];

        // Coated PMTs don't see direct photons
        if (std::find(_uncoated_pmt_list.begin(), _uncoated_pmt_list.end(), op_det) != _uncoated_pmt_list.end()) {
          q = 0;
        }

        // std::cout << "OpDet: " << op_det << " [x,y,z] -> [q] : [" << pt.x << ", " << pt.y << ", " << pt.z << "] -> [" << q << "]" << std::endl;

        if (std::find(_channel_mask.begin(), _channel_mask.end(), op_det) != _channel_mask.end()) {
          flash.pe_v[op_det] += q;
        } else {
          flash.pe_v[op_det] = 0;
        }
      }

      //
      // Fill Estimate with Reflected light
      //
      for (size_t op_det=0; op_det<reflected_visibilities.size(); ++op_det) {

        const double visibility = reflected_visibilities[op_det];

        double q = n_original_photons * visibility * _global_qe_refl / _qe_v[op_det];

        if (std::find(_channel_mask.begin(), _channel_mask.end(), op_det) != _channel_mask.end()) {
          flash.pe_v[op_det] += q;
        } else {
          flash.pe_v[op_det] = 0;
        }

      }

    }
  }

Member Data Documentation

double flashmatch::PhotonLibHypothesis::_global_qe

protected

Global QE for direct light.

Definition at line 66 of file PhotonLibHypothesis.h.

double flashmatch::PhotonLibHypothesis::_global_qe_refl

protected

Global QE for reflected light.

Definition at line 67 of file PhotonLibHypothesis.h.

std::vector<double> flashmatch::PhotonLibHypothesis::_qe_v

protected

PMT-wise relative QE.

Definition at line 69 of file PhotonLibHypothesis.h.

double flashmatch::PhotonLibHypothesis::_sigma_qe

protected

Sigma for Gaussian centered on Global QE.

Definition at line 68 of file PhotonLibHypothesis.h.

bool flashmatch::PhotonLibHypothesis::_use_semi_analytical

protected

If the semi-analytical approach should be used.

Definition at line 70 of file PhotonLibHypothesis.h.

phot::PhotonVisibilityService const* const flashmatch::PhotonLibHypothesis::_vis

protected

Definition at line 72 of file PhotonLibHypothesis.h.

---

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

• PhotonLibHypothesis.h
• PhotonLibHypothesis.cxx