Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ActsExamples::RootBFieldWriter::Config Struct Reference

#include <acts/blob/sPHENIX/Examples/Io/Root/include/ActsExamples/Io/Root/RootBFieldWriter.hpp>

+ Collaboration diagram for ActsExamples::RootBFieldWriter::Config:

Public Attributes

std::string treeName = "TTree"
 The name of the output tree.
 
std::string fileName = "TFile.root"
 The name of the output file.
 
std::string fileMode = "recreate"
 the file access mode (recreate by default)
 
std::shared_ptr< const
Acts::InterpolatedMagneticField
bField
 The magnetic field to be written out.
 
GridType gridType = GridType::xyz
 How the magnetic field map should be written out.
 
std::optional< std::array
< double, 2 > > 
rBounds
 
std::optional< std::array
< double, 2 > > 
zBounds
 
size_t rBins = 200
 
size_t zBins = 300
 Number of bins in z.
 
size_t phiBins = 100
 Number of bins in phi.
 

Detailed Description

Definition at line 45 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 45 of file RootBFieldWriter.hpp

Member Data Documentation

std::shared_ptr<const Acts::InterpolatedMagneticField> ActsExamples::RootBFieldWriter::Config::bField

The magnetic field to be written out.

Definition at line 53 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 53 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().

std::string ActsExamples::RootBFieldWriter::Config::fileMode = "recreate"

the file access mode (recreate by default)

Definition at line 51 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 51 of file RootBFieldWriter.hpp

Referenced by ActsExamples::RootBFieldWriter::run().

std::string ActsExamples::RootBFieldWriter::Config::fileName = "TFile.root"

The name of the output file.

Definition at line 49 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 49 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().

GridType ActsExamples::RootBFieldWriter::Config::gridType = GridType::xyz

How the magnetic field map should be written out.

Definition at line 55 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 55 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().

size_t ActsExamples::RootBFieldWriter::Config::phiBins = 100

Number of bins in phi.

handed over the full magnetic field map will be printed out

Definition at line 76 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 76 of file RootBFieldWriter.hpp

Referenced by main().

size_t ActsExamples::RootBFieldWriter::Config::rBins = 200

Number of bins in r

Note
setting this parameter is optional, in case no bin numbers are handed over the full magnetic field map will be printed out

Definition at line 68 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 68 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().

std::optional<std::array<double, 2> > ActsExamples::RootBFieldWriter::Config::rBounds

[optional] Setting the range to be printed out in either r (for cylinder coordinates) or x/y (in cartesian coordinates)

Note
setting this parameter is optional, in case no boundaries are handed over the full magnetic field map will be printed out

Definition at line 60 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 60 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().

std::string ActsExamples::RootBFieldWriter::Config::treeName = "TTree"

The name of the output tree.

Definition at line 47 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 47 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().

size_t ActsExamples::RootBFieldWriter::Config::zBins = 300

Number of bins in z.

handed over the full magnetic field map will be printed out

Definition at line 72 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 72 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().

std::optional<std::array<double, 2> > ActsExamples::RootBFieldWriter::Config::zBounds

[optional] Setting the range in z to be printed out

Note
setting this parameter is optional, in case no boundaries are handed over the full magnetic field map will be printed out

Definition at line 64 of file RootBFieldWriter.hpp.

View newest version in sPHENIX GitHub at line 64 of file RootBFieldWriter.hpp

Referenced by main(), and ActsExamples::RootBFieldWriter::run().


The documentation for this struct was generated from the following file: