iguana::physics::SingleHadronKinematics Class Reference

#include <Algorithm.h>

Detailed Description

Algorithm: Calculate semi-inclusive hadron kinematic quantities

Input and Output Banks:

See Run function(s) for the banks that are processed by this algorithm.

Type: Creator

• This algorithm creates new bank(s); click here for a description of all created banks.
• See also the return value type of this algorithm's action functions, which may be structs with the same set of variables as the created bank.

Configuration Options:

YAML configuration, which includes the default option values:

physics::SingleHadronKinematics:
 
  hadron_list: [ 211, -211, 2212 ]

Table of options and descriptions:

Name	Type	Description
hadron_list	list[int]	calculate kinematics for these hadron PDGs

The output bank physics::SingleHadronKinematics will have the same number of rows as the input particle bank REC::Particle

• we want the output bank to have the same number of rows and ordering as the input particle bank, so that banks which reference the input particle bank's rows (usually via pindex) can be used to reference the output bank's rows too
• rows of the input particle bank which were filtered upstream will also be filtered out here, and all the values of the corresponding row in the output bank will be zeroed, since no calculations are performed for those particles
• particles which are not listed in the configuration parameter hadron_list will also be filtered out and zeroed

Definition at line 24 of file Algorithm.h.

Public Member Functions
bool	Run (hipo::bank const &particle_bank, hipo::bank const &inc_kin_bank, hipo::bank &result_bank) const
	Run Function: Process an event's hipo::bank objects
bool	Run (hipo::banklist &banks) const override
	Run Function: Process an event's hipo::banklist
void	Start (hipo::banklist &banks) override
	Initialize this algorithm before any events are processed, with the intent to process banks.
void	Stop () override
	Finalize this algorithm after all events are processed.
Public Member Functions inherited from iguana::Algorithm
	Algorithm (std::string_view name)
std::unique_ptr< YAMLReader > const &	GetConfig () const
hipo::bank	GetCreatedBank (std::string const &bank_name="") const noexcept(false)
std::string	GetCreatedBankName () const noexcept(false)
std::vector< std::string >	GetCreatedBankNames () const noexcept(false)
hipo::schema	GetCreatedBankSchema (std::string const &bank_name="") const noexcept(false)
template<typename OPTION_TYPE>
OPTION_TYPE	GetOptionScalar (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
template<typename OPTION_TYPE>
std::vector< OPTION_TYPE >	GetOptionVector (std::string const &key, YAMLReader::node_path_t node_path={}) const
void	SetConfig (std::unique_ptr< YAMLReader > &&yaml_config)
void	SetConfigDirectory (std::string const &name)
void	SetConfigFile (std::string const &name)
void	SetName (std::string_view name)
template<typename OPTION_TYPE>
OPTION_TYPE	SetOption (std::string const &key, const OPTION_TYPE val)
void	Start ()
	Initialize this algorithm before any events are processed, with the intent to process bank rows rather than full banks;.
Public Member Functions inherited from iguana::Object
std::unique_ptr< Logger > &	GetLog ()
std::string	GetName () const
std::unique_ptr< Logger > &	Log ()
	Object (std::string_view name="", Logger::Level lev=Logger::DEFAULT_LEVEL)
void	SetLogLevel (Logger::Level const lev)
void	SetLogLevel (std::string_view lev)
void	SetName (std::string_view name)

Additional Inherited Members
Protected Member Functions inherited from iguana::Algorithm
hipo::schema	CreateBank (hipo::banklist &banks, hipo::banklist::size_type &bank_idx, std::string const &bank_name) const noexcept(false)
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)
template<typename OPTION_TYPE>
std::optional< OPTION_TYPE >	GetCachedOption (std::string const &key) const
void	ParseYAMLConfig ()
	Parse YAML configuration files. Sets m_yaml_config.
void	ShowBank (hipo::bank const &bank, std::string_view message="", Logger::Level const level=Logger::trace) const
void	ShowBanks (hipo::banklist const &banks, std::string_view message="", Logger::Level const level=Logger::trace) const
void	ThrowSinceRenamed (std::string const &new_name, std::string const &version) const noexcept(false)
Protected Attributes inherited from iguana::Algorithm
std::string	m_class_name
	Class name of this algorithm.
std::string	m_default_config_file
	Default configuration file name.
std::mutex	m_mutex
	A mutex for 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	o_user_config_dir
std::string	o_user_config_file
Protected Attributes inherited from iguana::Object
std::unique_ptr< Logger >	m_log
	Logger instance for this object
std::string	m_name
	The name of this object.

Inheritance diagram for iguana::physics::SingleHadronKinematics:

Member Function Documentation

Run() [1/2]

bool iguana::physics::SingleHadronKinematics::Run	(	hipo::bank const &	particle_bank,
		hipo::bank const &	inc_kin_bank,
		hipo::bank &	result_bank ) const

Run Function: Process an event's hipo::bank objects

The parameter list explains which banks are input ("in"), output ("out"), or both ("in,out").

Parameters

[in]	particle_bank	REC::Particle
[in]	inc_kin_bank	physics::InclusiveKinematics, produced by the physics::InclusiveKinematics algorithm
[out]	result_bank	physics::SingleHadronKinematics, which will be created

Returns

false if the input banks do not have enough information, e.g., if the inclusive kinematics bank is empty, or if the created bank is empty

Run() [2/2]

bool iguana::physics::SingleHadronKinematics::Run ( hipo::banklist & banks ) const

overridevirtual

Run Function: Process an event's hipo::banklist

Parameters

banks

the list of banks to process

Returns

a boolean value, which is typically used to decide whether or not to continue analyzing an event, i.e., it can be used as an event-level filter; not all algorithms use or need this feature; see the algorithm's more specialized Run functions, which have hipo::bank parameters

See also

Specialized Run function(s) above/below; they take individual hipo::bank objects as parameters, and their documentation explains which banks are used by this algorithm and how.

Implements iguana::Algorithm.

Start()

void iguana::physics::SingleHadronKinematics::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::SingleHadronKinematics::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/SingleHadronKinematics/Algorithm.h