#include <Algorithm.h>

Detailed Description

Algorithm: Filter the REC::Particle (or similar) bank by cutting on Z Vertex

Algorithm Name:: clas12::ZVertexFilter

Algorithm Type:: Filter

Algorithm Inputs and Outputs:

Input Banks	`REC::Particle, RUN::config`
Output Banks	`REC::Particle`

Configuration Options:

YAML configuration, which includes the default option values:

clas12::ZVertexFilter:
 
  # scattered electron cuts
  electron:
 
    # default cuts
    - default:
      vz: [ -20.0, 20.0 ]
 
    # RG-A fall2018 inbending
    - runs: [ 4760, 5419 ]
      vz: [ -13.0, 12.0 ]
 
    # RG-A fall2018 outbending
    - runs: [ 5420, 5674 ]
      vz: [ -18.0, 10.0 ]

Table of options and descriptions:

Name	Type	Description
`electron_vz`	`list[double]`	lower and upper electron $z$ -vertex cuts; run-range dependent; cuts are not applied to FT electrons (FD and CD only)

Definition at line 18 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.

concurrent_key_t	PrepareEvent (int const runnum) const
	Action Function: prepare the event

bool	Filter (double const zvertex, int const pid, int const status, concurrent_key_t const key) const
	Action Function: checks if the Z Vertex is within specified bounds if pid is one for which the filter should be applied to.; Cuts applied to particles in FD or CD (ie not in FT).

int	GetRunNum (concurrent_key_t const key) const

std::vector< double >	GetElectronZcuts (concurrent_key_t const key) const

void	SetElectronZcuts (double zcut_lower, double zcut_upper, concurrent_key_t const key)
	sets the z-vertex cuts

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::ZVertexFilter:

Member Function Documentation

◆ Filter()

bool iguana::clas12::ZVertexFilter::Filter	(	double const	zvertex,
		int const	pid,
		int const	status,
		concurrent_key_t const	key ) const

Action Function: checks if the Z Vertex is within specified bounds if pid is one for which the filter should be applied to.; Cuts applied to particles in FD or CD (ie not in FT).

Function Type: scalar filter

Note: This function should be called for each particle

Parameters

zvertex	the particle Z Vertex to check
pid	the particle pid
status	particle status used to check particle is not in FT
key	the return value of `PrepareEvent`

Returns: true if zvertex is within specified bounds

◆ GetElectronZcuts()

std::vector< double > iguana::clas12::ZVertexFilter::GetElectronZcuts ( concurrent_key_t const key ) const

Parameters

key	the return value of `PrepareEvent`

Returns: the current z-vertex cuts

◆ GetRunNum()

int iguana::clas12::ZVertexFilter::GetRunNum ( concurrent_key_t const key ) const

Parameters

key	the return value of `PrepareEvent`

Returns: the current run number

◆ PrepareEvent()

concurrent_key_t iguana::clas12::ZVertexFilter::PrepareEvent ( int const runnum ) const

Action Function: prepare the event

Function Type: reload

Note: This function should be called for each event

Parameters

runnum the run number

Returns: the key to be used in Filter

◆ Run()

void iguana::clas12::ZVertexFilter::Run ( hipo::banklist & banks ) const

overridevirtual

Run this algorithm for an event.

Parameters

banks the list of banks to process

Implements iguana::Algorithm.

◆ SetElectronZcuts()

void iguana::clas12::ZVertexFilter::SetElectronZcuts	(	double	zcut_lower,
		double	zcut_upper,
		concurrent_key_t const	key )

sets the z-vertex cuts

Warning: this method is not thread safe; instead, for thread safety, use PrepareEvent and a custom configuration file.

Parameters

zcut_lower	the lower bound of the cut
zcut_upper	the upper bound of the cut
key	the, for `GetElectronZcuts`

◆ Start()

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

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ Filter()

◆ GetElectronZcuts()

◆ GetRunNum()

◆ PrepareEvent()

◆ Run()

◆ SetElectronZcuts()

◆ Start()

◆ Stop()