#include <Algorithm.h>

Detailed Description

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

Input and Output Banks:: See Run function(s) for the banks that are processed by this algorithm.

Type: Filter: This algorithm will filter input bank(s).

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 13 of file Algorithm.h.

Public Member Functions
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
bool	Run (hipo::bank &particleBank) 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::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() [1/2]

bool iguana::clas12::EventBuilderFilter::Run ( hipo::bank & particleBank ) 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,out] particleBank REC::Particle, which will be filtered

Returns: false if all particles are filtered out

◆ Run() [2/2]

bool iguana::clas12::EventBuilderFilter::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::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() [1/2]

◆ Run() [2/2]

◆ Start()

◆ Stop()