#include <Algorithm.h>

Detailed Description

Algorithm: Find the sector for all rows in REC::Particle

Algorithm Name:: clas12::SectorFinder

Algorithm Type:: Creator

Algorithm Inputs and Outputs:

Input Banks	REC::Particle, REC::Track, REC::Calorimeter, REC::Scintillator
Output Banks	REC::Particle::Sector

Configuration Options:

YAML configuration, which includes the default option values:

clas12::SectorFinder:
 
  ### use the default banks for both charged/uncharged particles
  bank_charged: default
  bank_uncharged: default
 
  ### alternatively, use custom banks; for example:
  # bank_charged: default              # default bank for charged particles
  # bank_uncharged: REC::Calorimeter   # custom bank for neutral particles

Table of options and descriptions:

Name	Type	Description
bank_charged	string	if not default, use this bank for sector finding of charged particles
bank_uncharged	string	if not default, use this bank for sector finding of neutral particles

If bank_charged and/or bank_uncharged is default, then all of the following banks are needed, in addition to REC::Particle:

REC::Track
REC::Calorimeter
REC::Scintillator

Otherwise only the bank(s) specified by bank_charged and bank_uncharged is/are needed, if both of them are non-default.

The action function GetStandardSector identifies the sector(s) using these banks in a priority order, whereas the action function GetSector uses a single bank's data. Note: rows that have been filtered out of REC::Particle will still have their sectors determined.

This algorithm creates a new bank and its definition is found within the Iguana Bank Definitions JSON File

For guidance on how to read this JSON file, see documentation on 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.

Definition at line 33 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.
int	GetSector (std::vector< int > const &sectors, std::vector< int > const &pindices, int const &pindex_particle) const
	Action Function: for a given particle with index pindex_particle, get its sector from a detector bank's list of sectors and pindices (both must be ordered in the same way)
int	GetStandardSector (std::vector< int > const &sectors_track, std::vector< int > const &pindices_track, std::vector< int > const &sectors_cal, std::vector< int > const &pindices_cal, std::vector< int > const &sectors_scint, std::vector< int > const &pindices_scint, int const &pindex_particle) const
	Action Function: for a given particle with index pindex_particle, get its sector from using the standard method
std::vector< int >	GetStandardSector (std::vector< int > const &sectors_track, std::vector< int > const &pindices_track, std::vector< int > const &sectors_cal, std::vector< int > const &pindices_cal, std::vector< int > const &sectors_scint, std::vector< int > const &pindices_scint, std::vector< int > const &pindices_particle) const
	Action Function: get sectors for all particles, using the standard method
void	GetListsSectorPindex (hipo::bank const &bank, std::vector< int > &sectors, std::vector< int > &pindices) const
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::SectorFinder:

Member Function Documentation

◆ GetListsSectorPindex()

void iguana::clas12::SectorFinder::GetListsSectorPindex	(	hipo::bank const &	bank,
		std::vector< int > &	sectors,
		std::vector< int > &	pindices ) const

fill lists of sectors and pindices present in the input bank

Note: this is not an action function, but here for convenience

Parameters

bank	bank from which to get lists of sectors and pindices
sectors	list to fill with sectors in the bank
pindices	list to fill with pindices in the bank

◆ GetSector()

int iguana::clas12::SectorFinder::GetSector	(	std::vector< int > const &	sectors,
		std::vector< int > const &	pindices,
		int const &	pindex_particle ) const

Action Function: for a given particle with index pindex_particle, get its sector from a detector bank's list of sectors and pindices (both must be ordered in the same way)

Function Type: scalar creator

Note: this is done instead of finding the pindex in the bank directly, to have an action function

Example: //... Initialise algorithms & banks ...

//For each event, do:

std::vector<int> sectors;

std::vector<int> pindices

//bank is a hipo::bank object from which we want to get the sectors

//for example the bank object related to REC::Calorimeter

for(auto const& row : bank.getRowList()) {

int det=bank.getInt("detector",row);

//NB: you should check you read from an FD detector

// e.g. det 7 is the ECAL (see/use `iguana::DetectorType` enum)

if(det==7){

sectors.push_back(bank.getInt("sector", row));

pindices.push_back(bank.getShort("pindex", row));

}

}

//partbank is a hipo::bank object related to REC::Particle

//algo_sector_finder is the iguana::clas12::SectorFinder object

for(auto const& row : partbank.getRowList()) {

int sector = algo_sector_finder.GetSector(sectors, pindices, row);

}

See also: GetStandardSector, which calls this method for detectors in a priority order

Parameters

sectors	list of sectors in a detector bank
pindices	list of pindices in a detector bank
pindex_particle	index in REC::Particle bank for which to get sector

Returns: sector for pindex_particle in list, -1 if pindex_particle not in inputted list

◆ GetStandardSector() [1/2]

int iguana::clas12::SectorFinder::GetStandardSector	(	std::vector< int > const &	sectors_track,
		std::vector< int > const &	pindices_track,
		std::vector< int > const &	sectors_cal,
		std::vector< int > const &	pindices_cal,
		std::vector< int > const &	sectors_scint,
		std::vector< int > const &	pindices_scint,
		int const &	pindex_particle ) const

Action Function: for a given particle with index pindex_particle, get its sector from using the standard method

Function Type: scalar creator

The following detectors' banks will be searched in order, and once the sector is found for any detector, it is returned:

REC::Track, using sectors_track and pindices_track
REC::Calorimeter, using sectors_cal and pindices_cal
REC::Scintillator, using sectors_scint and pindices_scint

See also: GetSector, which exemplifies using only one bank's lists of sectors and pindices

Parameters

sectors_track	list of sectors in REC::Track
pindices_track	list of pindices in REC::Track
sectors_cal	list of sectors in REC::Calorimeter
pindices_cal	list of pindices in REC::Calorimeter
sectors_scint	list of sectors in REC::Scintillator
pindices_scint	list of pindices in REC::Scintillator
pindex_particle	index in REC::Particle bank for which to get sector

Returns: sector for pindex_particle in lists, -1 if pindex_particle not any of the inputted lists

◆ GetStandardSector() [2/2]

std::vector< int > iguana::clas12::SectorFinder::GetStandardSector	(	std::vector< int > const &	sectors_track,
		std::vector< int > const &	pindices_track,
		std::vector< int > const &	sectors_cal,
		std::vector< int > const &	pindices_cal,
		std::vector< int > const &	sectors_scint,
		std::vector< int > const &	pindices_scint,
		std::vector< int > const &	pindices_particle ) const

Action Function: get sectors for all particles, using the standard method

Function Type: vector creator

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

See also: GetSector, which exemplifies using only one bank's lists of sectors and pindices

Parameters

sectors_track	list of sectors in REC::Track
pindices_track	list of pindices in REC::Track
sectors_cal	list of sectors in REC::Calorimeter
pindices_cal	list of pindices in REC::Calorimeter
sectors_scint	list of sectors in REC::Scintillator
pindices_scint	list of pindices in REC::Scintillator
pindices_particle	the REC::Particle list of pindices

Returns: list of sectors for each particle with pindex in pindices_particle

◆ Run()

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

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ GetListsSectorPindex()

◆ GetSector()

◆ GetStandardSector() [1/2]

◆ GetStandardSector() [2/2]

◆ Run()

◆ Start()

◆ Stop()