ActsExamples::RootBFieldWriter< bfield_t >::Config Struct Reference

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

Collaboration diagram for ActsExamples::RootBFieldWriter< bfield_t >::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 bfield_t >	bField = nullptr
	The magnetic field to be written out.
GridType	gridType = GridType::xyz
	How the magnetic field map should be written out.
boost::optional< std::array < double, 2 > >	rBounds
boost::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

template<typename bfield_t>
struct ActsExamples::RootBFieldWriter< bfield_t >::Config

Definition at line 42 of file RootBFieldWriter.hpp.

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

Member Data Documentation

template<typename bfield_t >

std::shared_ptr<const bfield_t> ActsExamples::RootBFieldWriter< bfield_t >::Config::bField = nullptr

The magnetic field to be written out.

Definition at line 50 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

std::string ActsExamples::RootBFieldWriter< bfield_t >::Config::fileMode = "recreate"

the file access mode (recreate by default)

Definition at line 48 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

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

The name of the output file.

Definition at line 46 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

GridType ActsExamples::RootBFieldWriter< bfield_t >::Config::gridType = GridType::xyz

How the magnetic field map should be written out.

Definition at line 52 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

size_t ActsExamples::RootBFieldWriter< bfield_t >::Config::phiBins = 100

Number of bins in phi.

handed over the full magnetic field map will be printed out

Definition at line 73 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

size_t ActsExamples::RootBFieldWriter< bfield_t >::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 65 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

boost::optional<std::array<double, 2> > ActsExamples::RootBFieldWriter< bfield_t >::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 57 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

std::string ActsExamples::RootBFieldWriter< bfield_t >::Config::treeName = "TTree"

The name of the output tree.

Definition at line 44 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

size_t ActsExamples::RootBFieldWriter< bfield_t >::Config::zBins = 300

Number of bins in z.

handed over the full magnetic field map will be printed out

Definition at line 69 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

template<typename bfield_t >

boost::optional<std::array<double, 2> > ActsExamples::RootBFieldWriter< bfield_t >::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 61 of file RootBFieldWriter.hpp.

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

Referenced by ActsExamples::RootBFieldWriter< bfield_t >::run().

---

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

• acts/blob/sPHENIX/Examples/Io/Root/include/ActsExamples/Io/Root/RootBFieldWriter.hpp