larg4::OpDetPhotonTable Class Reference

#include "OpDetPhotonTable.h"

Public Member Functions
	~OpDetPhotonTable ()
void	AddPhoton (size_t opchannel, sim::OnePhoton &&photon, bool Reflected=false)
void	AddLitePhoton (int opchannel, int time, int nphotons, bool Reflected=false)
void	AddPhoton (std::map< int, std::map< int, int >> *StepPhotonTable, bool Reflected=false)
void	AddLitePhotons (std::map< int, std::map< int, int >> *StepPhotonTable, bool Reflected=false)
std::vector< sim::SimPhotons > &	GetPhotons (bool Reflected=false)
std::vector< sim::SimPhotons > &	GetReflectedPhotons ()
sim::SimPhotons &	GetPhotonsForOpChannel (size_t opchannel)
sim::SimPhotons &	GetReflectedPhotonsForOpChannel (size_t opchannel)
std::map< int, std::map< int, int > >	GetLitePhotons (bool Reflected=false)
std::map< int, std::map< int, int > >	GetReflectedLitePhotons ()
std::map< int, int > &	GetLitePhotonsForOpChannel (int opchannel)
std::map< int, int > &	GetReflectedLitePhotonsForOpChannel (int opchannel)
void	ClearTable (size_t nch=0)
void	AddOpDetBacktrackerRecord (sim::OpDetBacktrackerRecord soc, bool Reflected=false)
std::vector< sim::OpDetBacktrackerRecord >	YieldOpDetBacktrackerRecords ()
std::vector< sim::OpDetBacktrackerRecord >	YieldReflectedOpDetBacktrackerRecords ()
void	ClearEnergyDeposits ()
void	AddEnergyDeposit (int n_photon, int n_elec, double scint_yield, double energy, float start_x, float start_y, float start_z, float end_x, float end_y, float end_z, double start_time, double end_time, int trackid, int pdgcode, int g4trackid, std::string const &vol="EMPTY")
std::unordered_map< std::string, std::vector< sim::SimEnergyDeposit > > const &	GetSimEnergyDeposits () const
	Returns the map of energy deposits by volume name. More...
std::unordered_map< std::string, std::vector< sim::SimEnergyDeposit > >	YieldSimEnergyDeposits ()
	Yields the map of energy deposits by volume name, and resets the internal one. More...

Static Public Member Functions
static OpDetPhotonTable *	Instance (bool LitePhotons=false)

Protected Member Functions
	OpDetPhotonTable ()

Private Member Functions
void	AddOpDetBacktrackerRecord (std::vector< sim::OpDetBacktrackerRecord > &RecordsCol, std::map< int, int > &ChannelMap, sim::OpDetBacktrackerRecord soc)

Private Attributes
std::map< int, std::map< int, int > >	fLitePhotons
std::map< int, std::map< int, int > >	fReflectedLitePhotons
std::vector< sim::OpDetBacktrackerRecord >	cOpDetBacktrackerRecordsCol
std::vector< sim::OpDetBacktrackerRecord >	cReflectedOpDetBacktrackerRecordsCol
std::map< int, int >	cOpChannelToSOCMap
std::map< int, int >	cReflectedOpChannelToSOCMap
std::vector< sim::SimPhotons >	fDetectedPhotons
std::vector< sim::SimPhotons >	fReflectedDetectedPhotons
std::unordered_map< std::string, std::vector< sim::SimEnergyDeposit > >	fSimEDepCol

Detailed Description

Definition at line 47 of file OpDetPhotonTable.h.

Constructor & Destructor Documentation

larg4::OpDetPhotonTable::~OpDetPhotonTable

(

)

Definition at line 28 of file OpDetPhotonTable.cxx.

{}

larg4::OpDetPhotonTable::OpDetPhotonTable ( )

protected

Definition at line 23 of file OpDetPhotonTable.cxx.

References fDetectedPhotons, and fReflectedDetectedPhotons.

Referenced by GetReflectedLitePhotonsForOpChannel(), and Instance().

  {
    fDetectedPhotons.clear();
    fReflectedDetectedPhotons.clear();
  }

Member Function Documentation

void larg4::OpDetPhotonTable::AddEnergyDeposit	(	int	n_photon,
		int	n_elec,
		double	scint_yield,
		double	energy,
		float	start_x,
		float	start_y,
		float	start_z,
		float	end_x,
		float	end_y,
		float	end_z,
		double	start_time,
		double	end_time,
		int	trackid,
		int	pdgcode,
		int	g4trackid,
		std::string const &	vol = "EMPTY"
	)

Definition at line 191 of file OpDetPhotonTable.cxx.

References fSimEDepCol.

Referenced by GetReflectedLitePhotonsForOpChannel(), and larg4::OpFastScintillation::ProcessStep().

  {
    fSimEDepCol[vol].emplace_back(n_photon,
                                  n_elec,
                                  scint_yield,
                                  energy,
                                  geo::Point_t{start_x, start_y, start_z},
                                  geo::Point_t{end_x, end_y, end_z},
                                  start_time,
                                  end_time,
                                  trackid,
                                  pdgcode,
                                  g4trackid);
  }

void larg4::OpDetPhotonTable::AddLitePhoton	(	int	opchannel,
		int	time,
		int	nphotons,
		bool	Reflected = false
	)

Definition at line 54 of file OpDetPhotonTable.cxx.

References fLitePhotons, and fReflectedLitePhotons.

Referenced by larg4::OpDetSensitiveDetector::AddLitePhoton(), and larg4::OpFastScintillation::RecordPhotonsProduced().

  {
    if (!Reflected)
      fLitePhotons[opchannel][time] += nphotons;
    else
      fReflectedLitePhotons[opchannel][time] += nphotons;
  }

void larg4::OpDetPhotonTable::AddLitePhotons ( std::map< int, std::map< int, int >> *  StepPhotonTable, bool  Reflected = false  )

inline

Definition at line 55 of file OpDetPhotonTable.h.

References AddPhoton().

    {
      AddPhoton(StepPhotonTable, Reflected);
    }

void larg4::OpDetPhotonTable::AddOpDetBacktrackerRecord	(	sim::OpDetBacktrackerRecord	soc,
		bool	Reflected = false
	)

Definition at line 78 of file OpDetPhotonTable.cxx.

References cOpChannelToSOCMap, cOpDetBacktrackerRecordsCol, cReflectedOpChannelToSOCMap, and cReflectedOpDetBacktrackerRecordsCol.

Referenced by GetReflectedLitePhotonsForOpChannel(), and larg4::OpFastScintillation::RecordPhotonsProduced().

  {
    //    std::cout << "DEBUG: Adding to " << (Reflected?"Reflected":"Direct") << " cOpDetBTR" << std::endl;
    if (!Reflected)
      AddOpDetBacktrackerRecord(cOpDetBacktrackerRecordsCol, cOpChannelToSOCMap, soc);
    else
      AddOpDetBacktrackerRecord(
        cReflectedOpDetBacktrackerRecordsCol, cReflectedOpChannelToSOCMap, soc);
  }

void larg4::OpDetPhotonTable::AddOpDetBacktrackerRecord ( std::vector< sim::OpDetBacktrackerRecord > &  RecordsCol, std::map< int, int > &  ChannelMap, sim::OpDetBacktrackerRecord  soc  )

private

Definition at line 89 of file OpDetPhotonTable.cxx.

References sim::OpDetBacktrackerRecord::OpDetNum(), and sim::OpDetBacktrackerRecord::timePDclockSDPsMap().

  {
    int iChan = soc.OpDetNum();
    std::map<int, int>::iterator channelPosition = ChannelMap.find(iChan);
    if (channelPosition == ChannelMap.end()) {
      ChannelMap[iChan] = RecordsCol.size();
      RecordsCol.emplace_back(std::move(soc));
    }
    else {
      unsigned int idtest = channelPosition->second;
      auto const& timePDclockSDPsMap = soc.timePDclockSDPsMap();
      for (auto const& timePDclockSDP : timePDclockSDPsMap) {
        for (auto const& sdp : timePDclockSDP.second) {
          double xyz[3] = {sdp.x, sdp.y, sdp.z};
          RecordsCol.at(idtest).AddScintillationPhotons(
            sdp.trackID, timePDclockSDP.first, sdp.numPhotons, xyz, sdp.energy);
        } //end sdp : timesdp.second
      }   //end const timesdp : timeSDPMap
    }     // if chanPos == cOpChan else

    //    std::cout << "DEBUG: Add to " << iChan << " to cOpDetBTR. Now " << RecordsCol.size() << " in size " << std::endl;
  } //END void OpDetPhotonTable::AdOpDetBacktrackerRecords

void larg4::OpDetPhotonTable::AddPhoton	(	size_t	opchannel,
		sim::OnePhoton &&	photon,
		bool	Reflected = false
	)

Definition at line 38 of file OpDetPhotonTable.cxx.

References fDetectedPhotons, and fReflectedDetectedPhotons.

Referenced by AddLitePhotons(), larg4::OpDetSensitiveDetector::AddPhoton(), and larg4::OpFastScintillation::RecordPhotonsProduced().

  {
    if (opchannel >= fDetectedPhotons.size()) {

      std::cerr << "<<" << __PRETTY_FUNCTION__ << ">>"
                << "\033[93m"
                << "Invalid channel: " << opchannel << "\033[00m" << std::endl;
      throw std::exception();
    }
    if (!Reflected)
      fDetectedPhotons.at(opchannel).push_back(photon);
    else
      fReflectedDetectedPhotons.at(opchannel).push_back(photon);
  }

void larg4::OpDetPhotonTable::AddPhoton	(	std::map< int, std::map< int, int >> *	StepPhotonTable,
		bool	Reflected = false
	)

Definition at line 63 of file OpDetPhotonTable.cxx.

References fLitePhotons, and fReflectedLitePhotons.

  {
    for (auto it = StepPhotonTable->begin(); it != StepPhotonTable->end(); it++) {
      for (auto in_it = it->second.begin(); in_it != it->second.end(); in_it++) {
        if (!Reflected)
          fLitePhotons[it->first][in_it->first] += in_it->second;
        else
          fReflectedLitePhotons[it->first][in_it->first] += in_it->second;
      }
    }
  }

void larg4::OpDetPhotonTable::ClearEnergyDeposits

(

)

Definition at line 222 of file OpDetPhotonTable.cxx.

References fSimEDepCol.

Referenced by GetReflectedLitePhotonsForOpChannel(), larg4::LArG4::produce(), and YieldSimEnergyDeposits().

  {
    fSimEDepCol.clear();
  }

void larg4::OpDetPhotonTable::ClearTable

(

size_t

nch = 0

)

Definition at line 147 of file OpDetPhotonTable.cxx.

References fDetectedPhotons, fLitePhotons, fReflectedDetectedPhotons, and fReflectedLitePhotons.

Referenced by GetReflectedLitePhotonsForOpChannel(), and larg4::LArG4::produce().

  {
    if (fDetectedPhotons.size() != nch) fDetectedPhotons.resize(nch);
    for (size_t i = 0; i < fDetectedPhotons.size(); ++i) {
      fDetectedPhotons.at(i).clear();
      fDetectedPhotons.at(i).SetChannel(i);
      //fDetectedPhotons.at(i).reserve(10000); // Just a guess on minimum # photons
    }
    if (fReflectedDetectedPhotons.size() != nch) fReflectedDetectedPhotons.resize(nch);
    for (size_t i = 0; i < fReflectedDetectedPhotons.size(); ++i) {
      fReflectedDetectedPhotons.at(i).clear();
      fReflectedDetectedPhotons.at(i).SetChannel(i);
      //fDetectedPhotons.at(i).reserve(10000); // Just a guess on minimum # photons
    }

    for (auto it = fLitePhotons.begin(); it != fLitePhotons.end(); ++it)
      (it->second).clear();
    for (auto it = fReflectedLitePhotons.begin(); it != fReflectedLitePhotons.end(); ++it)
      (it->second).clear();
    fLitePhotons.clear();
    fReflectedLitePhotons.clear();
  }

std::map<int, std::map<int, int> > larg4::OpDetPhotonTable::GetLitePhotons ( bool  Reflected = false )

inline

Definition at line 68 of file OpDetPhotonTable.h.

References fLitePhotons, and fReflectedLitePhotons.

Referenced by GetReflectedLitePhotons(), and larg4::LArG4::produce().

    {
      return (Reflected ? fReflectedLitePhotons : fLitePhotons);
    }

std::map<int, int>& larg4::OpDetPhotonTable::GetLitePhotonsForOpChannel ( int  opchannel )

inline

Definition at line 73 of file OpDetPhotonTable.h.

References fLitePhotons.

    {
      return fLitePhotons[opchannel];
    }

std::vector<sim::SimPhotons>& larg4::OpDetPhotonTable::GetPhotons ( bool  Reflected = false )

inline

Definition at line 60 of file OpDetPhotonTable.h.

References fDetectedPhotons, and fReflectedDetectedPhotons.

Referenced by GetReflectedPhotons(), and larg4::LArG4::produce().

    {
      return (Reflected ? fReflectedDetectedPhotons : fDetectedPhotons);
    }

sim::SimPhotons & larg4::OpDetPhotonTable::GetPhotonsForOpChannel

(

size_t

opchannel

)

Definition at line 171 of file OpDetPhotonTable.cxx.

References fDetectedPhotons.

Referenced by GetReflectedPhotons().

  {
    if (opchannel >= fDetectedPhotons.size()) {
      std::cerr << "<<" << __PRETTY_FUNCTION__ << ">>"
                << "Invalid channel Number: " << opchannel << std::endl;
    }
    return fDetectedPhotons.at(opchannel);
  }

std::map<int, std::map<int, int> > larg4::OpDetPhotonTable::GetReflectedLitePhotons ( )

inline

Definition at line 72 of file OpDetPhotonTable.h.

References GetLitePhotons().

{ return GetLitePhotons(true); }

std::map<int, int>& larg4::OpDetPhotonTable::GetReflectedLitePhotonsForOpChannel ( int  opchannel )

inline

Definition at line 77 of file OpDetPhotonTable.h.

References AddEnergyDeposit(), AddOpDetBacktrackerRecord(), ClearEnergyDeposits(), ClearTable(), energy, fReflectedLitePhotons, GetSimEnergyDeposits(), OpDetPhotonTable(), YieldOpDetBacktrackerRecords(), YieldReflectedOpDetBacktrackerRecords(), and YieldSimEnergyDeposits().

    {
      return fReflectedLitePhotons[opchannel];
    }

std::vector<sim::SimPhotons>& larg4::OpDetPhotonTable::GetReflectedPhotons ( )

inline

Definition at line 64 of file OpDetPhotonTable.h.

References GetPhotons(), GetPhotonsForOpChannel(), and GetReflectedPhotonsForOpChannel().

{ return GetPhotons(true); }

sim::SimPhotons & larg4::OpDetPhotonTable::GetReflectedPhotonsForOpChannel

(

size_t

opchannel

)

Definition at line 181 of file OpDetPhotonTable.cxx.

References fReflectedDetectedPhotons.

Referenced by GetReflectedPhotons().

  {
    if (opchannel >= fReflectedDetectedPhotons.size()) {
      std::cerr << "<<" << __PRETTY_FUNCTION__ << ">>"
                << "Invalid channel Number: " << opchannel << std::endl;
    }
    return fReflectedDetectedPhotons.at(opchannel);
  }

std::unordered_map< std::string, std::vector< sim::SimEnergyDeposit > > const & larg4::OpDetPhotonTable::GetSimEnergyDeposits

(

)

const

Returns the map of energy deposits by volume name.

Definition at line 229 of file OpDetPhotonTable.cxx.

References fSimEDepCol.

Referenced by GetReflectedLitePhotonsForOpChannel().

  {
    return fSimEDepCol;
  }

OpDetPhotonTable * larg4::OpDetPhotonTable::Instance ( bool  LitePhotons = false )

static

Definition at line 31 of file OpDetPhotonTable.cxx.

References OpDetPhotonTable(), and larg4::TheOpDetPhotonTable.

Referenced by larg4::OpDetSensitiveDetector::OpDetSensitiveDetector(), larg4::OpFastScintillation::ProcessStep(), larg4::LArG4::produce(), and larg4::OpFastScintillation::RecordPhotonsProduced().

  {
    if (!TheOpDetPhotonTable) { TheOpDetPhotonTable = new OpDetPhotonTable; }
    return TheOpDetPhotonTable;
  }

std::vector< sim::OpDetBacktrackerRecord > larg4::OpDetPhotonTable::YieldOpDetBacktrackerRecords

(

)

Definition at line 117 of file OpDetPhotonTable.cxx.

References cOpChannelToSOCMap, and cOpDetBacktrackerRecordsCol.

Referenced by GetReflectedLitePhotonsForOpChannel(), and larg4::LArG4::produce().

  {
    // we give the result to the caller, and don't retain it
    std::vector<sim::OpDetBacktrackerRecord> result;
    //    std::cout << "DEBUG: result.size()       = " << result.size() << std::endl;
    //    std::cout << "DEBUG: cOpDetBTRCol.size() = " << cOpDetBacktrackerRecordsCol.size() << std::endl;
    std::swap(result, cOpDetBacktrackerRecordsCol);
    //    std::cout << "DEBUG: std::swap(result, cOpDetBacktrackerRecordsCol);" << std::endl;
    //    std::cout << "DEBUG: result.size()       = " << result.size() << std::endl;
    //    std::cout << "DEBUG: cOpDetBTRCol.size() = " << cOpDetBacktrackerRecordsCol.size() << std::endl;
    cOpChannelToSOCMap.clear();
    return result;
  } // OpDetPhotonTable::YieldOpDetBacktrackerRecords()

std::vector< sim::OpDetBacktrackerRecord > larg4::OpDetPhotonTable::YieldReflectedOpDetBacktrackerRecords

(

)

Definition at line 133 of file OpDetPhotonTable.cxx.

References cReflectedOpChannelToSOCMap, and cReflectedOpDetBacktrackerRecordsCol.

Referenced by GetReflectedLitePhotonsForOpChannel(), and larg4::LArG4::produce().

  {
    // we give the result to the caller, and don't retain it
    std::vector<sim::OpDetBacktrackerRecord> result;
    //    std::cout << "DEBUG: result.size()           = " << result.size() << std::endl;
    //    std::cout << "DEBUG: cReflOpDetBTRCol.size() = " << cReflectedOpDetBacktrackerRecordsCol.size() << std::endl;
    std::swap(result, cReflectedOpDetBacktrackerRecordsCol);
    //    std::cout << "DEBUG: result.size()           = " << result.size() << std::endl;
    //    std::cout << "DEBUG: cReflOpDetBTRCol.size() = " << cReflectedOpDetBacktrackerRecordsCol.size() << std::endl;
    cReflectedOpChannelToSOCMap.clear();
    return result;
  } // OpDetPhotonTable::YieldOpDetBacktrackerRecords()

std::unordered_map< std::string, std::vector< sim::SimEnergyDeposit > > larg4::OpDetPhotonTable::YieldSimEnergyDeposits

(

)

Yields the map of energy deposits by volume name, and resets the internal one.

Definition at line 236 of file OpDetPhotonTable.cxx.

References ClearEnergyDeposits(), and fSimEDepCol.

Referenced by GetReflectedLitePhotonsForOpChannel(), and larg4::LArG4::produce().

  {
    auto data{std::move(fSimEDepCol)};
    ClearEnergyDeposits();
    return data;
  }

Member Data Documentation

std::map<int, int> larg4::OpDetPhotonTable::cOpChannelToSOCMap

private

Definition at line 126 of file OpDetPhotonTable.h.

Referenced by AddOpDetBacktrackerRecord(), and YieldOpDetBacktrackerRecords().

std::vector<sim::OpDetBacktrackerRecord> larg4::OpDetPhotonTable::cOpDetBacktrackerRecordsCol

private

Definition at line 123 of file OpDetPhotonTable.h.

Referenced by AddOpDetBacktrackerRecord(), and YieldOpDetBacktrackerRecords().

std::map<int, int> larg4::OpDetPhotonTable::cReflectedOpChannelToSOCMap

private

Definition at line 127 of file OpDetPhotonTable.h.

Referenced by AddOpDetBacktrackerRecord(), and YieldReflectedOpDetBacktrackerRecords().

std::vector<sim::OpDetBacktrackerRecord> larg4::OpDetPhotonTable::cReflectedOpDetBacktrackerRecordsCol

private

Definition at line 125 of file OpDetPhotonTable.h.

Referenced by AddOpDetBacktrackerRecord(), and YieldReflectedOpDetBacktrackerRecords().

std::vector<sim::SimPhotons> larg4::OpDetPhotonTable::fDetectedPhotons

private

Definition at line 128 of file OpDetPhotonTable.h.

Referenced by AddPhoton(), ClearTable(), GetPhotons(), GetPhotonsForOpChannel(), and OpDetPhotonTable().

std::map<int, std::map<int, int> > larg4::OpDetPhotonTable::fLitePhotons

private

Definition at line 120 of file OpDetPhotonTable.h.

Referenced by AddLitePhoton(), AddPhoton(), ClearTable(), GetLitePhotons(), and GetLitePhotonsForOpChannel().

std::vector<sim::SimPhotons> larg4::OpDetPhotonTable::fReflectedDetectedPhotons

private

Definition at line 129 of file OpDetPhotonTable.h.

Referenced by AddPhoton(), ClearTable(), GetPhotons(), GetReflectedPhotonsForOpChannel(), and OpDetPhotonTable().

std::map<int, std::map<int, int> > larg4::OpDetPhotonTable::fReflectedLitePhotons

private

Definition at line 121 of file OpDetPhotonTable.h.

Referenced by AddLitePhoton(), AddPhoton(), ClearTable(), GetLitePhotons(), and GetReflectedLitePhotonsForOpChannel().

std::unordered_map<std::string, std::vector<sim::SimEnergyDeposit> > larg4::OpDetPhotonTable::fSimEDepCol

private

Definition at line 131 of file OpDetPhotonTable.h.

Referenced by AddEnergyDeposit(), ClearEnergyDeposits(), GetSimEnergyDeposits(), and YieldSimEnergyDeposits().

---

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

• larsim/v09_43_00/source/larsim/LegacyLArG4/OpDetPhotonTable.h
• larsim/v09_43_00/source/larsim/LegacyLArG4/OpDetPhotonTable.cxx