ActsExamples::CsvParticleWriter Exception Reference

#include <acts/blob/sPHENIX/Examples/Io/Csv/include/ActsExamples/Io/Csv/CsvParticleWriter.hpp>

Inheritance diagram for ActsExamples::CsvParticleWriter:

Collaboration diagram for ActsExamples::CsvParticleWriter:

Classes
struct	Config

Public Member Functions
	CsvParticleWriter (const Config &cfg, Acts::Logging::Level lvl)
Public Member Functions inherited from ActsExamples::WriterT< SimParticleContainer >
	WriterT (std::string objectName, std::string writerName, Acts::Logging::Level level)
std::string	name () const finaloverride
	Provide the name of the writer.
ProcessCode	write (const AlgorithmContext &context) finaloverride
	Read the object and call the type-specific member function.
ProcessCode	endRun () override
	No-op default implementation.
Public Member Functions inherited from ActsExamples::IWriter
virtual	~IWriter ()=default

Protected Member Functions
ProcessCode	writeT (const ActsExamples::AlgorithmContext &ctx, const SimParticleContainer &particles) finaloverride
Protected Member Functions inherited from ActsExamples::WriterT< SimParticleContainer >
const Acts::Logger &	logger () const

Private Attributes
Config	m_cfg
	Nested configuration struct.

Detailed Description

Write out particles in the TrackML comma-separated-value format.

This writer is restricted to outgoing particles, it is designed for generated particle information.

This writes one file per event into the configured output directory. By default it writes to the current working directory. Files are named using the following schema

event000000001-<stem>.csv
event000000002-<stem>.csv
...

and each line in the file corresponds to one particle.

Definition at line 34 of file CsvParticleWriter.hpp.

View newest version in sPHENIX GitHub at line 34 of file CsvParticleWriter.hpp

Constructor & Destructor Documentation

ActsExamples::CsvParticleWriter::CsvParticleWriter	(	const Config &	cfg,
		Acts::Logging::Level	lvl
	)

Construct the particle writer.

cfg is the configuration object lvl is the logging level

Definition at line 22 of file CsvParticleWriter.cpp.

View newest version in sPHENIX GitHub at line 22 of file CsvParticleWriter.cpp

References m_cfg, and ActsExamples::CsvParticleWriter::Config::outputStem.

Member Function Documentation

ActsExamples::ProcessCode ActsExamples::CsvParticleWriter::writeT ( const ActsExamples::AlgorithmContext &  ctx, const SimParticleContainer &  particles  )

finaloverrideprotectedvirtual

Type-specific write implementation.

Parameters

[in]	ctx	is the algorithm context
[in]	particles	are the particle to be written

Implements ActsExamples::WriterT< SimParticleContainer >.

Definition at line 32 of file CsvParticleWriter.cpp.

View newest version in sPHENIX GitHub at line 32 of file CsvParticleWriter.cpp

References dfe::io_dsv_impl::NamedTupleDsvWriter< Delimiter, NamedTuple >::append(), data, Acts::UnitConstants::e, ActsExamples::AlgorithmContext::eventNumber, Acts::UnitConstants::GeV, ActsExamples::ParticleData::m, Acts::UnitConstants::mm, Acts::UnitConstants::ns, p, particle, ActsExamples::ParticleData::particle_id, ActsExamples::ParticleData::particle_type, ActsExamples::perEventFilepath(), ActsExamples::ParticleData::process, ActsExamples::ParticleData::px, ActsExamples::ParticleData::py, ActsExamples::ParticleData::pz, ActsExamples::ParticleData::q, SUCCESS, ActsExamples::ParticleData::vt, ActsExamples::ParticleData::vx, ActsExamples::ParticleData::vy, and ActsExamples::ParticleData::vz.

Here is the call graph for this function:

Member Data Documentation

Config ActsExamples::CsvParticleWriter::m_cfg

private

Nested configuration struct.

Definition at line 62 of file CsvParticleWriter.hpp.

View newest version in sPHENIX GitHub at line 62 of file CsvParticleWriter.hpp

Referenced by CsvParticleWriter().

---

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

• acts/blob/sPHENIX/Examples/Io/Csv/include/ActsExamples/Io/Csv/CsvParticleWriter.hpp
• acts/blob/sPHENIX/Examples/Io/Csv/src/CsvParticleWriter.cpp