iguana::physics::DihadronKinematics Class Reference

#include <Algorithm.h>

Detailed Description

Algorithm: Calculate semi-inclusive dihadron kinematic quantities defined in iguana::physics::DihadronKinematicsVars

Algorithm Name:

   physics::DihadronKinematics

Algorithm Type:

Creator

Algorithm Inputs and Outputs:

Input Banks	REC::Particle, physics::InclusiveKinematics
Output Banks	physics::DihadronKinematics

Configuration Options:

Name	Type	Description
hadron_a_list	list[int]	list of "hadron A" PDGs
hadron_b_list	list[int]	list of "hadron B" PDGs
phi_r_method	string	method used to calculate \(\phi_R\) (see section "phiR calculation methods" below)
theta_method	string	method used to calculate \(\theta\) (see section "theta calculation methods" below)

Dihadron PDGs will be formed from pairs from hadron_a_list and hadron_b_list. For example, if you define:

hadron_a_list: [ 211 ]
hadron_b_list: [ -211, 2212 ]

then the algorithm will calculate kinematics for \(\pi^+\pi^-\) and \(\pi^+p\) dihadrons; hadron A is the \(\pi^+\) for both of these, whereas hadron B is the \(\pi^-\) for the former and the proton for the latter.

phiR calculation methods

• "RT_via_covariant_kT": use \(R_T\) computed via covariant \(k_T\) formula

theta calculation methods

• "hadron_a": use hadron A's "decay angle" in the dihadron rest frame

Definition at line 72 of file Algorithm.h.

Public Member Functions
void	Start (hipo::banklist &banks) override
	Initialize this algorithm before any events are processed, with the intent to process banks
void	Run (hipo::banklist &banks) const override
	Run this algorithm for an event.
void	Stop () override
	Finalize this algorithm after all events are processed.
std::vector< std::pair< int, int > >	PairHadrons (hipo::bank const &particle_bank) const
	form dihadrons by pairing hadrons
Public Member Functions inherited from iguana::Algorithm
	Algorithm (std::string_view name)
void	Start ()
	Initialize this algorithm before any events are processed, with the intent to process bank rows rather than full banks;.
template<typename OPTION_TYPE >
OPTION_TYPE	SetOption (std::string const &key, const OPTION_TYPE val)
template<typename OPTION_TYPE >
OPTION_TYPE	GetOptionScalar (std::string const &key, YAMLReader::node_path_t node_path={}) const
template<typename OPTION_TYPE >
std::vector< OPTION_TYPE >	GetOptionVector (std::string const &key, YAMLReader::node_path_t node_path={}) const
template<typename OPTION_TYPE >
std::set< OPTION_TYPE >	GetOptionSet (std::string const &key, YAMLReader::node_path_t node_path={}) const
void	SetName (std::string_view name)
std::unique_ptr< YAMLReader > const &	GetConfig () const
void	SetConfig (std::unique_ptr< YAMLReader > &&yaml_config)
void	SetConfigFile (std::string const &name)
void	SetConfigDirectory (std::string const &name)
Public Member Functions inherited from iguana::Object
	Object (std::string_view name="", Logger::Level lev=Logger::DEFAULT_LEVEL)
std::unique_ptr< Logger > &	Log ()
void	SetName (std::string_view name)
std::string	GetName () const
void	SetLogLevel (std::string_view lev)
void	SetLogLevel (Logger::Level const lev)
std::unique_ptr< Logger > &	GetLog ()

Additional Inherited Members
Protected Member Functions inherited from iguana::Algorithm
void	ParseYAMLConfig ()
	Parse YAML configuration files. Sets m_yaml_config.
hipo::bank &	GetBank (hipo::banklist &banks, hipo::banklist::size_type const idx, std::string const &expected_bank_name="") const noexcept(false)
hipo::banklist::size_type	GetBankIndex (hipo::banklist &banks, std::string const &bank_name) const noexcept(false)
hipo::schema	CreateBank (hipo::banklist &banks, hipo::banklist::size_type &bank_idx, std::string const &bank_name, std::vector< std::string > schema_def, int group_id, int item_id) const noexcept(false)
void	ShowBanks (hipo::banklist &banks, std::string_view message="", Logger::Level const level=Logger::trace) const
void	ShowBank (hipo::bank &bank, std::string_view message="", Logger::Level const level=Logger::trace) const
template<typename OPTION_TYPE >
std::optional< OPTION_TYPE >	GetCachedOption (std::string const &key) const
Protected Attributes inherited from iguana::Algorithm
std::string	m_class_name
	Class name of this algorithm.
bool	m_rows_only
	If true, algorithm can only operate on bank rows; Algorithm::GetBank, and therefore Algorithm::Run, cannot be called.
std::string	m_default_config_file
	Default configuration file name.
std::string	o_user_config_file
std::string	o_user_config_dir
std::mutex	m_mutex
	A mutex for this algorithm.
Protected Attributes inherited from iguana::Object
std::string	m_name
	The name of this object.
std::unique_ptr< Logger >	m_log
	Logger instance for this object

Inheritance diagram for iguana::physics::DihadronKinematics:

Member Function Documentation

PairHadrons()

std::vector< std::pair< int, int > > iguana::physics::DihadronKinematics::PairHadrons

(

hipo::bank const &

particle_bank

)

const

form dihadrons by pairing hadrons

Parameters

particle_bank

the particle bank (REC::Particle)

Returns

a list of pairs of hadron rows

Run()

void iguana::physics::DihadronKinematics::Run ( hipo::banklist & banks ) const

overridevirtual

Run this algorithm for an event.

Parameters

banks

the list of banks to process

Implements iguana::Algorithm.

Start()

void iguana::physics::DihadronKinematics::Start ( hipo::banklist & banks )

overridevirtual

Initialize this algorithm before any events are processed, with the intent to process banks

use this method if you intend to use Algorithm::Run.

Parameters

banks

the list of banks this algorithm will use, so that Algorithm::Run can cache the indices of the banks that it needs

Implements iguana::Algorithm.

Stop()

void iguana::physics::DihadronKinematics::Stop ( )

overridevirtual

Finalize this algorithm after all events are processed.

Implements iguana::Algorithm.

---

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

• /__w/iguana/iguana/iguana_src/src/iguana/algorithms/physics/DihadronKinematics/Algorithm.h