ISF::DNNCaloSimSvc Class Reference

#include <DNNCaloSimSvc.h>

Inheritance diagram for ISF::DNNCaloSimSvc:

Collaboration diagram for ISF::DNNCaloSimSvc:

Public Types
typedef std::map< std::string, std::map< std::string, double > >	NetworkInputs
typedef std::map< std::string, double >	NetworkOutputs
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Public Member Functions
	DNNCaloSimSvc (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters. More...
virtual	~DNNCaloSimSvc () final
	Destructor. More...
virtual StatusCode	initialize () override final
	Athena algorithm's interface methods. More...
virtual StatusCode	finalize () override final
	framework methods More...
StatusCode	initializeNetwork ()
	helper for initialize More...
virtual StatusCode	simulate (ISFParticle &isp, McEventCollection *) override final
	Simulation Call. More...
StatusCode	fillNetworkInputs (const ISF::ISFParticle &isfp, NetworkInputs &inputs, double &trueEnergy)
StatusCode	fillWindowCells (const double etaExtrap, const double phiExtrap, const CaloDetDescrElement *&impactCellDDE)
virtual StatusCode	setupEvent () override final
	Setup Event chain - in case of a begin-of event action is needed. More...
virtual StatusCode	releaseEvent () override final
	Release Event chain - in case of an end-of event action is needed. More...
virtual StatusCode	sysInitialize () override
	Gaudi sysInitialize() methods. More...
std::string &	simSvcDescriptor () override
	Return the simulation service descriptor. More...
virtual StatusCode	setParticleBroker (IParticleBroker *broker) override
	Inform the SimulationSvc about the ParticleBroker svc. More...
virtual StatusCode	simulateVector (const ISFParticleVector &particles, McEventCollection *mcEventCollection, McEventCollection *) override
	Simulation call for vectors of particles. More...
const ChronoEntity *	chronoStart (const IChronoSvc::ChronoTag &tag)
	wrapper call to start chrono with given tag More...
const ChronoEntity *	chronoStop (const IChronoSvc::ChronoTag &tag)
	wrapper call to stop chrono with given tag More...
const StoreGateSvc_t &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
StoreGateSvc_t &	evtStore ()
const StoreGateSvc_t &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
StoreGateSvc_t &	detStore ()
template<class T >
StatusCode	retrieveTool (ToolHandle< T > &thandle)
	templated Tool retrieval - gives unique handling & look and feel More...
template<class T >
StatusCode	retrieveTools (ToolHandleArray< T > &thandleArray)
	templated Tool retrieval - gives unique handling & look and feel More...
template<class T >
StatusCode	recordCollection (T *&coll, const std::string &collName) const
	templated record collection method, will create a new one if not existing More...
template<class T >
StatusCode	retrieveCollection (T *&coll, const std::string &collName, bool forceBreak=true) const
	templated retrieve collection method, boolean steers that force break More...

Public Attributes
std::string	m_paramsFilename
std::string	m_paramsInputArchitecture
std::unique_ptr< lwt::LightweightGraph >	m_graph
ToolHandleArray< ICaloCellMakerTool >	m_caloCellMakerToolsSetup
ToolHandleArray< ICaloCellMakerTool >	m_caloCellMakerToolsRelease
ToolHandle< IFastCaloSimCaloExtrapolation >	m_FastCaloSimCaloExtrapolation
ToolHandle< Trk::ITimedExtrapolator >	m_extrapolator
CaloCellContainer *	m_theContainer
ServiceHandle< IAtRndmGenSvc >	m_rndGenSvc
CLHEP::HepRandomEngine *	m_randomEngine
std::string	m_randomEngineName
const CaloDetDescrManager *	m_caloDetDescrManager
std::unique_ptr< CaloGeometryFromCaloDDM >	m_caloGeo
const LArEM_ID *	m_emID = nullptr
std::vector< CaloCell * >	m_windowCells
int	m_GANLatentSize = 0
double	m_logTrueEnergyMean = 0.
double	m_logTrueEnergyScale = 0.
double	m_riImpactEtaMean = 0.
double	m_riImpactEtaScale = 0.
double	m_riImpactPhiMean = 0.
double	m_riImpactPhiScale = 0.
const int	m_numberOfCellsForDNN = 266
const double	m_middleCellWidthEta = 0.025
const double	m_middleCellWidthPhi = CLHEP::pi / std::pow(2,7)
const double	m_etaRawMiddleCut = m_middleCellWidthEta * 3.5
const double	m_etaRawBackCut = m_middleCellWidthEta * 4.
const double	m_phiRawMiddleCut = m_middleCellWidthPhi * 3.5
const double	m_phiRawStripCut = m_middleCellWidthPhi * 6.0
std::string	m_caloCellsOutputName

Protected Attributes
std::string	m_simDescr {""}
	The simulator service descriptor. More...
std::string	m_screenOutputPrefix {"isf >> "}
	Screen output refinement - can be changed by declareProperty() More...
std::string	m_chronoSvcName {"ChronoStatSvc"}
	Name of the timing service - can be set by declareProperty() More...
IChronoStatSvc *	m_chrono {}
	The timing service for general usage. More...
IParticleBroker *	m_particleBroker {}
	The particle service used to push particles into the simulation. More...

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

Detailed Description

Author

Aishik.Ghosh -at- cern.ch, David Rousseau -at- cern.ch,

Definition at line 56 of file DNNCaloSimSvc.h.

Member Typedef Documentation

NetworkInputs

typedef std::map<std::string, std::map<std::string, double> > ISF::DNNCaloSimSvc::NetworkInputs

Definition at line 75 of file DNNCaloSimSvc.h.

NetworkOutputs

typedef std::map<std::string, double> ISF::DNNCaloSimSvc::NetworkOutputs

Definition at line 76 of file DNNCaloSimSvc.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> ISF::BaseSimulationSvc::StoreGateSvc_t

inherited

Definition at line 135 of file BaseSimulationSvc.h.

Constructor & Destructor Documentation

DNNCaloSimSvc()

ISF::DNNCaloSimSvc::DNNCaloSimSvc	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Constructor with parameters.

Constructor.

Definition at line 55 of file DNNCaloSimSvc.cxx.

                                                                       :
  BaseSimulationSvc(name, svc),
  m_graph(nullptr),
  m_theContainer(nullptr),
  m_rndGenSvc("AtRndmGenSvc", name),
  m_randomEngine(nullptr),
  m_caloDetDescrManager(nullptr),
  m_caloGeo(nullptr)
{
  declareProperty("ParamsInputFilename"            ,       m_paramsFilename="DNNCaloSim/DNNCaloSim_GAN_nn_v0.json"," lwtnn json output describing the trained network");
  declareProperty("ParamsInputArchitecture"        ,       m_paramsInputArchitecture="GANv0","tag describing additional parameters necessary for the network");
  declareProperty("CaloCellsOutputName"            ,       m_caloCellsOutputName) ;
  declareProperty("CaloCellMakerTools_setup"       ,       m_caloCellMakerToolsSetup) ;
  declareProperty("CaloCellMakerTools_release"     ,       m_caloCellMakerToolsRelease) ;
  declareProperty("RandomSvc"                      ,       m_rndGenSvc                );
  declareProperty("RandomStream"                   ,       m_randomEngineName         );
  declareProperty("FastCaloSimCaloExtrapolation"   ,       m_FastCaloSimCaloExtrapolation );
 
}

~DNNCaloSimSvc()

ISF::DNNCaloSimSvc::~DNNCaloSimSvc ( )

finalvirtualdefault

Destructor.

Member Function Documentation

chronoStart()

const ChronoEntity* ISF::BaseSimulationSvc::chronoStart ( const IChronoSvc::ChronoTag &  tag )

inlineinherited

wrapper call to start chrono with given tag

Definition at line 124 of file BaseSimulationSvc.h.

                                                                     {
      if (m_chrono) return m_chrono->chronoStart( tag);
      return nullptr;
    }

chronoStop()

const ChronoEntity* ISF::BaseSimulationSvc::chronoStop ( const IChronoSvc::ChronoTag &  tag )

inlineinherited

wrapper call to stop chrono with given tag

Definition at line 130 of file BaseSimulationSvc.h.

                                                                    {
      if (m_chrono) return m_chrono->chronoStop( tag);
      return nullptr;
    }

detStore() [1/2]

StoreGateSvc_t& ISF::BaseSimulationSvc::detStore ( )

inlineinherited

Definition at line 147 of file BaseSimulationSvc.h.

{return m_detStore;};

detStore() [2/2]

const StoreGateSvc_t& ISF::BaseSimulationSvc::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 146 of file BaseSimulationSvc.h.

{return m_detStore;};

evtStore() [1/2]

StoreGateSvc_t& ISF::BaseSimulationSvc::evtStore ( )

inlineinherited

Definition at line 141 of file BaseSimulationSvc.h.

{return m_evtStore;};

evtStore() [2/2]

const StoreGateSvc_t& ISF::BaseSimulationSvc::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 140 of file BaseSimulationSvc.h.

{return m_evtStore;};

fillNetworkInputs()

StatusCode ISF::DNNCaloSimSvc::fillNetworkInputs	(	const ISF::ISFParticle &	isfp,
		NetworkInputs &	inputs,
		double &	trueEnergy
	)

Definition at line 381 of file DNNCaloSimSvc.cxx.

{
  Amg::Vector3D particle_position =  isfp.position();  
  Amg::Vector3D particle_direction(isfp.momentum().x(),isfp.momentum().y(),isfp.momentum().z());
  
 
  TFCSTruthState truth(isfp.momentum().x(),isfp.momentum().y(),isfp.momentum().z(),sqrt(isfp.momentum().mag2()+pow(isfp.mass(),2)),isfp.pdgCode());
  truth.set_vertex(particle_position[Amg::x], particle_position[Amg::y], particle_position[Amg::z]);
 
  trueEnergy = isfp.ekin();
 
 
  TFCSExtrapolationState extrapol;
  //FIXME this is extrapolating to many layers, when we only need middle layer middle surface
  //FIXME could have dedicated extrapolation to save time 
  m_FastCaloSimCaloExtrapolation->extrapolate(extrapol,&truth);
  //  extrapol.Print();
 
 
  if (false)
    {
      for (int isam=0; isam< CaloCell_ID_FCS::MaxSample ; isam++){
    //enum SUBPOS { SUBPOS_MID = 0, SUBPOS_ENT = 1, SUBPOS_EXT = 2}; //MID=middle, ENT=entrance, EXT=exit of cal layer
 
    for (int isubpos=0; isubpos< 3 ; isubpos++){
      
      ATH_MSG_VERBOSE("EXTRAPO isam=" << isam <<
              " isubpos=" << isubpos <<
              " OK="    << extrapol.OK(isam,isubpos) <<
              " eta="  << extrapol.eta(isam,isubpos) <<
              " phi="  << extrapol.phi(isam,isubpos) <<
              " r="  << extrapol.r(isam,isubpos) );
 
    }
      }
    }
 
  //FIXME deal with endcap as well 
  int isam=CaloCell_ID_FCS::EMB2;
  int isubpos=SUBPOS_ENT;
  double etaExtrap=-999.;
  double phiExtrap=-999.;
  if (extrapol.eta(isam,isubpos)) {
    etaExtrap=extrapol.eta(isam,isubpos);
    phiExtrap=extrapol.phi(isam,isubpos);
  }
 
  ATH_MSG_VERBOSE("Will use isam=" << isam <<
          " isubpos=" << isubpos <<
          " eta="  << etaExtrap << 
          " phi="  << phiExtrap );
 
 
 
  // fill vector of cells, and DDE of middle cell
  const CaloDetDescrElement * impactCellDDE;
  if (fillWindowCells(etaExtrap,phiExtrap,impactCellDDE).isFailure()){
    ATH_MSG_WARNING("Could not build window cells vector ");
    return StatusCode::FAILURE;
  }
 
 
  // start neural network part
  // fill a map of input nodes
  // this is for GAN
  // most likely it should be specialised as a function of m_ParamsInputArchitecture
 
  double randGaussz = 0.;
 
 
  int impactEtaIndex = m_emID->eta(impactCellDDE->identify());
  int impactPhiIndex = m_emID->phi(impactCellDDE->identify());
  double etaRawImpactCell=impactCellDDE->eta_raw();
  double phiRawImpactCell=impactCellDDE->phi_raw();
 
  ATH_MSG_VERBOSE("impact eta_index " << impactEtaIndex 
          << " phi_index " <<  impactPhiIndex  
          << " sampling " << m_emID->sampling(impactCellDDE->identify()));
 
  int pconf = impactPhiIndex % 4 ;
  int econf = (impactEtaIndex + 1) % 2 ; // ofset corresponds to difference in index calculated for neural net preprocessing
 
  double riImpactEta = (etaExtrap - etaRawImpactCell);
  // mirror for left half
  if (etaExtrap < 0){
    riImpactEta *= -1.;
 
  }
  // scale & centre
  riImpactEta = (riImpactEta - m_riImpactEtaMean)/m_riImpactEtaScale;
  double riImpactPhi = (CaloPhiRange::diff(phiExtrap, phiRawImpactCell) - m_riImpactPhiMean)/m_riImpactPhiScale;
 
 
  // fill randomize latent space
  TFCSSimulationState simulstate(m_randomEngine);
 
  //FIXME generate in one go
  for (int i = 0; i< m_GANLatentSize; i ++)
    {
      randGaussz = CLHEP::RandGaussZiggurat::shoot(simulstate.randomEngine(), 0., 1.);
      inputs["Z"].insert ( std::pair<std::string,double>(std::to_string(i), randGaussz) );
 
    }
 
  // fill preprocessed true energy
  inputs["E_true"].insert ( std::pair<std::string,double>("0", (std::log(trueEnergy) - m_logTrueEnergyMean)/m_logTrueEnergyScale) );
  // fill p,e configurations multi-hot vector
  for (int i = 0; i< 4; i ++)
    {
      if (i == pconf){
    inputs["pconfig"].insert ( std::pair<std::string,double>(std::to_string(i),1.) );
      }
      else{
    inputs["pconfig"].insert ( std::pair<std::string,double>(std::to_string(i),0.) );
      }
    }
  for (int i = 0; i< 2; i ++){
    if (i == econf){
      inputs["econfig"].insert ( std::pair<std::string,double>(std::to_string(i),1.) );
    }
    else{
      inputs["econfig"].insert ( std::pair<std::string,double>(std::to_string(i),0.) );
    }
  }
  // fill position of extrap particle in impact cell
  inputs["ripos"].insert ( std::pair<std::string,double>("0", riImpactEta) ); 
  inputs["ripos"].insert ( std::pair<std::string,double>("1", riImpactPhi ) );
 
  return StatusCode::SUCCESS;
}

fillWindowCells()

StatusCode ISF::DNNCaloSimSvc::fillWindowCells	(	const double	etaExtrap,
		const double	phiExtrap,
		const CaloDetDescrElement *&	impactCellDDE
	)

Definition at line 513 of file DNNCaloSimSvc.cxx.

                                                                                                                                     {
  
  //now find the cell it corresponds to  
  //FIXME this is barrel should also look in endcap 
  // (note that is really looking up eta, phi, not raw eta phi
  impactCellDDE=m_caloDetDescrManager->get_element(CaloCell_ID::EMB2,etaExtrap,phiExtrap);
  if (impactCellDDE==nullptr){
    ATH_MSG_WARNING("No cell found for this eta " << etaExtrap << " phi " << phiExtrap);
    return StatusCode::FAILURE;
  }
 
 
 
 
  const int caloHashImpactCell=impactCellDDE->calo_hash();
  const double etaImpactCell=impactCellDDE->eta();
  const double phiImpactCell=impactCellDDE->phi();
  const double etaRawImpactCell=impactCellDDE->eta_raw();
  const double phiRawImpactCell=impactCellDDE->phi_raw();
 
 
  ATH_MSG_VERBOSE("impact cell calohash=" << caloHashImpactCell <<
          " eta="  << etaImpactCell << 
          " phi="  << phiImpactCell <<
          " eta raw="  << etaRawImpactCell << 
          " phi raw="  << phiRawImpactCell );
 
 
  int nSqCuts = 0;
 
 
  // select the cells DNN will simulate 
  // note that m_theCellContainer has all the calorimeter cells
  // this will hold the list of cells to simulate
  //FIXME this can be sped up certainly
  m_windowCells.clear();
  CaloCell_ID::CaloSample sampling;
  float eta_raw;
  float phi_raw;
  for(CaloCell* theCell : * m_theContainer) {
    sampling = theCell->caloDDE()->getSampling();
    eta_raw = theCell->caloDDE()->eta_raw();
    phi_raw = theCell->caloDDE()->phi_raw();
    if (( eta_raw < etaRawImpactCell + m_etaRawBackCut) && (eta_raw > etaRawImpactCell - m_etaRawBackCut)) {
      if ((CaloPhiRange::diff(phi_raw, phiRawImpactCell) < m_phiRawStripCut ) && (CaloPhiRange::diff(phi_raw, phiRawImpactCell) > - m_phiRawStripCut) ) {
 
      }
      else{
        continue;
      }
    }
    else{
      continue;
    }
 
    if ((sampling == 0) || (sampling == 1) ){
      if ((eta_raw < etaRawImpactCell + m_etaRawMiddleCut) && (eta_raw > etaRawImpactCell - m_etaRawMiddleCut)) {
           nSqCuts ++;
        // add to vector
        m_windowCells.push_back(theCell);
    
      }
    }
    else if(sampling == 2) {
      if ((CaloPhiRange::diff(phi_raw , phiRawImpactCell) < m_phiRawMiddleCut) && (CaloPhiRange::diff(phi_raw, phiRawImpactCell) > - m_phiRawMiddleCut)) {
           if ((eta_raw < etaRawImpactCell + m_etaRawMiddleCut) && (eta_raw > etaRawImpactCell - m_etaRawMiddleCut)) {
             nSqCuts ++;
             m_windowCells.push_back(theCell);
           }
      }
    }
 
    else if(sampling == 3){
      if ((CaloPhiRange::diff(phi_raw, phiRawImpactCell) <  m_phiRawMiddleCut) && (CaloPhiRange::diff(phi_raw , phiRawImpactCell) > - m_phiRawMiddleCut )) {
        nSqCuts ++;
        m_windowCells.push_back(theCell);
      }
 
    }
  }
 
  if (nSqCuts != m_numberOfCellsForDNN){
    ATH_MSG_WARNING("Total cells passing DNN selection is " << nSqCuts << " but should be " << m_numberOfCellsForDNN );
    // bail out, but do not stop the job
    return StatusCode::FAILURE;
 
  }
 
  //sort cells within the cluster like they are fed to DNN
  if (etaRawImpactCell < 0){
    std::sort(m_windowCells.begin(), m_windowCells.end(), &compCellsForDNNSortMirror);
  }
  else{
    std::sort(m_windowCells.begin(), m_windowCells.end(), &compCellsForDNNSort);
  }
 
  return StatusCode::SUCCESS;
 
}

finalize()

StatusCode ISF::DNNCaloSimSvc::finalize ( )

finaloverridevirtual

framework methods

Definition at line 185 of file DNNCaloSimSvc.cxx.

{
  ATH_MSG_INFO(m_screenOutputPrefix << "Finalizing ...");
  return StatusCode::SUCCESS;
}

initialize()

StatusCode ISF::DNNCaloSimSvc::initialize ( )

finaloverridevirtual

Athena algorithm's interface methods.

framework methods

Definition at line 79 of file DNNCaloSimSvc.cxx.

{
 
  ATH_MSG_INFO(m_screenOutputPrefix << "Initializing ...");
 
  ATH_CHECK(m_rndGenSvc.retrieve());
  m_randomEngine = m_rndGenSvc->GetEngine( m_randomEngineName);
  if(!m_randomEngine)
    {
      ATH_MSG_ERROR("Could not get random number engine from RandomNumberService. Abort.");
      return StatusCode::FAILURE;
    }
  
  m_caloDetDescrManager = detStore()->tryConstRetrieve<CaloDetDescrManager>(caloMgrStaticKey);
  if(!m_caloDetDescrManager) {
    std::unique_ptr<CaloDetDescrManager> caloMgrPtr = buildCaloDetDescrNoAlign(serviceLocator()
                                           , Athena::getMessageSvc());
    ATH_CHECK(detStore()->record(std::move(caloMgrPtr), caloMgrStaticKey));
    ATH_CHECK(detStore()->retrieve(m_caloDetDescrManager, caloMgrStaticKey));
  }
 
  const FCALDetectorManager * fcalManager=nullptr;
  ATH_CHECK(detStore()->retrieve(fcalManager));
 
  // cppcheck-suppress nullPointerRedundantCheck; false positive
  const CaloIdManager* caloId_mgr = m_caloDetDescrManager->getCalo_Mgr();
  m_emID = caloId_mgr->getEM_ID();
  
  m_caloGeo = std::make_unique<CaloGeometryFromCaloDDM>();
  m_caloGeo->LoadGeometryFromCaloDDM(m_caloDetDescrManager);
  if(!m_caloGeo->LoadFCalChannelMapFromFCalDDM(fcalManager) )ATH_MSG_FATAL("Found inconsistency between FCal_Channel map and GEO file. Please, check if they are configured properly.");
 
 
  // initialize DNN 
  if (initializeNetwork().isFailure())
    {
      ATH_MSG_ERROR("Could not initialize network ");
      return StatusCode::FAILURE;
 
    }
 
  
  // Get FastCaloSimCaloExtrapolation
  if(m_FastCaloSimCaloExtrapolation.retrieve().isFailure())
    {
      ATH_MSG_ERROR("FastCaloSimCaloExtrapolation not found ");
      return StatusCode::FAILURE;
    }
 
  m_windowCells.reserve(m_numberOfCellsForDNN);
  
 
 
  return StatusCode::SUCCESS;
}

initializeNetwork()

StatusCode ISF::DNNCaloSimSvc::initializeNetwork

(

)

helper for initialize

Definition at line 136 of file DNNCaloSimSvc.cxx.

{
 
 
 
  // get neural net JSON file as an std::istream object
  std::string inputFile=PathResolverFindCalibFile(m_paramsFilename);
  if (inputFile.empty()){
    ATH_MSG_ERROR("Could not find json file " << m_paramsFilename );
    return StatusCode::FAILURE;
  } 
 
 
 
  ATH_MSG_INFO("Using json file " << inputFile );
  std::ifstream input(inputFile);
  // build the graph
  m_graph=std::make_unique<lwt::LightweightGraph>(lwt::parse_json_graph(input) );
  if (m_graph==nullptr){
    ATH_MSG_ERROR("Could not create LightWeightGraph from  " << m_paramsFilename );
    return StatusCode::FAILURE;
  }
 
 
 
  // initialize all necessary constants
  // FIXME eventually all these could be stored in the .json file
 
  ATH_MSG_INFO("Using ParamsInputArchitecture: " << m_paramsInputArchitecture );
  if (m_paramsInputArchitecture=="GANv0") // GAN then VAE etc...
    {
      m_GANLatentSize = 300;
      m_logTrueEnergyMean = 9.70406053;
      m_logTrueEnergyScale = 1.76099569;
      m_riImpactEtaMean = 3.47603256e-05;
      m_riImpactEtaScale = 0.00722316;
      m_riImpactPhiMean = -5.42153684e-05;
      m_riImpactPhiScale = 0.00708241;
    }
 
  if (m_GANLatentSize==0){
    ATH_MSG_ERROR("m_GANLatentSize uninitialized!.ParamsInputArchitecture= " << m_paramsInputArchitecture );
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}

recordCollection()

template<class T >

StatusCode ISF::BaseSimulationSvc::recordCollection ( T *&  coll, const std::string &  collName  ) const

inlineinherited

templated record collection method, will create a new one if not existing

Definition at line 172 of file BaseSimulationSvc.h.

                                                                           {
      // create if necessary
      coll = coll ? coll : new T;
      // record
      if (evtStore()->record( coll, collName).isFailure()){
        ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot record collection " <<  collName << ". Abort." );
        return StatusCode::FAILURE;
      } else
        ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully recorded collection " << collName);
      return StatusCode::SUCCESS;
    }

releaseEvent()

StatusCode ISF::DNNCaloSimSvc::releaseEvent ( )

finaloverridevirtual

Release Event chain - in case of an end-of event action is needed.

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 256 of file DNNCaloSimSvc.cxx.

{
  const EventContext& ctx = Gaudi::Hive::currentContext();
  ATH_MSG_VERBOSE(m_screenOutputPrefix << "release Event");
 
  CHECK( m_caloCellMakerToolsRelease.retrieve() );
 
  //run release tools in a loop
  ToolHandleArray<ICaloCellMakerTool>::iterator itrTool = m_caloCellMakerToolsRelease.begin();
  ToolHandleArray<ICaloCellMakerTool>::iterator endTool = m_caloCellMakerToolsRelease.end();
  for (; itrTool != endTool; ++itrTool)
    {
      ATH_MSG_VERBOSE( m_screenOutputPrefix << "Calling tool " << itrTool->name() );
  
      StatusCode sc = (*itrTool)->process(m_theContainer, ctx);
  
      if (sc.isFailure())
    {
      ATH_MSG_ERROR( m_screenOutputPrefix << "Error executing tool " << itrTool->name() );
    }
    }
 
  return StatusCode::SUCCESS;
 
}

retrieveCollection()

template<class T >

StatusCode ISF::BaseSimulationSvc::retrieveCollection ( T *&  coll, const std::string &  collName, bool  forceBreak = true  ) const

inlineinherited

templated retrieve collection method, boolean steers that force break

Definition at line 186 of file BaseSimulationSvc.h.

                                                                                                   {
      // check for existence in the soft case
      if (!forceBreak && !evtStore()->contains<T>(collName)) {
        coll = 0;
        ATH_MSG_DEBUG(m_screenOutputPrefix << "Collection does not exists (not required). Ignore.");
        return StatusCode::SUCCESS;
      }
      if ( evtStore()->retrieve(coll, collName).isFailure()){
        ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot retireve collection " <<  collName << ". Abort." );
        return StatusCode::FAILURE;
      } else
        ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully retrieved collection " << collName);
      return StatusCode::SUCCESS;
    }

retrieveTool()

template<class T >

StatusCode ISF::BaseSimulationSvc::retrieveTool ( ToolHandle< T > &  thandle )

inlineinherited

templated Tool retrieval - gives unique handling & look and feel

Definition at line 150 of file BaseSimulationSvc.h.

                                                                      {
      if (!thandle.empty() && thandle.retrieve().isFailure()){
        ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot retrieve " << thandle << ". Abort.");
        return StatusCode::FAILURE;
      } else
        ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully retrieved " << thandle);
      return StatusCode::SUCCESS;
    }

retrieveTools()

template<class T >

StatusCode ISF::BaseSimulationSvc::retrieveTools ( ToolHandleArray< T > &  thandleArray )

inlineinherited

templated Tool retrieval - gives unique handling & look and feel

Definition at line 161 of file BaseSimulationSvc.h.

                                                              {
      if (!thandleArray.empty() && thandleArray.retrieve().isFailure()){
        ATH_MSG_FATAL( m_screenOutputPrefix << "Cannot retrieve " << thandleArray << ". Abort.");
        return StatusCode::FAILURE;
      } else
        ATH_MSG_DEBUG(m_screenOutputPrefix << "Successfully retrieved " << thandleArray);
      return StatusCode::SUCCESS;
    }

setParticleBroker()

virtual StatusCode ISF::BaseSimulationSvc::setParticleBroker ( IParticleBroker *  broker )

inlineoverridevirtualinherited

Inform the SimulationSvc about the ParticleBroker svc.

Definition at line 97 of file BaseSimulationSvc.h.

                                                                            {
      m_particleBroker = broker;
      return StatusCode::SUCCESS;
    }

setupEvent()

StatusCode ISF::DNNCaloSimSvc::setupEvent ( )

finaloverridevirtual

Setup Event chain - in case of a begin-of event action is needed.

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 191 of file DNNCaloSimSvc.cxx.

{
  const EventContext& ctx = Gaudi::Hive::currentContext();
  ATH_MSG_INFO(m_screenOutputPrefix << "setupEvent NEW EVENT! ");
 
  m_theContainer = new CaloCellContainer(SG::VIEW_ELEMENTS);
 
  StatusCode sc = evtStore()->record(m_theContainer, m_caloCellsOutputName);
  if (sc.isFailure())
    {
      ATH_MSG_FATAL( m_screenOutputPrefix << "cannot record CaloCellContainer " << m_caloCellsOutputName );
      return StatusCode::FAILURE;
    }
 
  //FIXME why retrieve every event ?
  CHECK( m_caloCellMakerToolsSetup.retrieve() );
  ATH_MSG_DEBUG( "Successfully retrieve CaloCellMakerTools: " << m_caloCellMakerToolsSetup );
  ToolHandleArray<ICaloCellMakerTool>::iterator itrTool = m_caloCellMakerToolsSetup.begin();
  ToolHandleArray<ICaloCellMakerTool>::iterator endTool = m_caloCellMakerToolsSetup.end();
  for (; itrTool != endTool; ++itrTool)
    {
      std::string chronoName=this->name()+"_"+ itrTool->name();
      if (m_chrono) m_chrono->chronoStart(chronoName);
      StatusCode sc = (*itrTool)->process(m_theContainer, ctx);
      if (m_chrono) {
    m_chrono->chronoStop(chronoName);
    ATH_MSG_DEBUG( m_screenOutputPrefix << "Chrono stop : delta " << m_chrono->chronoDelta (chronoName,IChronoStatSvc::USER) * CLHEP::microsecond / CLHEP::second << " second " );
      }
 
      if (sc.isFailure())
    {
      ATH_MSG_ERROR( m_screenOutputPrefix << "Error executing tool " << itrTool->name() );
      return StatusCode::FAILURE;
    }
    }
 
 
  // FIXME just for debugging
  // exercise window building 
  // should be false by default 
  // careful:if enabled change the random number sequence !
  if (false){
    TFCSSimulationState testsimulstate(m_randomEngine);
    const CaloDetDescrElement * testImpactCellDDE;
    const int ntrial=100;
    ATH_MSG_INFO ("Trial window building on " << ntrial << " dummy eta phi " );
    for (int i=0 ; i< ntrial ; i++){
      const double eta = CLHEP::RandFlat::shoot(testsimulstate.randomEngine(), 0.2, 0.25);
      const double phi = CLHEP::RandFlat::shoot(testsimulstate.randomEngine(), -CLHEP::pi , CLHEP::pi);
      
      //randomise eta, phi
      if (fillWindowCells(eta,phi,testImpactCellDDE).isFailure()){
      ATH_MSG_WARNING("Could not build trial window cells vector with eta " << eta << " phi " << phi);
      }
    }
    ATH_MSG_INFO ("End of trial window building on " << ntrial << " dummy eta phi " );
    
  }
 
 
 
 
  return StatusCode::SUCCESS;
}

simSvcDescriptor()

std::string& ISF::BaseSimulationSvc::simSvcDescriptor ( )

inlineoverrideinherited

Return the simulation service descriptor.

Definition at line 86 of file BaseSimulationSvc.h.

{ return m_simDescr; }

simulate()

StatusCode ISF::DNNCaloSimSvc::simulate ( ISF::ISFParticle &  isfp, McEventCollection *    )

finaloverridevirtual

Simulation Call.

Reimplemented from ISF::BaseSimulationSvc.

Definition at line 330 of file DNNCaloSimSvc.cxx.

{
 
  ATH_MSG_VERBOSE("NEW PARTICLE! DNNCaloSimSvc called with ISFParticle: " << isfp);
 
 
  //Don't simulate particles with total energy below 10 MeV
  if(isfp.ekin() < 10) {
    ATH_MSG_VERBOSE("Skipping particle with Ekin: " << isfp.ekin() <<" MeV. Below the 10 MeV threshold.");
    return StatusCode::SUCCESS;
  }
 
 
  //Compute all inputs to the network
  NetworkInputs inputs;
  double trueEnergy;
  if (fillNetworkInputs(isfp,inputs,trueEnergy).isFailure()) {
    ATH_MSG_WARNING("Could not initialize network ");
    // bail out but do not stop the job
    return StatusCode::SUCCESS;
  }
 
 
  // compute the network output values
  ATH_MSG_VERBOSE("neural network input = "<<inputs);
  NetworkOutputs outputs = m_graph->compute(inputs);
  ATH_MSG_VERBOSE("neural network output = "<<outputs);
 
 
  // add network output energy in the right place in the calorimeter
  int itr = 0;
  for ( auto & windowCell : m_windowCells) {
    windowCell->addEnergy(trueEnergy * outputs[std::to_string(itr)]);
    itr++;
 
    ATH_MSG_VERBOSE(" cell eta_raw " << windowCell->caloDDE()->eta_raw() 
            << " phi_raw " << windowCell->caloDDE()->phi_raw() 
            << " sampling " << windowCell->caloDDE()->getSampling() 
            << " energy " << windowCell->energy());
  }
 
 
 
 
  
  return StatusCode::SUCCESS;
}

simulateVector()

virtual StatusCode ISF::BaseSimulationSvc::simulateVector ( const ISFParticleVector &  particles, McEventCollection *  mcEventCollection, McEventCollection *    )

inlineoverridevirtualinherited

Simulation call for vectors of particles.

Reimplemented in iGeant4::Geant4SimSvc.

Definition at line 103 of file BaseSimulationSvc.h.

                                                                                                                                              {
      // this implementation is a wrapper in case the simulator does
      // implement particle-vector input
      bool success = true;
      // simulate each particle individually
      for (ISF::ISFParticle* part : particles) {
        ATH_MSG_VERBOSE( m_screenOutputPrefix <<  "Starting simulation of particle: " << part );
        if ( this->simulate(*part, mcEventCollection).isFailure()) {
          ATH_MSG_WARNING("Simulation of particle failed!" << endmsg <<
                          "   -> simulator: " << this->simSvcDescriptor() <<
                          "   -> particle : " << *part );
          success = false;
        }
      }
      return ( success ) ? StatusCode::SUCCESS : StatusCode::FAILURE;
    }

sysInitialize()

virtual StatusCode ISF::BaseSimulationSvc::sysInitialize ( )

inlineoverridevirtualinherited

Gaudi sysInitialize() methods.

Definition at line 71 of file BaseSimulationSvc.h.

    {
      if ( AthService::sysInitialize().isFailure() ) {
        ATH_MSG_FATAL( m_screenOutputPrefix << " Cannot initialize AthService! Abort.");
        return StatusCode::FAILURE;
      }
      if ( serviceLocator()->service(m_chronoSvcName, m_chrono ).isFailure()){
        ATH_MSG_FATAL( m_screenOutputPrefix << " Cannot retrieve ChronoStatSvc! Abort.");
        return StatusCode::FAILURE;
      }
 
      return StatusCode::SUCCESS;
    }

Member Data Documentation

m_caloCellMakerToolsRelease

ToolHandleArray<ICaloCellMakerTool> ISF::DNNCaloSimSvc::m_caloCellMakerToolsRelease

Definition at line 92 of file DNNCaloSimSvc.h.

m_caloCellMakerToolsSetup

ToolHandleArray<ICaloCellMakerTool> ISF::DNNCaloSimSvc::m_caloCellMakerToolsSetup

Definition at line 91 of file DNNCaloSimSvc.h.

m_caloCellsOutputName

std::string ISF::DNNCaloSimSvc::m_caloCellsOutputName

Definition at line 129 of file DNNCaloSimSvc.h.

m_caloDetDescrManager

const CaloDetDescrManager* ISF::DNNCaloSimSvc::m_caloDetDescrManager

Definition at line 104 of file DNNCaloSimSvc.h.

m_caloGeo

std::unique_ptr<CaloGeometryFromCaloDDM> ISF::DNNCaloSimSvc::m_caloGeo

Definition at line 105 of file DNNCaloSimSvc.h.

m_chrono

IChronoStatSvc* ISF::BaseSimulationSvc::m_chrono {}

protectedinherited

The timing service for general usage.

Definition at line 223 of file BaseSimulationSvc.h.

m_chronoSvcName

std::string ISF::BaseSimulationSvc::m_chronoSvcName {"ChronoStatSvc"}

protectedinherited

Name of the timing service - can be set by declareProperty()

Definition at line 220 of file BaseSimulationSvc.h.

m_detStore

StoreGateSvc_t ISF::BaseSimulationSvc::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 209 of file BaseSimulationSvc.h.

m_emID

const LArEM_ID* ISF::DNNCaloSimSvc::m_emID = nullptr

Definition at line 106 of file DNNCaloSimSvc.h.

m_etaRawBackCut

const double ISF::DNNCaloSimSvc::m_etaRawBackCut = m_middleCellWidthEta * 4.

Definition at line 124 of file DNNCaloSimSvc.h.

m_etaRawMiddleCut

const double ISF::DNNCaloSimSvc::m_etaRawMiddleCut = m_middleCellWidthEta * 3.5

Definition at line 123 of file DNNCaloSimSvc.h.

m_evtStore

StoreGateSvc_t ISF::BaseSimulationSvc::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 206 of file BaseSimulationSvc.h.

m_extrapolator

ToolHandle<Trk::ITimedExtrapolator> ISF::DNNCaloSimSvc::m_extrapolator

Definition at line 95 of file DNNCaloSimSvc.h.

m_FastCaloSimCaloExtrapolation

ToolHandle<IFastCaloSimCaloExtrapolation> ISF::DNNCaloSimSvc::m_FastCaloSimCaloExtrapolation

Definition at line 94 of file DNNCaloSimSvc.h.

m_GANLatentSize

int ISF::DNNCaloSimSvc::m_GANLatentSize = 0

Definition at line 111 of file DNNCaloSimSvc.h.

m_graph

std::unique_ptr<lwt::LightweightGraph> ISF::DNNCaloSimSvc::m_graph

Definition at line 89 of file DNNCaloSimSvc.h.

m_logTrueEnergyMean

double ISF::DNNCaloSimSvc::m_logTrueEnergyMean = 0.

Definition at line 112 of file DNNCaloSimSvc.h.

m_logTrueEnergyScale

double ISF::DNNCaloSimSvc::m_logTrueEnergyScale = 0.

Definition at line 113 of file DNNCaloSimSvc.h.

m_middleCellWidthEta

const double ISF::DNNCaloSimSvc::m_middleCellWidthEta = 0.025

Definition at line 121 of file DNNCaloSimSvc.h.

m_middleCellWidthPhi

const double ISF::DNNCaloSimSvc::m_middleCellWidthPhi = CLHEP::pi / std::pow(2,7)

Definition at line 122 of file DNNCaloSimSvc.h.

m_numberOfCellsForDNN

const int ISF::DNNCaloSimSvc::m_numberOfCellsForDNN = 266

Definition at line 120 of file DNNCaloSimSvc.h.

m_paramsFilename

std::string ISF::DNNCaloSimSvc::m_paramsFilename

Definition at line 86 of file DNNCaloSimSvc.h.

m_paramsInputArchitecture

std::string ISF::DNNCaloSimSvc::m_paramsInputArchitecture

Definition at line 87 of file DNNCaloSimSvc.h.

m_particleBroker

IParticleBroker* ISF::BaseSimulationSvc::m_particleBroker {}

protectedinherited

The particle service used to push particles into the simulation.

Definition at line 226 of file BaseSimulationSvc.h.

m_phiRawMiddleCut

const double ISF::DNNCaloSimSvc::m_phiRawMiddleCut = m_middleCellWidthPhi * 3.5

Definition at line 125 of file DNNCaloSimSvc.h.

m_phiRawStripCut

const double ISF::DNNCaloSimSvc::m_phiRawStripCut = m_middleCellWidthPhi * 6.0

Definition at line 126 of file DNNCaloSimSvc.h.

m_randomEngine

CLHEP::HepRandomEngine* ISF::DNNCaloSimSvc::m_randomEngine

Definition at line 100 of file DNNCaloSimSvc.h.

m_randomEngineName

std::string ISF::DNNCaloSimSvc::m_randomEngineName

Definition at line 101 of file DNNCaloSimSvc.h.

m_riImpactEtaMean

double ISF::DNNCaloSimSvc::m_riImpactEtaMean = 0.

Definition at line 114 of file DNNCaloSimSvc.h.

m_riImpactEtaScale

double ISF::DNNCaloSimSvc::m_riImpactEtaScale = 0.

Definition at line 115 of file DNNCaloSimSvc.h.

m_riImpactPhiMean

double ISF::DNNCaloSimSvc::m_riImpactPhiMean = 0.

Definition at line 116 of file DNNCaloSimSvc.h.

m_riImpactPhiScale

double ISF::DNNCaloSimSvc::m_riImpactPhiScale = 0.

Definition at line 117 of file DNNCaloSimSvc.h.

m_rndGenSvc

ServiceHandle<IAtRndmGenSvc> ISF::DNNCaloSimSvc::m_rndGenSvc

Definition at line 99 of file DNNCaloSimSvc.h.

m_screenOutputPrefix

std::string ISF::BaseSimulationSvc::m_screenOutputPrefix {"isf >> "}

protectedinherited

Screen output refinement - can be changed by declareProperty()

Definition at line 217 of file BaseSimulationSvc.h.

m_simDescr

std::string ISF::BaseSimulationSvc::m_simDescr {""}

protectedinherited

The simulator service descriptor.

Definition at line 214 of file BaseSimulationSvc.h.

m_theContainer

CaloCellContainer* ISF::DNNCaloSimSvc::m_theContainer

Definition at line 97 of file DNNCaloSimSvc.h.

m_windowCells

std::vector<CaloCell*> ISF::DNNCaloSimSvc::m_windowCells

Definition at line 107 of file DNNCaloSimSvc.h.

---

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

• DNNCaloSimSvc.h
• DNNCaloSimSvc.cxx