FCS_StepInfoSD Class Reference

Common sensitive detector class for LAr systems. More...

#include <FCS_StepInfoSD.h>

Inheritance diagram for FCS_StepInfoSD:

Collaboration diagram for FCS_StepInfoSD:

Public Member Functions
	FCS_StepInfoSD (G4String a_name, const FCS_Param::Config &config)
	Constructor. More...
virtual G4bool	ProcessHits (G4Step *a_step, G4TouchableHistory *) override
	Main processing method. More...
void	EndOfAthenaEvent (ISF_FCS_Parametrization::FCS_StepInfoCollection *hitContnainer)
	End of athena event processing. More...
void	setupHelpers (const LArEM_ID *EM, const LArFCAL_ID *FCAL, const LArHEC_ID *HEC, const TileID *tile)
	Sets the ID helper pointers. More...

Protected Member Functions
void	getCaloDDManager ()
	Keep a map instead of trying to keep the full vector. More...
void	update_map (const CLHEP::Hep3Vector &l_vec, const Identifier &l_identifier, double l_energy, double l_time, bool l_valid, int l_detector, double timeWindow, double distanceWindow)

Protected Attributes
FCS_Param::Config	m_config
const LArEM_ID *	m_larEmID {nullptr}
	Pointers to the identifier helpers. More...
const LArFCAL_ID *	m_larFcalID {nullptr}
const LArHEC_ID *	m_larHecID {nullptr}
const TileID *	m_tileID {nullptr}
CxxUtils::CachedPointer< const CaloDetDescrManager >	m_calo_dd_man
std::map< Identifier, std::vector< ISF_FCS_Parametrization::FCS_StepInfo * > * >	m_hit_map

Private Member Functions
double	getMaxTime (const CaloCell_ID::CaloSample &layer) const
double	getMaxRadius (const CaloCell_ID::CaloSample &layer) const
double	getMaxDeltaR (const CaloCell_ID::CaloSample &layer) const
double	getMaxDeltaEta (const CaloCell_ID::CaloSample &layer) const
double	getMaxDeltaPhi (const CaloCell_ID::CaloSample &layer) const

Detailed Description

Common sensitive detector class for LAr systems.

This SD implementation saves the standard LArHits. See LArG4CalibSD for an SD that handles calibration hits.

Definition at line 92 of file FCS_StepInfoSD.h.

Constructor & Destructor Documentation

FCS_StepInfoSD()

FCS_StepInfoSD::FCS_StepInfoSD	(	G4String	a_name,
		const FCS_Param::Config &	config
	)

Constructor.

Definition at line 23 of file FCS_StepInfoSD.cxx.

  : G4VSensitiveDetector(std::move(a_name))
  , m_config(config)
  , m_calo_dd_man(nullptr)
{
}

Member Function Documentation

EndOfAthenaEvent()

void FCS_StepInfoSD::EndOfAthenaEvent

(

ISF_FCS_Parametrization::FCS_StepInfoCollection *

hitContnainer

)

End of athena event processing.

Definition at line 209 of file FCS_StepInfoSD.cxx.

{
  // Unpack map into vector
  for (auto it : m_hit_map) {
    for (auto *a_s : * it.second) {
      // Giving away ownership of the objects!
      hitContainer->push_back( a_s );
    }
    it.second->clear();
    delete it.second;
  } // Vector of IDs in the map
  m_hit_map.clear();
  if (m_config.verboseLevel > 4) {
    G4cout <<this->GetName()<< " DEBUG EndOfAthenaEvent: After initial cleanup, N=" << hitContainer->size() << G4endl;
  }
  return;
}

getCaloDDManager()

void FCS_StepInfoSD::getCaloDDManager ( )

protected

Keep a map instead of trying to keep the full vector.

At the end of the event we'll push the map back into the FCS_StepInfoCollection in StoreGate.

Definition at line 145 of file FCS_StepInfoSD.cxx.

{
  SG::ReadCondHandleKey<CaloDetDescrManager> caloMgrKey{"CaloDetDescrManager"};
  if(caloMgrKey.initialize().isFailure()) {
    G4ExceptionDescription description;
    description << "Failed to get CaloDetDescrManager!";
    G4Exception("FCS_StepInfoSD", "FCSBadCall", FatalException, description);
    abort();
  }
  SG::ReadCondHandle<CaloDetDescrManager> caloMgr(caloMgrKey,Gaudi::Hive::currentContext());
  m_calo_dd_man.set(*caloMgr);
}

getMaxDeltaEta()

double FCS_StepInfoSD::getMaxDeltaEta ( const CaloCell_ID::CaloSample &  layer ) const

inlineprivate

NB The result of this function should actually be constant for each SD

Definition at line 94 of file FCS_StepInfoSD.cxx.

{
  if(m_config.m_maxRadiusLAr != 25) return 999.;
  if (layer >= CaloCell_ID::PreSamplerB && layer <= CaloCell_ID::EME3) {
    if (layer==CaloCell_ID::PreSamplerB || layer==CaloCell_ID::PreSamplerE) {
      // PS default is 1mm in eta, 5mm in phi, no cut in r
      return m_config.m_maxEtaPS;
    }
    else if (layer==CaloCell_ID::EMB1 || layer==CaloCell_ID::EME1) {
      // EM1 default is 1mm in eta, 5mm in phi, 15mm in r
      return m_config.m_maxEtaEM1;
    }
    else if (layer==CaloCell_ID::EMB2 || layer==CaloCell_ID::EME2) {
      // EM2 default is 1mm in eta, 5mm in phi, 60mm in r
      return m_config.m_maxEtaEM2;
    }
    else if (layer==CaloCell_ID::EMB3 || layer==CaloCell_ID::EME3) {
      // EM3 default is 1mm in eta, 5mm in phi, 8mm in r
      return m_config.m_maxEtaEM3;
    }
  }
  return 999.;
}

getMaxDeltaPhi()

double FCS_StepInfoSD::getMaxDeltaPhi ( const CaloCell_ID::CaloSample &  layer ) const

inlineprivate

NB The result of this function should actually be constant for each SD

Definition at line 119 of file FCS_StepInfoSD.cxx.

{
  if(m_config.m_maxRadiusLAr != 25) return 999.;
  if (layer >= CaloCell_ID::PreSamplerB && layer <= CaloCell_ID::EME3) {
    if (layer==CaloCell_ID::PreSamplerB || layer==CaloCell_ID::PreSamplerE) {
      // PS default is 1mm in eta, 5mm in phi, no cut in r
      return m_config.m_maxPhiPS;
    }
    else if (layer==CaloCell_ID::EMB1 || layer==CaloCell_ID::EME1) {
      // EM1 default is 1mm in eta, 5mm in phi, 15mm in r
      return m_config.m_maxPhiEM1;
    }
    else if (layer==CaloCell_ID::EMB2 || layer==CaloCell_ID::EME2) {
      // EM2 default is 1mm in eta, 5mm in phi, 60mm in r
      return m_config.m_maxPhiEM2;
    }
    else if (layer==CaloCell_ID::EMB3 || layer==CaloCell_ID::EME3) {
      // EM3 default is 1mm in eta, 5mm in phi, 8mm in r
       return m_config.m_maxPhiEM3;
    }
  }
  return 999.;
}

getMaxDeltaR()

double FCS_StepInfoSD::getMaxDeltaR ( const CaloCell_ID::CaloSample &  layer ) const

inlineprivate

NB The result of this function should actually be constant for each SD

Definition at line 69 of file FCS_StepInfoSD.cxx.

{
  if(m_config.m_maxRadiusLAr != 25) return 999.;
  if (layer >= CaloCell_ID::PreSamplerB && layer <= CaloCell_ID::EME3) {
    if (layer==CaloCell_ID::PreSamplerB || layer==CaloCell_ID::PreSamplerE) {
      // PS default is 1mm in eta, 5mm in phi, no cut in r
      return m_config.m_maxrPS;
    }
    else if (layer==CaloCell_ID::EMB1 || layer==CaloCell_ID::EME1) {
      // EM1 default is 1mm in eta, 5mm in phi, 15mm in r
      return m_config.m_maxrEM1;
    }
    else if (layer==CaloCell_ID::EMB2 || layer==CaloCell_ID::EME2) {
      // EM2 default is 1mm in eta, 5mm in phi, 60mm in r
      return m_config.m_maxrEM2;
    }
    else if (layer==CaloCell_ID::EMB3 || layer==CaloCell_ID::EME3) {
      // EM3 default is 1mm in eta, 5mm in phi, 8mm in r
      return m_config.m_maxrEM3;
    }
  }
  return 999.;
}

getMaxRadius()

double FCS_StepInfoSD::getMaxRadius ( const CaloCell_ID::CaloSample &  layer ) const

inlineprivate

NB The result of this function should actually be constant for each SD

Definition at line 54 of file FCS_StepInfoSD.cxx.

{
  if (layer >= CaloCell_ID::PreSamplerB && layer <= CaloCell_ID::EME3) {
    return m_config.m_maxRadiusLAr;
  }
  if (layer >= CaloCell_ID::HEC0  && layer <= CaloCell_ID::HEC3) {
    return m_config.m_maxRadiusHEC;
  }
  if (layer >=CaloCell_ID::FCAL0 && layer <= CaloCell_ID::FCAL2) {
        return m_config.m_maxRadiusFCAL;
  }
  return m_config.m_maxRadius;
}

getMaxTime()

double FCS_StepInfoSD::getMaxTime ( const CaloCell_ID::CaloSample &  layer ) const

inlineprivate

NB The result of this function should actually be constant for each SD

Definition at line 39 of file FCS_StepInfoSD.cxx.

{
  if (layer >= CaloCell_ID::PreSamplerB && layer <= CaloCell_ID::EME3) {
    return m_config.m_maxTimeLAr;
  }
  if (layer >= CaloCell_ID::HEC0  && layer <= CaloCell_ID::HEC3) {
    return m_config.m_maxTimeHEC;
  }
  if (layer >=CaloCell_ID::FCAL0 && layer <= CaloCell_ID::FCAL2) {
    return m_config.m_maxTimeFCAL;
  }
  return m_config.m_maxTime;
}

ProcessHits()

G4bool FCS_StepInfoSD::ProcessHits ( G4Step *  a_step, G4TouchableHistory *    )

overridevirtual

Main processing method.

Reimplemented in LArFCS_StepInfoSD, and TileFCS_StepInfoSD.

Definition at line 30 of file FCS_StepInfoSD.cxx.

{
  G4ExceptionDescription description;
  description << "ProcessHits: Base class method should not be called!!!";
  G4Exception("FCS_StepInfoSD", "FCSBadCall", FatalException, description);
  abort();
  return false;
}

setupHelpers()

void FCS_StepInfoSD::setupHelpers ( const LArEM_ID *  EM, const LArFCAL_ID *  FCAL, const LArHEC_ID *  HEC, const TileID *  tile  )

inline

Sets the ID helper pointers.

Definition at line 106 of file FCS_StepInfoSD.h.

                                         {
    m_larEmID = EM;
    m_larFcalID = FCAL;
    m_larHecID = HEC;
    m_tileID = tile;
  }

update_map()

void FCS_StepInfoSD::update_map ( const CLHEP::Hep3Vector &  l_vec, const Identifier &  l_identifier, double  l_energy, double  l_time, bool  l_valid, int  l_detector, double  timeWindow, double  distanceWindow  )

protected

Definition at line 158 of file FCS_StepInfoSD.cxx.

{
  // NB l_identifier refers to:
  // - the cell identifier for LAr
  // - the PMT identifier for Tile
 
  // Drop any hits that don't have a good identifier attached
  if (!m_calo_dd_man.get()->get_element(l_identifier)) {
    if(m_config.verboseLevel > 4) {
      G4cout<<this->GetName()<<" DEBUG update_map: bad identifier: "<<l_identifier.getString()<<" skipping this hit."<<G4endl;
    }
    return;
  }
 
  auto map_item = m_hit_map.find( l_identifier );
  if (map_item==m_hit_map.end()) {
    m_hit_map[l_identifier] = new std::vector< ISF_FCS_Parametrization::FCS_StepInfo* >;
    m_hit_map[l_identifier]->reserve(200);
    m_hit_map[l_identifier]->push_back( new ISF_FCS_Parametrization::FCS_StepInfo( l_vec , l_identifier , l_energy , l_time , l_valid , l_detector ) );
  }
  else {
 
    // Get the appropriate merging limits
    const CaloCell_ID::CaloSample& layer = m_calo_dd_man.get()->get_element(l_identifier)->getSampling();
    const double tsame(this->getMaxTime(layer));
    bool match = false;
    for (auto *map_it : * map_item->second) {
      // Time check ... both a global flag and a check on the layer
      const double delta_t = std::fabs(map_it->time()-l_time);
      if ( delta_t >= tsame ) { continue; }
      if ( delta_t >= timeWindow ) { continue; }
 
      // Distance check 
      const CLHEP::Hep3Vector & currentPosition = map_it->position();
      const double hit_diff2 = currentPosition.diff2( l_vec );
      // Global distance check
      if ( hit_diff2 >= distanceWindow ) { continue; }
     
      // Found a match.  Make a temporary that will be deleted!
      const ISF_FCS_Parametrization::FCS_StepInfo my_info( l_vec , l_identifier , l_energy , l_time , l_valid , l_detector );
      *map_it += my_info;
      match = true;
      break;
    } // End of search for match in time and space
    if (!match) {
      map_item->second->push_back( new ISF_FCS_Parametrization::FCS_StepInfo( l_vec , l_identifier , l_energy , l_time , l_valid , l_detector ) );
    } // Didn't match
  } // ID already in the map
  return;
} // That's it for updating the map!

Member Data Documentation

m_calo_dd_man

CxxUtils::CachedPointer<const CaloDetDescrManager> FCS_StepInfoSD::m_calo_dd_man

protected

Definition at line 128 of file FCS_StepInfoSD.h.

m_config

FCS_Param::Config FCS_StepInfoSD::m_config

protected

Definition at line 122 of file FCS_StepInfoSD.h.

m_hit_map

std::map< Identifier , std::vector< ISF_FCS_Parametrization::FCS_StepInfo* >* > FCS_StepInfoSD::m_hit_map

protected

Definition at line 129 of file FCS_StepInfoSD.h.

m_larEmID

const LArEM_ID* FCS_StepInfoSD::m_larEmID {nullptr}

protected

Pointers to the identifier helpers.

Definition at line 124 of file FCS_StepInfoSD.h.

m_larFcalID

const LArFCAL_ID* FCS_StepInfoSD::m_larFcalID {nullptr}

protected

Definition at line 125 of file FCS_StepInfoSD.h.

m_larHecID

const LArHEC_ID* FCS_StepInfoSD::m_larHecID {nullptr}

protected

Definition at line 126 of file FCS_StepInfoSD.h.

m_tileID

const TileID* FCS_StepInfoSD::m_tileID {nullptr}

protected

Definition at line 127 of file FCS_StepInfoSD.h.

---

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

• FCS_StepInfoSD.h
• FCS_StepInfoSD.cxx