#include <Algorithm.h>

Detailed Description

Base class for all algorithms to inherit from.

This is the base class for all algorithms. It provides common members, such as a logger instance and options data structure. Algorithm implementations must:

inherit from this base class
override the methods Algorithm::Start, Algorithm::Run and Algorithm::Stop

See existing algorithms for examples.

Definition at line 39 of file Algorithm.h.

Public Member Functions
	Algorithm (std::string_view name)

virtual void	Start (hipo::banklist &banks)=0
	Initialize this algorithm before any events are processed, with the intent to process banks

void	Start ()
	Initialize this algorithm before any events are processed, with the intent to process bank rows rather than full banks;.

virtual void	Run (hipo::banklist &banks) const =0
	Run this algorithm for an event.

virtual void	Stop ()=0
	Finalize this algorithm after all events are processed.

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 ()

Protected Member Functions
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
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::Algorithm:

Constructor & Destructor Documentation

◆ Algorithm()

iguana::Algorithm::Algorithm ( std::string_view name )

inline

Parameters

name	the unique name for a derived class instance

Definition at line 45 of file Algorithm.h.

◆ ~Algorithm()

virtual iguana::Algorithm::~Algorithm ( )

inlinevirtual

Definition at line 52 of file Algorithm.h.

Member Function Documentation

◆ CreateBank()

hipo::schema iguana::Algorithm::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

protected

Create a new bank and push it to the bank list

Parameters

[out]	banks	the `hipo::banklist` onto which the new bank will be pushed
[out]	bank_idx	will be set to the `hipo::banklist` index of the new bank
[in]	bank_name	the new bank name
[in]	schema_def	a list of variables for the schema
[in]	group_id	the group ID for the schema
[in]	item_id	the item ID for the schema

Returns: the bank's schema

◆ GetBank()

hipo::bank & iguana::Algorithm::GetBank	(	hipo::banklist &	banks,
		hipo::banklist::size_type const	idx,
		std::string const &	expected_bank_name = "" ) const

protected

Get the reference to a bank from a hipo::banklist; optionally checks if the bank name matches the expectation

Parameters

banks	the `hipo::banklist` from which to get the specified bank
idx	the index of `banks` of the specified bank
expected_bank_name	if specified, checks that the specified bank has this name

Returns: a reference to the bank

◆ GetBankIndex()

hipo::banklist::size_type iguana::Algorithm::GetBankIndex	(	hipo::banklist &	banks,
		std::string const &	bank_name ) const

protected

Get the index of a bank in a hipo::banklist; throws an exception if the bank is not found

Parameters

banks	the list of banks this algorithm will use
bank_name	the name of the bank returns the `hipo::banklist` index of the bank

◆ GetCachedOption()

template<typename OPTION_TYPE >

std::optional< OPTION_TYPE > iguana::Algorithm::GetCachedOption ( std::string const & key ) const

protected

Get an option from the option cache

Parameters

key	the key name associated with this option

Returns: the option value, if found (using std::optional)

◆ GetConfig()

std::unique_ptr< YAMLReader > const & iguana::Algorithm::GetConfig ( ) const

Get a reference to this algorithm's configuration (YAMLReader)

Returns: the configuration

◆ GetOptionScalar()

template<typename OPTION_TYPE >

OPTION_TYPE iguana::Algorithm::GetOptionScalar	(	std::string const &	key,
		YAMLReader::node_path_t	node_path = {} ) const

Get the value of a scalar option

Parameters

key	the unique key name of this option, for caching; if empty, the option will not be cached
node_path	the `YAML::Node` identifier path to search for this option in the config files; if empty, it will just use `key`

Returns: the scalar option

◆ GetOptionSet()

template<typename OPTION_TYPE >

std::set< OPTION_TYPE > iguana::Algorithm::GetOptionSet	(	std::string const &	key,
		YAMLReader::node_path_t	node_path = {} ) const

Get the value of a vector option, and convert it to std::set

Parameters

key	the unique key name of this option
node_path	the `YAML::Node` identifier path to search for this option in the config files; if empty, it will just use `key`

Returns: the vector option converted to std::set

◆ GetOptionVector()

template<typename OPTION_TYPE >

std::vector< OPTION_TYPE > iguana::Algorithm::GetOptionVector	(	std::string const &	key,
		YAMLReader::node_path_t	node_path = {} ) const

Get the value of a vector option

Parameters

key	the unique key name of this option, for caching; if empty, the option will not be cached
node_path	the `YAML::Node` identifier path to search for this option in the config files; if empty, it will just use `key`

Returns: the vector option

◆ Run()

virtual void iguana::Algorithm::Run ( hipo::banklist & banks ) const

pure virtual

Run this algorithm for an event.

Parameters

banks the list of banks to process

Implemented in iguana::AlgorithmSequence, iguana::clas12::EventBuilderFilter, iguana::clas12::FiducialFilter, iguana::clas12::FiducialFilterValidator, iguana::clas12::FTEnergyCorrection, iguana::clas12::MomentumCorrection, iguana::clas12::MomentumCorrectionValidator, iguana::clas12::PhotonGBTFilter, iguana::clas12::PhotonGBTFilterValidator, iguana::clas12::SectorFinder, iguana::clas12::SectorFinderValidator, iguana::clas12::ZVertexFilter, iguana::clas12::ZVertexFilterValidator, iguana::example::ExampleAlgorithm, iguana::physics::DihadronKinematics, iguana::physics::DihadronKinematicsValidator, iguana::physics::InclusiveKinematics, iguana::physics::InclusiveKinematicsValidator, iguana::physics::SingleHadronKinematics, iguana::physics::SingleHadronKinematicsValidator, and iguana::Validator.

◆ SetConfig()

void iguana::Algorithm::SetConfig ( std::unique_ptr< YAMLReader > && yaml_config )

Set a custom YAMLReader to use for this algorithm

Parameters

yaml_config the custom YAMLReader instance

◆ SetConfigDirectory()

void iguana::Algorithm::SetConfigDirectory ( std::string const & name )

Set a custom configuration file directory for this algorithm

See also: Algorithm::SetConfigFile

Parameters

name	the directory name

◆ SetConfigFile()

void iguana::Algorithm::SetConfigFile ( std::string const & name )

Set a custom configuration file for this algorithm

See also: Algorithm::SetConfigDirectory

Parameters

name	the configuration file name

◆ SetName()

void iguana::Algorithm::SetName ( std::string_view name )

Set the name of this algorithm

Parameters

name	the new name

◆ SetOption()

template<typename OPTION_TYPE >

OPTION_TYPE iguana::Algorithm::SetOption	(	std::string const &	key,
		const OPTION_TYPE	val )

inline

Set an option specified by the user. If the option name is "log", the log level of the Logger owned by this algorithm will be changed to the specified value.

Parameters

key	the name of the option
val	the value to set

Returns: the value that has been set (if needed, e.g., when val is an rvalue)

Definition at line 79 of file Algorithm.h.

◆ ShowBank()

void iguana::Algorithm::ShowBank	(	hipo::bank &	bank,
		std::string_view	message = "",
		Logger::Level const	level = Logger::trace ) const

protected

Dump a single bank

Parameters

bank	the bank to show
message	if specified, print a header message
level	the log level

◆ ShowBanks()

void iguana::Algorithm::ShowBanks	(	hipo::banklist &	banks,
		std::string_view	message = "",
		Logger::Level const	level = Logger::trace ) const

protected

Dump all banks in a hipo::banklist

Parameters

banks	the banks to show
message	if specified, print a header message
level	the log level

◆ Start() [1/2]

void iguana::Algorithm::Start ( )

Initialize this algorithm before any events are processed, with the intent to process bank rows rather than full banks;.

use this method if you intend to use "action functions" instead of Algorithm::Run.

◆ Start() [2/2]

virtual void iguana::Algorithm::Start ( hipo::banklist & banks )

pure virtual

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

Implemented in iguana::AlgorithmSequence, iguana::clas12::EventBuilderFilter, iguana::clas12::FiducialFilter, iguana::clas12::FiducialFilterValidator, iguana::clas12::FTEnergyCorrection, iguana::clas12::MomentumCorrection, iguana::clas12::MomentumCorrectionValidator, iguana::clas12::PhotonGBTFilter, iguana::clas12::PhotonGBTFilterValidator, iguana::clas12::SectorFinder, iguana::clas12::SectorFinderValidator, iguana::clas12::ZVertexFilter, iguana::clas12::ZVertexFilterValidator, iguana::example::ExampleAlgorithm, iguana::physics::DihadronKinematics, iguana::physics::DihadronKinematicsValidator, iguana::physics::InclusiveKinematics, iguana::physics::InclusiveKinematicsValidator, iguana::physics::SingleHadronKinematics, iguana::physics::SingleHadronKinematicsValidator, and iguana::Validator.

◆ Stop()

virtual void iguana::Algorithm::Stop ( )

pure virtual

Finalize this algorithm after all events are processed.

Implemented in iguana::AlgorithmSequence, iguana::clas12::EventBuilderFilter, iguana::clas12::FiducialFilter, iguana::clas12::FiducialFilterValidator, iguana::clas12::FTEnergyCorrection, iguana::clas12::MomentumCorrection, iguana::clas12::MomentumCorrectionValidator, iguana::clas12::PhotonGBTFilter, iguana::clas12::PhotonGBTFilterValidator, iguana::clas12::SectorFinder, iguana::clas12::SectorFinderValidator, iguana::clas12::ZVertexFilter, iguana::clas12::ZVertexFilterValidator, iguana::example::ExampleAlgorithm, iguana::physics::DihadronKinematics, iguana::physics::DihadronKinematicsValidator, iguana::physics::InclusiveKinematics, iguana::physics::InclusiveKinematicsValidator, iguana::physics::SingleHadronKinematics, iguana::physics::SingleHadronKinematicsValidator, and iguana::Validator.

Member Data Documentation

◆ m_class_name

std::string iguana::Algorithm::m_class_name

protected

Class name of this algorithm.

Definition at line 208 of file Algorithm.h.

◆ m_default_config_file

std::string iguana::Algorithm::m_default_config_file

protected

Default configuration file name.

Definition at line 214 of file Algorithm.h.

◆ m_mutex

std::mutex iguana::Algorithm::m_mutex

mutableprotected

A mutex for this algorithm.

Definition at line 225 of file Algorithm.h.

◆ m_rows_only

bool iguana::Algorithm::m_rows_only

protected

If true, algorithm can only operate on bank rows; Algorithm::GetBank, and therefore Algorithm::Run, cannot be called.

Definition at line 211 of file Algorithm.h.

◆ o_user_config_dir

std::string iguana::Algorithm::o_user_config_dir

protected

User's configuration file directory. Set it with Algorithm::SetConfigDirectory

Definition at line 222 of file Algorithm.h.

◆ o_user_config_file

std::string iguana::Algorithm::o_user_config_file

protected

User's configuration file name, which may override the default configuration file, m_default_config_file. Set it with Algorithm::SetConfigFile

Definition at line 218 of file Algorithm.h.

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

/__w/iguana/iguana/iguana_src/src/iguana/algorithms/Algorithm.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ Algorithm()

◆ ~Algorithm()

Member Function Documentation

◆ CreateBank()

◆ GetBank()

◆ GetBankIndex()

◆ GetCachedOption()

◆ GetConfig()

◆ GetOptionScalar()

◆ GetOptionSet()

◆ GetOptionVector()

◆ Run()

◆ SetConfig()

◆ SetConfigDirectory()

◆ SetConfigFile()

◆ SetName()

◆ SetOption()

◆ ShowBank()

◆ ShowBanks()

◆ Start() [1/2]

◆ Start() [2/2]

◆ Stop()

Member Data Documentation

◆ m_class_name

◆ m_default_config_file

◆ m_mutex

◆ m_rows_only

◆ o_user_config_dir

◆ o_user_config_file