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

#include <acts/blob/master/Examples/Io/Root/include/ACTFW/Io/Root/RootBFieldWriter.hpp>

Collaboration diagram for FW::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 FW::RootBFieldWriter< bfield_t >::Config

Definition at line 41 of file RootBFieldWriter.hpp.

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

Member Data Documentation

template<typename bfield_t >

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

The magnetic field to be written out.

Definition at line 49 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

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

the file access mode (recreate by default)

Definition at line 47 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

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

The name of the output file.

Definition at line 45 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

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

How the magnetic field map should be written out.

Definition at line 51 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

size_t FW::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 72 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

size_t FW::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 64 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

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

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

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

template<typename bfield_t >

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

The name of the output tree.

Definition at line 43 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

size_t FW::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 68 of file RootBFieldWriter.hpp.

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

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

template<typename bfield_t >

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

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

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

---

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

• acts/blob/master/Examples/Io/Root/include/ACTFW/Io/Root/RootBFieldWriter.hpp