ActsExamples::CsvBFieldWriter Class Reference

Writer for B-fields that outputs field data in CSV format. More...

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

Classes
struct	Config
	Configuration type for the magnetic field writer. More...

Public Types
enum	CoordinateType
	Enumeration type for the coordinate system to use in the writing process. More...

Static Public Member Functions
template<CoordinateType Coord, bool Grid>
static void	run (const Config< Coord, Grid > &config, Acts::Logging::Level level)
	Write magnetic field data to a CSV file.

Detailed Description

Writer for B-fields that outputs field data in CSV format.

This tool allows users to dump their magnetic field data to disk in CSV format, which is (relatively) human-readable and widely supported.

Definition at line 32 of file CsvBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 32 of file CsvBFieldWriter.hpp

Member Enumeration Documentation

enum ActsExamples::CsvBFieldWriter::CoordinateType

Enumeration type for the coordinate system to use in the writing process.

This enumeration sets Cartesian coordinates in the XYZ case, and symmetrical cylindrical coordinates in the RZ case.

Definition at line 39 of file CsvBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 39 of file CsvBFieldWriter.hpp

Member Function Documentation

template<CsvBFieldWriter::CoordinateType Coord, bool Grid>

void ActsExamples::CsvBFieldWriter::run ( const Config< Coord, Grid > &  config, Acts::Logging::Level  level  )

static

Write magnetic field data to a CSV file.

Template Parameters

Coord	Specifies the coordinate system to use while writing; this is either Cartesian (XYZ) or cylindrical (RZ).
Grid	Boolean specifying whether the magnetic field is a grid and has set size, or whether it is analytical.

Parameters

config	Configuration of the writing job.
level	Log level to use during execution.

Definition at line 28 of file CsvBFieldWriter.cpp.

View newest version in sPHENIX GitHub at line 28 of file CsvBFieldWriter.cpp

References ACTS_INFO, ACTS_LOCAL_LOGGER, ACTS_VERBOSE, ActsExamples::CsvBFieldWriter::Config< Coord, Grid >::bField, Acts::IntegrationTest::bField, bins, ActsExamples::CsvBFieldWriter::Config< Coord, Grid >::bins, physmon_vertexing::delta, f, ckf::field, ActsExamples::CsvBFieldWriter::Config< Coord, Grid >::fileName, Acts::getDefaultLogger(), i, ambiguity_solver_full_chain::idx, Acts::UnitConstants::min, Acts::UnitConstants::mm, Acts::VectorHelpers::perp(), Acts::Test::pos, physmon_track_finding_ttbar::r, ActsExamples::CsvBFieldWriter::Config< Coord, Grid >::range, Acts::UnitConstants::T, writer, ambiguity_solver_full_chain::x, y, and physmon_track_finding_ttbar::z.

Here is the call graph for this function:

---

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

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