Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ActsExamples::RootNuclearInteractionParametersWriter Exception Referencefinal

#include <acts/blob/sPHENIX/Examples/Io/NuclearInteractions/include/ActsExamples/Io/NuclearInteractions/RootNuclearInteractionParametersWriter.hpp>

+ Inheritance diagram for ActsExamples::RootNuclearInteractionParametersWriter:
+ Collaboration diagram for ActsExamples::RootNuclearInteractionParametersWriter:

Classes

struct  Config
 

Public Member Functions

 RootNuclearInteractionParametersWriter (const Config &config, Acts::Logging::Level level)
 
 ~RootNuclearInteractionParametersWriter () override
 
ProcessCode finalize () override
 End-of-run hook.
 
const Configconfig () const
 Get readonly access to the config parameters.
 
- Public Member Functions inherited from ActsExamples::WriterT< ExtractedSimulationProcessContainer >
 WriterT (std::string objectName, std::string writerName, Acts::Logging::Level level)
 
std::string name () const override
 Provide the name of the writer.
 
ProcessCode write (const AlgorithmContext &context) override
 Read the object and call the type-specific member function.
 
ProcessCode finalize () override
 No-op default implementation.
 
- Public Member Functions inherited from ActsExamples::IWriter
ProcessCode internalExecute (const AlgorithmContext &context) final
 
ProcessCode initialize () override
 Fulfil the algorithm interface.
 
- Public Member Functions inherited from ActsExamples::SequenceElement
virtual ~SequenceElement ()=default
 
const std::vector< const
DataHandleBase * > & 
writeHandles () const
 
const std::vector< const
DataHandleBase * > & 
readHandles () const
 

Protected Member Functions

ProcessCode writeT (const AlgorithmContext &, const ExtractedSimulationProcessContainer &event) override
 Write method called by the base class.
 
- Protected Member Functions inherited from ActsExamples::WriterT< ExtractedSimulationProcessContainer >
const Acts::Loggerlogger () const
 

Private Attributes

Config m_cfg
 The config class.
 
std::mutex m_writeMutex
 Mutex used to protect multi-threaded writes.
 
std::vector
< detail::NuclearInteractionParametrisation::EventFraction
m_eventFractionCollection
 The recorded fractions of events.
 

Detailed Description

This class takes fractions of recorded events that represent the effect of a nuclear interaction and produces histograms and parameters which can be used for a parametrisation based simultion of nuclear interaction. Since the parameters are based on the set of all provided events, during the event loop newly provided events are stored until the end of the run. Then all parts are calculated and written to file.

Definition at line 30 of file RootNuclearInteractionParametersWriter.hpp.

View newest version in sPHENIX GitHub at line 30 of file RootNuclearInteractionParametersWriter.hpp

Constructor & Destructor Documentation

ActsExamples::RootNuclearInteractionParametersWriter::RootNuclearInteractionParametersWriter ( const Config config,
Acts::Logging::Level  level 
)

Constructor

Parameters
configConfiguration struct
levelMessage level declaration

Definition at line 350 of file RootNuclearInteractionParametersWriter.cpp.

View newest version in sPHENIX GitHub at line 350 of file RootNuclearInteractionParametersWriter.cpp

References ActsExamples::RootNuclearInteractionParametersWriter::Config::filePath, ActsExamples::RootNuclearInteractionParametersWriter::Config::inputSimulationProcesses, and m_cfg.

ActsExamples::RootNuclearInteractionParametersWriter::~RootNuclearInteractionParametersWriter ( )
overridedefault

Member Function Documentation

const Config& ActsExamples::RootNuclearInteractionParametersWriter::config ( ) const
inline

Get readonly access to the config parameters.

Definition at line 67 of file RootNuclearInteractionParametersWriter.hpp.

View newest version in sPHENIX GitHub at line 67 of file RootNuclearInteractionParametersWriter.hpp

References m_cfg.

ActsExamples::ProcessCode ActsExamples::RootNuclearInteractionParametersWriter::finalize ( )
overridevirtual
ActsExamples::ProcessCode ActsExamples::RootNuclearInteractionParametersWriter::writeT ( const AlgorithmContext ,
const ExtractedSimulationProcessContainer event 
)
overrideprotectedvirtual

Write method called by the base class.

Parameters
[in]ctxis the algorithm context for event information
[in]eventFraction of an event that will be stored in m_eventFractionCollection

Implements ActsExamples::WriterT< ExtractedSimulationProcessContainer >.

Definition at line 482 of file RootNuclearInteractionParametersWriter.cpp.

View newest version in sPHENIX GitHub at line 482 of file RootNuclearInteractionParametersWriter.cpp

References Acts::UnitConstants::e, and SUCCESS.

Member Data Documentation

Config ActsExamples::RootNuclearInteractionParametersWriter::m_cfg
private

The config class.

Definition at line 78 of file RootNuclearInteractionParametersWriter.hpp.

View newest version in sPHENIX GitHub at line 78 of file RootNuclearInteractionParametersWriter.hpp

Referenced by config(), and RootNuclearInteractionParametersWriter().

std::vector<detail::NuclearInteractionParametrisation::EventFraction> ActsExamples::RootNuclearInteractionParametersWriter::m_eventFractionCollection
private

The recorded fractions of events.

Definition at line 81 of file RootNuclearInteractionParametersWriter.hpp.

View newest version in sPHENIX GitHub at line 81 of file RootNuclearInteractionParametersWriter.hpp

std::mutex ActsExamples::RootNuclearInteractionParametersWriter::m_writeMutex
private

Mutex used to protect multi-threaded writes.

Definition at line 79 of file RootNuclearInteractionParametersWriter.hpp.

View newest version in sPHENIX GitHub at line 79 of file RootNuclearInteractionParametersWriter.hpp


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