Inheritance diagram for gar::rec::SiPMHitFinder:

Public Member Functions
	SiPMHitFinder (fhicl::ParameterSet const &p)

	SiPMHitFinder (SiPMHitFinder const &)=delete

	SiPMHitFinder (SiPMHitFinder &&)=delete

SiPMHitFinder &	operator= (SiPMHitFinder const &)=delete

SiPMHitFinder &	operator= (SiPMHitFinder &&)=delete

void	produce (art::Event &e) override

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)

Protected Member Functions
void	CollectDigiHits (const art::Event &evt, const std::string &label, const std::string &instance, std::vector< art::Ptr< gar::raw::CaloRawDigit > > &hitVector)

float	CalibrateToMIP (unsigned int ADC)

float	CalibratetoMeV (float x, float y, float z, double MIP)

std::array< double, 3U >	CalculateStripHitPosition (float x, float y, float z, std::pair< float, float > hitTime, raw::CellID_t cID)

float	CorrectStripHitTime (float x, float y, float z, std::pair< float, float > hitTime, raw::CellID_t cID)

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 ()

Private Attributes
std::string	fRawDigitLabel
	label to find the right raw digits More...

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

float	fMIPThreshold
	zero-suppression threshold (in case the raw digits need to be zero-suppressed) More...

bool	fDesaturation
	flag to perform the SiPM desaturation More...

float	fSamplingCorrection

bool	fUseTimePositionReco

const detinfo::DetectorProperties *	fDetProp
	detector properties More...

const geo::GeometryCore *	fGeo
	pointer to the geometry More...

std::unique_ptr< util::SiPMUtils >	fSiPMUtils
	pointer to the Util fcn containing the SiPM desaturation function More...

gar::geo::BitFieldCoder const *	fFieldDecoder

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)

Detailed Description

Definition at line 42 of file SiPMHitFinder_module.cc.

Constructor & Destructor Documentation

gar::rec::SiPMHitFinder::SiPMHitFinder ( fhicl::ParameterSet const & p )

explicit

Definition at line 86 of file SiPMHitFinder_module.cc.

                                                                 : EDProducer{p}
         {
             fRawDigitLabel       = p.get<std::string>("RawDigitLabel", "daqsipm");
             fInstanceLabelName   = p.get<std::string>("InstanceLabelName", "");
 
             fMIPThreshold        = p.get<float>("MIPThreshold", 0.25);
             fDesaturation        = p.get<bool>("Desaturation", false);
             fSamplingCorrection  = p.get<float>("ECALSamplingFactorGeV", 1.0);
             fUseTimePositionReco = p.get<bool>("UseTimePositionReco", true);
 
             fGeo       = gar::providerFrom<geo::GeometryGAr>();
             fDetProp   = gar::providerFrom<detinfo::DetectorPropertiesService>();
             fSiPMUtils = std::make_unique<util::SiPMUtils>(fDetProp->EffectivePixel());
 
             std::string fEncoding = fGeo->GetECALCellIDEncoding();
             art::InputTag tag(fRawDigitLabel, fInstanceLabelName);
             consumes< std::vector<raw::CaloRawDigit> >(tag);
             produces< std::vector<rec::CaloHit> >(fInstanceLabelName);
             produces< art::Assns<rec::CaloHit, raw::CaloRawDigit>  >(fInstanceLabelName);
 
             if(fInstanceLabelName.compare("MuID") == 0) {
                 fEncoding = fGeo->GetMuIDCellIDEncoding();
                 fSamplingCorrection = p.get<float>("MuIDSamplingFactorGeV", 1.0);
             }
 
             fFieldDecoder = new gar::geo::BitFieldCoder( fEncoding );
         }

gar::rec::SiPMHitFinder::SiPMHitFinder ( SiPMHitFinder const & )

delete

gar::rec::SiPMHitFinder::SiPMHitFinder ( SiPMHitFinder && )

delete

Member Function Documentation

std::array< double, 3 > gar::rec::SiPMHitFinder::CalculateStripHitPosition	(	float	x,
		float	y,
		float	z,
		std::pair< float, float >	hitTime,
		raw::CellID_t	cID
	)

protected

Definition at line 256 of file SiPMHitFinder_module.cc.

         {
             std::array<double, 3> point = {x, y, z};
             std::array<double, 3> pointLocal;
             gar::geo::LocalTransformation<TGeoHMatrix> trans;
             fGeo->WorldToLocal(point, pointLocal, trans);
 
             //Calculate the position of the hit based on the time of both SiPM along the strip
             // pos along strip is
             // x = c * (t1 - t2) / 2 (0 is the center of the strip)
             float c = (CLHEP::c_light * CLHEP::mm / CLHEP::ns) / CLHEP::cm; // in cm/ns
             float xlocal = c * ( hitTime.first - hitTime.second ) / 2.;
 
             std::array<double, 3> local_back = fGeo->ReconstructStripHitPosition(point, pointLocal, xlocal, cID);
             std::array<double, 3> world_back;
             fGeo->LocalToWorld(local_back, world_back, trans);
 
             return world_back;
         }

float gar::rec::SiPMHitFinder::CalibratetoMeV	(	float	x,
		float	y,
		float	z,
		double	MIP
	)

protected

Definition at line 241 of file SiPMHitFinder_module.cc.

         {
             float calibrated_MIP = 0.;
             if(MIP <= 0) {
                 return calibrated_MIP;
             }
 
             TVector3 point(x, y, z);
             float factor = fGeo->GetSensVolumeThickness(point) / 0.5;
 
             calibrated_MIP = MIP * fDetProp->MeVtoMIP() * factor;
             return calibrated_MIP; // MeV
         }

float gar::rec::SiPMHitFinder::CalibrateToMIP ( unsigned int ADC )

protected

Definition at line 229 of file SiPMHitFinder_module.cc.

         {
             float calibrated_ADC = 0.;
             if (ADC <= 0) {
                 return calibrated_ADC;
             }
 
             calibrated_ADC = ADC / (fDetProp->LightYield() * fDetProp->SiPMGain());
             return calibrated_ADC;
         }

void gar::rec::SiPMHitFinder::CollectDigiHits	(	const art::Event &	evt,
		const std::string &	label,
		const std::string &	instance,
		std::vector< art::Ptr< gar::raw::CaloRawDigit > > &	hitVector
	)

protected

Definition at line 214 of file SiPMHitFinder_module.cc.

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

float gar::rec::SiPMHitFinder::CorrectStripHitTime	(	float	x,
		float	y,
		float	z,
		std::pair< float, float >	hitTime,
		raw::CellID_t	cID
	)

protected

Definition at line 277 of file SiPMHitFinder_module.cc.

         {
             std::array<double, 3> point = {x, y, z};
             double stripLength = fGeo->getStripLength(point, cID); // in cm
 
             float c = (CLHEP::c_light * CLHEP::mm / CLHEP::ns) / CLHEP::cm; // in cm/ns
             float time = (hitTime.first + hitTime.second) / 2. - (stripLength / (2 * c));
 
             return time;
         }

SiPMHitFinder& gar::rec::SiPMHitFinder::operator= ( SiPMHitFinder const & )

delete

SiPMHitFinder& gar::rec::SiPMHitFinder::operator= ( SiPMHitFinder && )

delete

void gar::rec::SiPMHitFinder::produce ( art::Event & e )

overridevirtual

Implements art::EDProducer.

Definition at line 114 of file SiPMHitFinder_module.cc.

         {
             // create an emtpy output hit collection -- to add to.
             std::unique_ptr< std::vector<rec::CaloHit> > hitCol ( new std::vector< rec::CaloHit > );
             std::unique_ptr< art::Assns<rec::CaloHit, raw::CaloRawDigit> > RecoDigiHitsAssns( new art::Assns<rec::CaloHit, raw::CaloRawDigit> );
 
             //Collect the hits to be passed to the algo
             std::vector< art::Ptr<gar::raw::CaloRawDigit> > artDigiHits;
             this->CollectDigiHits(e, fRawDigitLabel, fInstanceLabelName, artDigiHits);
 
             art::PtrMaker<gar::rec::CaloHit> makeHitPtr(e, fInstanceLabelName);
 
             for (std::vector< art::Ptr<gar::raw::CaloRawDigit> >::const_iterator iter = artDigiHits.begin(), iterEnd = artDigiHits.end(); iter != iterEnd; ++iter)
             {
                 art::Ptr<gar::raw::CaloRawDigit> digiArtPtr = *iter;
                 const gar::raw::CaloRawDigit &digitHit = *(digiArtPtr.get());
 
                 unsigned int hitADC = digitHit.ADC().first;
                 std::pair<float, float> hitTime = digitHit.Time();
                 float x = digitHit.X();
                 float y = digitHit.Y();
                 float z = digitHit.Z();
                 raw::CellID_t cellID = digitHit.CellID();
 
                 //Do Calibration of the hit in MIPs
                 float hitMIP = this->CalibrateToMIP(hitADC);
 
                 if (hitMIP < fMIPThreshold)
                 {
                     MF_LOG_DEBUG("SiPMHitFinder") << "Signal under the " << fMIPThreshold << " MIP threshold" << std::endl;
                     continue;
                 }
 
                 //Desaturation
                 float energy = 0.;
                 if (fDesaturation)
                 {
                     double sat_px = hitMIP * fDetProp->LightYield();
                     //DeSaturate
                     double unsat_px = fSiPMUtils->DeSaturate(sat_px);
 
                     //Calibrate to the MeV scale
                     double unsat_energy = unsat_px / fDetProp->LightYield();
                     energy = this->CalibratetoMeV(x, y, z, unsat_energy);
                 }
                 else {
                     //Calibrate to the MeV scale
                     energy = this->CalibratetoMeV(x, y, z, hitMIP);
                 }
 
                 //Position reconstruction based on time for the strips
                 float pos[3] = {0., 0., 0.};
                 std::pair<float, float> time;
                 const std::array<double, 3> point = { x, y, z };
 
                 if (fGeo->isTile(point, cellID))
                 {
                     pos[0] = x;
                     pos[1] = y;
                     pos[2] = z;
                     time = hitTime;
                 }
                 else {
                     if( fUseTimePositionReco) {
                         std::array<double, 3> strip_pos = this->CalculateStripHitPosition(x, y, z, hitTime, cellID);
                         pos[0] = strip_pos[0];
                         pos[1] = strip_pos[1];
                         pos[2] = strip_pos[2];
                         time = std::make_pair( this->CorrectStripHitTime(pos[0], pos[1], pos[2], hitTime, cellID), 0. );
                     } else {
                         pos[0] = x;
                         pos[1] = y;
                         pos[2] = z;
                         time = hitTime;
                     }
                 }
 
                 //Store the hit (energy in GeV, time in ns, pos in cm and cellID)
                 unsigned int layer = fFieldDecoder->get(cellID, "layer");
                 rec::CaloHit hit(fSamplingCorrection * energy * CLHEP::MeV / CLHEP::GeV, time, pos, cellID, layer);
                 hitCol->emplace_back(hit);
 
                 MF_LOG_DEBUG("SiPMHitFinder") << "recohit " << &hit
                 << " with cellID " << cellID
                 << " has energy " << fSamplingCorrection * energy * CLHEP::MeV / CLHEP::GeV
                 << " pos (" << pos[0] << ", " <<  pos[1] << ", " << pos[2] << ")";
 
                 //Make association between digi hits and reco hits
                 art::Ptr<rec::CaloHit> hitPtr = makeHitPtr(hitCol->size() - 1);
                 RecoDigiHitsAssns->addSingle(hitPtr, digiArtPtr);
             }
 
             //move the reco hit collection
             e.put(std::move(hitCol), fInstanceLabelName);
             e.put(std::move(RecoDigiHitsAssns), fInstanceLabelName);
 
             return;
         }

Member Data Documentation

bool gar::rec::SiPMHitFinder::fDesaturation

private

flag to perform the SiPM desaturation

Definition at line 75 of file SiPMHitFinder_module.cc.

const detinfo::DetectorProperties* gar::rec::SiPMHitFinder::fDetProp

private

detector properties

Definition at line 79 of file SiPMHitFinder_module.cc.

gar::geo::BitFieldCoder const* gar::rec::SiPMHitFinder::fFieldDecoder

private

Definition at line 82 of file SiPMHitFinder_module.cc.

const geo::GeometryCore* gar::rec::SiPMHitFinder::fGeo

private

pointer to the geometry

Definition at line 80 of file SiPMHitFinder_module.cc.

std::string gar::rec::SiPMHitFinder::fInstanceLabelName

private

product instance name

Definition at line 72 of file SiPMHitFinder_module.cc.

float gar::rec::SiPMHitFinder::fMIPThreshold

private

zero-suppression threshold (in case the raw digits need to be zero-suppressed)

Definition at line 74 of file SiPMHitFinder_module.cc.

std::string gar::rec::SiPMHitFinder::fRawDigitLabel

private

label to find the right raw digits

Definition at line 71 of file SiPMHitFinder_module.cc.

float gar::rec::SiPMHitFinder::fSamplingCorrection

private

Definition at line 76 of file SiPMHitFinder_module.cc.

std::unique_ptr<util::SiPMUtils> gar::rec::SiPMHitFinder::fSiPMUtils

private

pointer to the Util fcn containing the SiPM desaturation function

Definition at line 81 of file SiPMHitFinder_module.cc.

bool gar::rec::SiPMHitFinder::fUseTimePositionReco

private

Definition at line 77 of file SiPMHitFinder_module.cc.

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

garsoft/Reco/SiPMHitFinder_module.cc

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation