#include <Algorithm.h>

Detailed Description

Algorithm: Filter the REC::Particle (or similar) bank by PID from the Event Builder

Algorithm Name:: clas12::EventBuilderFilter

Algorithm Type:: Filter

Algorithm Inputs and Outputs:

Input Banks	REC::Particle
Output Banks	REC::Particle

Configuration Options:

YAML configuration, which includes the default option values:

clas12::EventBuilderFilter:
  # list of PDG codes to filter for
  pids: [ 11, 211, -211 ]

Table of options and descriptions:

Name	Type	Description
pids	list[int]	list of PDG codes to filter

Definition at line 17 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.
bool	Filter (int const pid) const
	Action Function: checks if the PDG pid is a part of the list of user-specified PDGs
std::deque< bool >	Filter (std::vector< int > const pids) const
	Action Function: checks if the PDG pid is a part of the list of user-specified PDGs
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) 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::clas12::EventBuilderFilter:

Member Function Documentation

◆ Filter() [1/2]

bool iguana::clas12::EventBuilderFilter::Filter ( int const pid ) const

Action Function: checks if the PDG pid is a part of the list of user-specified PDGs

Function Type: scalar filter

Parameters

pid	the particle PDG to check

Returns: true if pid is one the user wants

◆ Filter() [2/2]

std::deque< bool > iguana::clas12::EventBuilderFilter::Filter ( std::vector< int > const pids ) const

Action Function: checks if the PDG pid is a part of the list of user-specified PDGs

Function Type: vector filter

Note: This vector action function overloads a corresponding scalar action function; see that scalar action function for more documentation.

Parameters

pids	the list of particle PDGs to check

Returns: list of booleans which are true for pids the user wants

◆ Run()

void iguana::clas12::EventBuilderFilter::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::clas12::EventBuilderFilter::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::clas12::EventBuilderFilter::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/clas12/EventBuilderFilter/Algorithm.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Filter() [1/2]

◆ Filter() [2/2]

◆ Run()

◆ Start()

◆ Stop()