Runs simulation including smearing of energy and SiPM saturation for the ECAL readout. More...

Inheritance diagram for gar::rosim::SiPMReadout:

Public Member Functions
	SiPMReadout (fhicl::ParameterSet const &pset)
	Standard constructor and destructor for an FMWK module. More...

virtual	~SiPMReadout ()

	SiPMReadout (SiPMReadout const &)=delete

	SiPMReadout (SiPMReadout &&)=delete

SiPMReadout &	operator= (SiPMReadout const &)=delete

SiPMReadout &	operator= (SiPMReadout &&)=delete

void	produce (::art::Event &evt) override

void	reconfigure (fhicl::ParameterSet const &pset)

Public Member Functions inherited from art::EDProducer
	EDProducer (fhicl::ParameterSet const &pset)

template<typename Config >
	EDProducer (Table< Config > const &config)

std::string	workerType () const

Public Member Functions inherited from art::detail::Producer
virtual	~Producer () noexcept

	Producer (fhicl::ParameterSet const &)

	Producer (Producer const &)=delete

	Producer (Producer &&)=delete

Producer &	operator= (Producer const &)=delete

Producer &	operator= (Producer &&)=delete

void	doBeginJob (SharedResources const &resources)

void	doEndJob ()

void	doRespondToOpenInputFile (FileBlock const &fb)

void	doRespondToCloseInputFile (FileBlock const &fb)

void	doRespondToOpenOutputFiles (FileBlock const &fb)

void	doRespondToCloseOutputFiles (FileBlock const &fb)

bool	doBeginRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doEndRun (RunPrincipal &rp, ModuleContext const &mc)

bool	doBeginSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEndSubRun (SubRunPrincipal &srp, ModuleContext const &mc)

bool	doEvent (EventPrincipal &ep, ModuleContext const &mc, std::atomic< std::size_t > &counts_run, std::atomic< std::size_t > &counts_passed, std::atomic< std::size_t > &counts_failed)

Public Member Functions inherited from art::Modifier
	~Modifier () noexcept

	Modifier ()

	Modifier (Modifier const &)=delete

	Modifier (Modifier &&)=delete

Modifier &	operator= (Modifier const &)=delete

Modifier &	operator= (Modifier &&)=delete

Public Member Functions inherited from art::ModuleBase
virtual	~ModuleBase () noexcept

	ModuleBase ()

ModuleDescription const &	moduleDescription () const

void	setModuleDescription (ModuleDescription const &)

std::array< std::vector< ProductInfo >, NumBranchTypes > const &	getConsumables () const

void	sortConsumables (std::string const &current_process_name)

template<typename T , BranchType BT>
ViewToken< T >	consumesView (InputTag const &tag)

template<typename T , BranchType BT>
ViewToken< T >	mayConsumeView (InputTag const &tag)

Private Member Functions
void	CollectHits (const art::Event &evt, const std::string &label, const std::string &instance, std::vector< art::Ptr< sdp::CaloDeposit > > &hitVector)

std::map< raw::CellID_t, std::vector< art::Ptr< sdp::CaloDeposit > > >	MakeCellIDMapArtPtr (std::vector< art::Ptr< sdp::CaloDeposit > > &hitVector)

Private Attributes
std::string	fG4Label
	label of G4 module More...

std::string	fInstanceLabelName
	product instance name More...

const gar::geo::GeometryCore *	fGeo
	geometry information More...

std::unique_ptr< SiPMReadoutSimAlg >	fROSimAlg
	algorithm to simulate the electronics More...

CLHEP::HepRandomEngine &	fEngine
	random engine More...

Additional Inherited Members
Public Types inherited from art::EDProducer
using	ModuleType = EDProducer

using	WorkerType = WorkerT< EDProducer >

Public Types inherited from art::detail::Producer
template<typename UserConfig , typename KeysToIgnore = void>
using	Table = Modifier::Table< UserConfig, KeysToIgnore >

Public Types inherited from art::Modifier
template<typename UserConfig , typename UserKeysToIgnore = void>
using	Table = ProducerTable< UserConfig, detail::ModuleConfig, UserKeysToIgnore >

Static Public Member Functions inherited from art::EDProducer
static void	commitEvent (EventPrincipal &ep, Event &e)

Protected Member Functions inherited from art::ModuleBase
ConsumesCollector &	consumesCollector ()

template<typename T , BranchType = InEvent>
ProductToken< T >	consumes (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	consumesView (InputTag const &)

template<typename T , BranchType = InEvent>
void	consumesMany ()

template<typename T , BranchType = InEvent>
ProductToken< T >	mayConsume (InputTag const &)

template<typename Element , BranchType = InEvent>
ViewToken< Element >	mayConsumeView (InputTag const &)

template<typename T , BranchType = InEvent>
void	mayConsumeMany ()

Detailed Description

Runs simulation including smearing of energy and SiPM saturation for the ECAL readout.

Randomness

The random number generators used by this process are:

'GEANT' instance: used by Geant4
'propagation' instance: used in electron propagation

Definition at line 59 of file SiPMReadout_module.cc.

Constructor & Destructor Documentation

gar::rosim::SiPMReadout::SiPMReadout ( fhicl::ParameterSet const & pset )

explicit

Standard constructor and destructor for an FMWK module.

Definition at line 97 of file SiPMReadout_module.cc.

       : art::EDProducer{pset},
       fEngine(art::ServiceHandle<rndm::NuRandomService>()->createEngine(*this,pset,"Seed"))
       {
         fGeo = gar::providerFrom<geo::GeometryGAr>();
 
         this->reconfigure(pset);
 
         art::InputTag tag(fG4Label, fInstanceLabelName);
         consumes< std::vector<sdp::CaloDeposit> >(tag);
         produces< std::vector<raw::CaloRawDigit> >(fInstanceLabelName);
         produces< art::Assns<raw::CaloRawDigit, sdp::CaloDeposit>  >(fInstanceLabelName);
 
         return;
       }

gar::rosim::SiPMReadout::~SiPMReadout ( )

virtual

Definition at line 115 of file SiPMReadout_module.cc.

116 {

117 }

gar::rosim::SiPMReadout::SiPMReadout ( SiPMReadout const & )

delete

gar::rosim::SiPMReadout::SiPMReadout ( SiPMReadout && )

delete

Member Function Documentation

void gar::rosim::SiPMReadout::CollectHits	(	const art::Event &	evt,
		const std::string &	label,
		const std::string &	instance,
		std::vector< art::Ptr< sdp::CaloDeposit > > &	hitVector
	)

private

Definition at line 188 of file SiPMReadout_module.cc.

     {
       art::InputTag itag(label, instance);
       auto theHits = evt.getHandle< std::vector<sdp::CaloDeposit> >(itag);
       if (!theHits)
         return;
 
       for (unsigned int i = 0; i < theHits->size(); ++i)
         {
           const art::Ptr<sdp::CaloDeposit> hit(theHits, i);
           hitVector.push_back(hit);
         }
     }

std::map< raw::CellID_t, std::vector< art::Ptr< sdp::CaloDeposit > > > gar::rosim::SiPMReadout::MakeCellIDMapArtPtr ( std::vector< art::Ptr< sdp::CaloDeposit > > & hitVector )

private

Definition at line 203 of file SiPMReadout_module.cc.

     {
       std::map<raw::CellID_t, std::vector< art::Ptr<sdp::CaloDeposit> > > cIDMapArtPtrVec;
 
       for (std::vector< art::Ptr<sdp::CaloDeposit> >::const_iterator iter = hitVector.begin(), iterEnd = hitVector.end(); iter != iterEnd; ++iter)
         {
           art::Ptr<sdp::CaloDeposit> hitPtr = *iter;
           const sdp::CaloDeposit *hit = hitPtr.get();
 
           if( cIDMapArtPtrVec.count(hit->CellID()) == 0 )
             {
               std::vector< art::Ptr<sdp::CaloDeposit> > vecArtPtr;
               vecArtPtr.push_back(hitPtr);
               cIDMapArtPtrVec.insert( std::make_pair(hit->CellID(), vecArtPtr) );
             }
           else
             {
               cIDMapArtPtrVec[hit->CellID()].push_back(hitPtr);
             }
         }
 
       return cIDMapArtPtrVec;
     }

SiPMReadout& gar::rosim::SiPMReadout::operator= ( SiPMReadout const & )

delete

SiPMReadout& gar::rosim::SiPMReadout::operator= ( SiPMReadout && )

delete

void gar::rosim::SiPMReadout::produce ( ::art::Event & evt )

override

Definition at line 145 of file SiPMReadout_module.cc.

     {
       MF_LOG_DEBUG("SiPMReadout") << "produce()";
 
       //Collect the hits to be passed to the algo
       std::vector< art::Ptr<sdp::CaloDeposit> > artHits;
       this->CollectHits(evt, fG4Label, fInstanceLabelName, artHits);
 
       //Get contributions per cellID for association to digi hit
       std::map<raw::CellID_t, std::vector< art::Ptr<sdp::CaloDeposit> > > m_cIDMapArtPtrVec = this->MakeCellIDMapArtPtr(artHits);
 
       //Pass the sim hits to the algo
       fROSimAlg->PrepareAlgo(artHits);
 
       //Perform the digitization
       fROSimAlg->DoDigitization();
 
       //Get the digitized hits
       std::vector< raw::CaloRawDigit* > digiVec = fROSimAlg->GetDigitizedHits();
 
       // loop over the lists and put the particles and voxels into the event as collections
       std::unique_ptr< std::vector<raw::CaloRawDigit> > digitCol (new std::vector<raw::CaloRawDigit>);
       std::unique_ptr< art::Assns<raw::CaloRawDigit, sdp::CaloDeposit> > DigiSimHitsAssns(new art::Assns<raw::CaloRawDigit, sdp::CaloDeposit>);
 
       art::PtrMaker<raw::CaloRawDigit> makeDigiPtr(evt, fInstanceLabelName);
 
       for(auto const &it : digiVec)
         {
           digitCol->emplace_back(*it);
           art::Ptr<raw::CaloRawDigit> digiPtr = makeDigiPtr(digitCol->size() - 1);
           //get the associated vector of art ptr based on cellID
           std::vector< art::Ptr<sdp::CaloDeposit> > simPtrVec = m_cIDMapArtPtrVec[it->CellID()];
           for(auto hitpointer : simPtrVec)
             DigiSimHitsAssns->addSingle(digiPtr, hitpointer);
         }
 
       evt.put(std::move(digitCol), fInstanceLabelName);
       evt.put(std::move(DigiSimHitsAssns), fInstanceLabelName);
 
       return;
     } // CaloReadout::produce()

void gar::rosim::SiPMReadout::reconfigure ( fhicl::ParameterSet const & pset )

Definition at line 120 of file SiPMReadout_module.cc.

     {
       MF_LOG_DEBUG("SiPMReadout") << "Debug: SiPMReadout()";
 
       fG4Label = pset.get<std::string >("G4ModuleLabel", "geant");
       fInstanceLabelName =  pset.get<std::string >("InstanceLabelName", "");
 
       auto ROAlgPars = pset.get<fhicl::ParameterSet>("ReadoutSimAlgPars");
       auto ROAlgName = ROAlgPars.get<std::string>("ReadoutSimType");
 
       if(ROAlgName.compare("Standard_ECAL") == 0) {
         fROSimAlg = std::make_unique<gar::rosim::ECALReadoutSimStandardAlg>(fEngine, ROAlgPars);
       } 
       else if(ROAlgName.compare("Standard_MuID") == 0) {
         fROSimAlg = std::make_unique<gar::rosim::MuIDReadoutSimStandardAlg>(fEngine, ROAlgPars);
       }
       else {
         throw cet::exception("SiPMReadout")
           << "Unable to determine which readout simulation algorithm to use, bail";
       }
 
       return;
     }

Member Data Documentation

CLHEP::HepRandomEngine& gar::rosim::SiPMReadout::fEngine

private

random engine

Definition at line 88 of file SiPMReadout_module.cc.

std::string gar::rosim::SiPMReadout::fG4Label

private

label of G4 module

Definition at line 82 of file SiPMReadout_module.cc.

const gar::geo::GeometryCore* gar::rosim::SiPMReadout::fGeo

private

geometry information

Definition at line 85 of file SiPMReadout_module.cc.

std::string gar::rosim::SiPMReadout::fInstanceLabelName

private

product instance name

Definition at line 83 of file SiPMReadout_module.cc.

std::unique_ptr<SiPMReadoutSimAlg> gar::rosim::SiPMReadout::fROSimAlg

private

algorithm to simulate the electronics

Definition at line 86 of file SiPMReadout_module.cc.

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

garsoft/ReadoutSimulation/SiPMReadout_module.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Randomness

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation