G4UA::StepHistogramTool Class Reference

Tool which manages the StepHistogram action. More...

#include <StepHistogramTool.h>

Inheritance diagram for G4UA::StepHistogramTool:

Collaboration diagram for G4UA::StepHistogramTool:

Public Member Functions
	StepHistogramTool (const std::string &type, const std::string &name, const IInterface *parent)
	standard tool ctor
virtual StatusCode	initialize () override
	return the event action
virtual StatusCode	finalize () override
virtual StatusCode	fillUserAction (G4AtlasUserActions &actionLists) override final
	Fill the user action lists.
StatusCode	BeginOfAthenaEvent (HitCollectionMap &) override
	Calls BeginOfAthenaEvent.
StatusCode	EndOfAthenaEvent (HitCollectionMap &) override
	Calls EndOfAthenaEvent.

Protected Member Functions
virtual std::unique_ptr< StepHistogram >	makeAndFillAction (G4AtlasUserActions &) override final
	Create action for this thread.

Protected Attributes
ThreadSpecificUserAction< StepHistogram >	m_actions
	Thread-specific storage of the user action.

Private Member Functions
void	BookHistograms (StepHistogram::HistoMapMap_t &hMap, const char *suffix, const char *subfolder="")

Private Attributes
StepHistogram::Config	m_config
ServiceHandle< ITHistSvc >	m_histSvc

Detailed Description

Tool which manages the StepHistogram action.

Create the StepHistogram for each worker thread

Author

Miha Muskinja

Definition at line 23 of file StepHistogramTool.h.

Constructor & Destructor Documentation

StepHistogramTool()

G4UA::StepHistogramTool::StepHistogramTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

standard tool ctor

Definition at line 9 of file StepHistogramTool.cxx.

                                                                :
    UserActionToolBase<StepHistogram>(type, name, parent),
    m_config(),
    m_histSvc("THistSvc", name){
 
    declareProperty("do2DHistograms", m_config.do2DHistograms);
    declareProperty("doGeneralHistograms", m_config.doGeneralHistograms);
  }

Member Function Documentation

BeginOfAthenaEvent()

StatusCode G4UA::UserActionToolBase< StepHistogram >::BeginOfAthenaEvent ( HitCollectionMap & )

inlineoverrideinherited

Calls BeginOfAthenaEvent.

Definition at line 59 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

BookHistograms()

void G4UA::StepHistogramTool::BookHistograms ( StepHistogram::HistoMapMap_t & hMap, const char * suffix, const char * subfolder = "" )

private

Definition at line 36 of file StepHistogramTool.cxx.

  {
    for (auto const& x : hMap)
    {
      ATH_MSG_INFO("Currently in volume:\t" << x.first << " got histoMap " << x.second);
      for (auto const& hm : x.second)
      {
        ATH_MSG_INFO("Registering histogram:\t" << hm.first);
        std::ostringstream stringStream;
        stringStream << "/stepHisto/" << subfolder << x.first << "/" << suffix << hm.first;
        if ( m_histSvc->regHist(stringStream.str().c_str(), hm.second).isFailure() ) {
          ATH_MSG_ERROR("Could not register histogram!");
        }
      }
    }    
  }

EndOfAthenaEvent()

StatusCode G4UA::UserActionToolBase< StepHistogram >::EndOfAthenaEvent ( HitCollectionMap & )

inlineoverrideinherited

Calls EndOfAthenaEvent.

Definition at line 61 of file UserActionToolBase.h.

{return StatusCode::SUCCESS;};

fillUserAction()

virtual StatusCode G4UA::UserActionToolBase< StepHistogram >::fillUserAction ( G4AtlasUserActions & actionLists )

inlinefinaloverridevirtualinherited

Fill the user action lists.

Definition at line 47 of file UserActionToolBase.h.

      {
        auto myAction = makeAndFillAction(actionLists);
        if(myAction == nullptr) {
          ATH_MSG_ERROR( "Failed to construct user action in " << name() );
          return StatusCode::FAILURE;
        }
        m_actions.set( std::move(myAction) );
        return StatusCode::SUCCESS;
      }

finalize()

StatusCode G4UA::StepHistogramTool::finalize ( )

overridevirtual

Definition at line 53 of file StepHistogramTool.cxx.

                                         {
    ATH_MSG_INFO("Preparing histograms...");
 
    // Accumulate results across threads
    StepHistogram::Report report;
    m_actions.accumulate(report, &StepHistogram::getReport,
                         &StepHistogram::Report::merge);
 
    if (m_histSvc) {
      BookHistograms(report.histoMapMap_vol_stepSize, "stepLength/", "volumes/");
      BookHistograms(report.histoMapMap_vol_stepKineticEnergy, "stepKineticEnergy/", "volumes/");
      BookHistograms(report.histoMapMap_vol_postStepKineticEnergy, "postStepKineticEnergy/", "volumes/");
      BookHistograms(report.histoMapMap_vol_stepPseudorapidity, "stepPseudorapidity/", "volumes/");
      BookHistograms(report.histoMapMap_vol_stepEnergyDeposit, "stepEnergyDeposit/", "volumes/");
      BookHistograms(report.histoMapMap_vol_stepEnergyNonIonDeposit, "stepEnergyNonIonDeposit/", "volumes/");
      BookHistograms(report.histoMapMap_vol_stepSecondaryKinetic, "stepSecondaryKinetic/", "volumes/");
      BookHistograms(report.histoMapMap_vol_trackLengthPerInitialE, "trackLengthPerInitialE/", "volumes/");
      BookHistograms(report.histoMapMap_vol_InitialE, "InitialE/", "volumes/");
      BookHistograms(report.histoMapMap_vol_numberOfSteps, "numberOfSteps/", "volumes/");
      BookHistograms(report.histoMapMap_vol_numberOfStepsPerInitialE, "numberOfStepsPerInitialE/", "volumes/");
 
      BookHistograms(report.histoMapMap_mat_stepSize, "stepLength/", "materials/");
      BookHistograms(report.histoMapMap_mat_stepKineticEnergy, "stepKineticEnergy/", "materials/");
      BookHistograms(report.histoMapMap_mat_stepPseudorapidity, "stepPseudorapidity/", "materials/");
      BookHistograms(report.histoMapMap_mat_postStepKineticEnergy, "postStepKineticEnergy/", "materials/");
      BookHistograms(report.histoMapMap_mat_stepEnergyDeposit, "stepEnergyDeposit/", "materials/");
      BookHistograms(report.histoMapMap_mat_stepEnergyNonIonDeposit, "stepEnergyNonIonDeposit/", "materials/");
      BookHistograms(report.histoMapMap_mat_stepSecondaryKinetic, "stepSecondaryKinetic/", "materials/");
      BookHistograms(report.histoMapMap_mat_trackLengthPerInitialE, "trackLengthPerInitialE/", "materials/");
      BookHistograms(report.histoMapMap_mat_InitialE, "InitialE/", "materials/");
      BookHistograms(report.histoMapMap_mat_numberOfSteps, "numberOfSteps/", "materials/");
      BookHistograms(report.histoMapMap_mat_numberOfStepsPerInitialE, "numberOfStepsPerInitialE/", "materials/");
 
      BookHistograms(report.histoMapMap_prc_stepSize, "stepLength/", "processes/");
      BookHistograms(report.histoMapMap_prc_stepKineticEnergy, "stepKineticEnergy/", "processes/");
      BookHistograms(report.histoMapMap_prc_stepPseudorapidity, "stepPseudorapidity/", "processes/");
      BookHistograms(report.histoMapMap_prc_postStepKineticEnergy, "postStepKineticEnergy/", "processes/");
      BookHistograms(report.histoMapMap_prc_stepEnergyDeposit, "stepEnergyDeposit/", "processes/");
      BookHistograms(report.histoMapMap_prc_stepEnergyNonIonDeposit, "stepEnergyNonIonDeposit/", "processes/");
      BookHistograms(report.histoMapMap_prc_stepSecondaryKinetic, "stepSecondaryKinetic/", "processes/");
      BookHistograms(report.histoMapMap_prc_trackLengthPerInitialE, "trackLengthPerInitialE/", "processes/");
      BookHistograms(report.histoMapMap_prc_InitialE, "InitialE/", "processes/");
      BookHistograms(report.histoMapMap_prc_numberOfSteps, "numberOfSteps/", "processes/");
      BookHistograms(report.histoMapMap_prc_numberOfStepsPerInitialE, "numberOfStepsPerInitialE/", "processes/");
 
      if (m_config.doGeneralHistograms) {
        BookHistograms(report.histoMapMap_numberOfSteps, "numberOfSteps/", "nSteps/");
        BookHistograms(report.histoMapMap_numberOfStepsPerInitialE, "numberOfStepsPerInitialE/", "nSteps/");
        BookHistograms(report.histoMapMap_trackLengthPerInitialE, "trackLengthPerInitialE/", "nSteps/");
        BookHistograms(report.histoMapMap_InitialE, "InitialE/", "nSteps/");
        BookHistograms(report.histoMapMap_stepKinetic, "stepKineticEnergy/", "nSteps/");
        BookHistograms(report.histoMapMap_postStepKinetic, "postStepKineticEnergy/", "nSteps/");
      }
 
      if (m_config.do2DHistograms) {
        BookHistograms(report.histoMapMap2D_vol_RZ, "2DMaps/", "volumes/");
        BookHistograms(report.histoMapMap2D_mat_RZ, "2DMaps/", "materials/");
        BookHistograms(report.histoMapMap2D_prc_RZ, "2DMaps/", "processes/");
        BookHistograms(report.histoMapMap2D_vol_RZ_E, "2DMaps_E/", "volumes/");
        BookHistograms(report.histoMapMap2D_mat_RZ_E, "2DMaps_E/", "materials/");
      }
    }
    else {
      ATH_MSG_WARNING("HistSvc not initialized...");      
    }
 
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode G4UA::StepHistogramTool::initialize ( )

overridevirtual

return the event action

Definition at line 31 of file StepHistogramTool.cxx.

                                          {
    ATH_CHECK(m_histSvc.retrieve());
    return StatusCode::SUCCESS;
  }

makeAndFillAction()

std::unique_ptr< StepHistogram > G4UA::StepHistogramTool::makeAndFillAction ( G4AtlasUserActions & actionList )

finaloverrideprotectedvirtual

Create action for this thread.

Implements G4UA::UserActionToolBase< StepHistogram >.

Definition at line 21 of file StepHistogramTool.cxx.

  {
    ATH_MSG_DEBUG("Constructing a TestActionTimer");
    auto action = std::make_unique<StepHistogram>(m_config);
    actionList.runActions.push_back( action.get() );
    actionList.eventActions.push_back( action.get() );
    actionList.steppingActions.push_back( action.get() );
    return action;
  }

Member Data Documentation

m_actions

ThreadSpecificUserAction<StepHistogram> G4UA::UserActionToolBase< StepHistogram >::m_actions

protectedinherited

Thread-specific storage of the user action.

Definition at line 70 of file UserActionToolBase.h.

m_config

StepHistogram::Config G4UA::StepHistogramTool::m_config

private

Definition at line 42 of file StepHistogramTool.h.

m_histSvc

ServiceHandle<ITHistSvc> G4UA::StepHistogramTool::m_histSvc

private

Definition at line 44 of file StepHistogramTool.h.

---

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

• StepHistogramTool.h
• StepHistogramTool.cxx