Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::IExperimentCuts< SpacePoint > Class Template Referenceabstract

#include <acts/blob/sPHENIX/Core/include/Acts/Seeding/IExperimentCuts.hpp>

+ Inheritance diagram for Acts::IExperimentCuts< SpacePoint >:

Public Member Functions

virtual ~IExperimentCuts ()=default
 
virtual float seedWeight (const InternalSpacePoint< SpacePoint > &bottom, const InternalSpacePoint< SpacePoint > &middle, const InternalSpacePoint< SpacePoint > &top) const =0
 
virtual bool singleSeedCut (float weight, const InternalSpacePoint< SpacePoint > &bottom, const InternalSpacePoint< SpacePoint > &middle, const InternalSpacePoint< SpacePoint > &top) const =0
 
virtual std::vector< typename
CandidatesForMiddleSp< const
InternalSpacePoint< SpacePoint >
>::value_type
cutPerMiddleSP (std::vector< typename CandidatesForMiddleSp< const InternalSpacePoint< SpacePoint >>::value_type > seedCandidates) const =0
 

Detailed Description

template<typename SpacePoint>
class Acts::IExperimentCuts< SpacePoint >

IExperimentCuts can be used to increase or decrease seed weights based on the space points used in a seed. Seed weights are also influenced by the SeedFilter default implementation. This tool is also used to decide if a seed passes a seed weight cut. As the weight is stored in seeds, there are two distinct methods.

Definition at line 24 of file IExperimentCuts.hpp.

View newest version in sPHENIX GitHub at line 24 of file IExperimentCuts.hpp

Constructor & Destructor Documentation

template<typename SpacePoint>
virtual Acts::IExperimentCuts< SpacePoint >::~IExperimentCuts ( )
virtualdefault

Member Function Documentation

template<typename SpacePoint>
virtual std::vector<typename CandidatesForMiddleSp< const InternalSpacePoint<SpacePoint> >::value_type> Acts::IExperimentCuts< SpacePoint >::cutPerMiddleSP ( std::vector< typename CandidatesForMiddleSp< const InternalSpacePoint< SpacePoint >>::value_type seedCandidates) const
pure virtual
Parameters
seedCandidatescontains collection of seed candidates created for one middle space point in a std::tuple format
Returns
vector of seed candidates that pass the cut

Implemented in TestHostCuts, Acts::ATLASCuts< SpacePoint >, Acts::ATLASCuts< SpacePoint >, and Acts::ATLASCuts< SpacePoint >.

template<typename SpacePoint>
virtual float Acts::IExperimentCuts< SpacePoint >::seedWeight ( const InternalSpacePoint< SpacePoint > &  bottom,
const InternalSpacePoint< SpacePoint > &  middle,
const InternalSpacePoint< SpacePoint > &  top 
) const
pure virtual

Returns seed weight bonus/malus depending on detector considerations.

Parameters
bottombottom space point of the current seed
middlemiddle space point of the current seed
toptop space point of the current seed
Returns
seed weight to be added to the seed's weight

Implemented in TestHostCuts, Acts::ATLASCuts< SpacePoint >, Acts::ATLASCuts< SpacePoint >, and Acts::ATLASCuts< SpacePoint >.

template<typename SpacePoint>
virtual bool Acts::IExperimentCuts< SpacePoint >::singleSeedCut ( float  weight,
const InternalSpacePoint< SpacePoint > &  bottom,
const InternalSpacePoint< SpacePoint > &  middle,
const InternalSpacePoint< SpacePoint > &  top 
) const
pure virtual
Parameters
weightthe current seed weight
bottombottom space point of the current seed
middlemiddle space point of the current seed
toptop space point of the current seed
Returns
true if the seed should be kept, false if the seed should be discarded

Implemented in TestHostCuts, Acts::ATLASCuts< SpacePoint >, Acts::ATLASCuts< SpacePoint >, and Acts::ATLASCuts< SpacePoint >.


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