ActsExamples::TrackFindingAlgorithm Exception Reference

#include <acts/blob/sPHENIX/Examples/Algorithms/TrackFinding/include/ActsExamples/TrackFinding/TrackFindingAlgorithm.hpp>

Inheritance diagram for ActsExamples::TrackFindingAlgorithm:

Collaboration diagram for ActsExamples::TrackFindingAlgorithm:

Classes
struct	Config

Public Types
using	TrackFinderResult = Acts::Result< Acts::CombinatorialKalmanFilterResult< SimSourceLink >>
using	CKFOptions = Acts::CombinatorialKalmanFilterOptions< Acts::CKFSourceLinkSelector >
using	TrackFinderFunction = std::function< TrackFinderResult(const SimSourceLinkContainer &, const TrackParameters &, const CKFOptions &)>

Public Member Functions
	TrackFindingAlgorithm (Config cfg, Acts::Logging::Level lvl)
ActsExamples::ProcessCode	execute (const ActsExamples::AlgorithmContext &ctx) const finaloverride
Public Member Functions inherited from ActsExamples::BareAlgorithm
	BareAlgorithm (std::string name, Acts::Logging::Level level=Acts::Logging::INFO)
std::string	name () const finaloverride
	The algorithm name.

Static Public Member Functions
static TrackFinderFunction	makeTrackFinderFunction (std::shared_ptr< const Acts::TrackingGeometry > trackingGeometry, Options::BFieldVariant magneticField)

Private Attributes
Config	m_cfg

Additional Inherited Members
Protected Member Functions inherited from ActsExamples::BareAlgorithm
const Acts::Logger &	logger () const

Detailed Description

Definition at line 25 of file TrackFindingAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 25 of file TrackFindingAlgorithm.hpp

Member Typedef Documentation

using ActsExamples::TrackFindingAlgorithm::CKFOptions = Acts::CombinatorialKalmanFilterOptions<Acts::CKFSourceLinkSelector>

Track finding function that takes input measurements, initial trackstate and track finder options and returns some track-finding-specific result.

Definition at line 32 of file TrackFindingAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 32 of file TrackFindingAlgorithm.hpp

using ActsExamples::TrackFindingAlgorithm::TrackFinderFunction = std::function<TrackFinderResult( const SimSourceLinkContainer&, const TrackParameters&, const CKFOptions&)>

Definition at line 35 of file TrackFindingAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 35 of file TrackFindingAlgorithm.hpp

using ActsExamples::TrackFindingAlgorithm::TrackFinderResult = Acts::Result<Acts::CombinatorialKalmanFilterResult<SimSourceLink>>

Definition at line 28 of file TrackFindingAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 28 of file TrackFindingAlgorithm.hpp

Constructor & Destructor Documentation

ActsExamples::TrackFindingAlgorithm::TrackFindingAlgorithm	(	Config	cfg,
		Acts::Logging::Level	lvl
	)

Constructor of the track finding algorithm

Parameters

cfg	is the config struct to configure the algorithm
level	is the logging level

Definition at line 17 of file TrackFindingAlgorithm.cpp.

View newest version in sPHENIX GitHub at line 17 of file TrackFindingAlgorithm.cpp

References ActsExamples::TrackFindingAlgorithm::Config::inputInitialTrackParameters, ActsExamples::TrackFindingAlgorithm::Config::inputSourceLinks, m_cfg, and ActsExamples::TrackFindingAlgorithm::Config::outputTrajectories.

Member Function Documentation

ActsExamples::ProcessCode ActsExamples::TrackFindingAlgorithm::execute ( const ActsExamples::AlgorithmContext &  ctx ) const

finaloverridevirtual

Framework execute method of the track finding algorithm

Parameters

ctx	is the algorithm context that holds event-wise information

Returns

a process code to steer the algorithm flow

Implements ActsExamples::BareAlgorithm.

Definition at line 33 of file TrackFindingAlgorithm.cpp.

View newest version in sPHENIX GitHub at line 33 of file TrackFindingAlgorithm.cpp

References ACTS_DEBUG, ACTS_WARNING, ActsExamples::WhiteBoard::add(), ActsExamples::AlgorithmContext::calibContext, ActsExamples::AlgorithmContext::eventStore, ActsExamples::AlgorithmContext::geoContext, ActsExamples::WhiteBoard::get(), ActsExamples::AlgorithmContext::magFieldContext, Acts::PropagatorPlainOptions::maxSteps, and SUCCESS.

Here is the call graph for this function:

ActsExamples::TrackFindingAlgorithm::TrackFinderFunction ActsExamples::TrackFindingAlgorithm::makeTrackFinderFunction ( std::shared_ptr< const Acts::TrackingGeometry >  trackingGeometry, Options::BFieldVariant  magneticField  )

static

Create the track finder function implementation.

The magnetic field is intentionally given by-value since the variant contains shared_ptr anyways.

Definition at line 41 of file TrackFindingAlgorithmTrackFinderFunction.cpp.

View newest version in sPHENIX GitHub at line 41 of file TrackFindingAlgorithmTrackFinderFunction.cpp

References Acts::Test::navigator, and propagation_timing::stepper.

Member Data Documentation

Config ActsExamples::TrackFindingAlgorithm::m_cfg

private

Definition at line 72 of file TrackFindingAlgorithm.hpp.

View newest version in sPHENIX GitHub at line 72 of file TrackFindingAlgorithm.hpp

Referenced by TrackFindingAlgorithm().

---

The documentation for this exception was generated from the following files:

• acts/blob/sPHENIX/Examples/Algorithms/TrackFinding/include/ActsExamples/TrackFinding/TrackFindingAlgorithm.hpp
• acts/blob/sPHENIX/Examples/Algorithms/TrackFinding/src/TrackFindingAlgorithm.cpp
• acts/blob/sPHENIX/Examples/Algorithms/TrackFinding/src/TrackFindingAlgorithmTrackFinderFunction.cpp