Analysis Software
Documentation for sPHENIX simulation software
|
Implements an iterative vertex finder. More...
#include <acts/blob/sPHENIX/Core/include/Acts/Vertexing/AdaptiveMultiVertexFinder.hpp>
Classes | |
struct | Config |
Configuration struct. More... | |
struct | NeedsRemovedTracks |
struct | NeedsRemovedTracks< T, decltype((void) T::tracksToRemove, 0)> |
struct | State |
State struct for fulfilling interface. More... | |
Public Member Functions | |
template<typename T = InputTrack_t, std::enable_if_t< std::is_same< T, BoundTrackParameters >::value, int > = 0> | |
AdaptiveMultiVertexFinder (Config &cfg, std::unique_ptr< const Logger > logger=getDefaultLogger("AdaptiveMultiVertexFinder", Logging::INFO)) | |
Constructor used if InputTrack_t type == BoundTrackParameters. | |
m_logger (std::move(logger)) | |
AdaptiveMultiVertexFinder (Config &cfg, std::function< BoundTrackParameters(InputTrack_t)> func, std::unique_ptr< const Logger > logger=getDefaultLogger("AdaptiveMultiVertexFinder", Logging::INFO)) | |
Constructor for user-defined InputTrack_t type != BoundTrackParameters. | |
AdaptiveMultiVertexFinder (AdaptiveMultiVertexFinder &&)=default | |
Result< std::vector< Vertex < InputTrack_t > > > | find (const std::vector< const InputTrack_t * > &allTracks, const VertexingOptions< InputTrack_t > &vertexingOptions, State &state) const |
Function that performs the adaptive multi-vertex finding. | |
Private Types | |
using | Propagator_t = typename vfitter_t::Propagator_t |
using | InputTrack_t = typename vfitter_t::InputTrack_t |
using | Linearizer_t = typename vfitter_t::Linearizer_t |
using | FitterState_t = typename vfitter_t::State |
using | SeedFinderState_t = typename sfinder_t::State |
Private Member Functions | |
const Logger & | logger () const |
Private access to logging instance. | |
Result< Vertex< InputTrack_t > > | doSeeding (const std::vector< const InputTrack_t * > &trackVector, Vertex< InputTrack_t > ¤tConstraint, const VertexingOptions< InputTrack_t > &vertexingOptions, SeedFinderState_t &seedFinderState, const std::vector< const InputTrack_t * > &removedSeedTracks) const |
Calls the seed finder and sets constraints on the found seed vertex if desired. | |
void | setConstraintAfterSeeding (Vertex< InputTrack_t > ¤tConstraint, bool useVertexConstraintInFit, Vertex< InputTrack_t > &seedVertex) const |
Sets constraint vertex after seeding. | |
Result< double > | getIPSignificance (const InputTrack_t *track, const Vertex< InputTrack_t > &vtx, const VertexingOptions< InputTrack_t > &vertexingOptions) const |
Calculates the IP significance of a track to a given vertex. | |
Result< void > | addCompatibleTracksToVertex (const std::vector< const InputTrack_t * > &tracks, Vertex< InputTrack_t > &vtx, FitterState_t &fitterState, const VertexingOptions< InputTrack_t > &vertexingOptions) const |
Adds compatible track to vertex candidate. | |
Result< bool > | canRecoverFromNoCompatibleTracks (const std::vector< const InputTrack_t * > &allTracks, const std::vector< const InputTrack_t * > &seedTracks, Vertex< InputTrack_t > &vtx, const Vertex< InputTrack_t > ¤tConstraint, FitterState_t &fitterState, const VertexingOptions< InputTrack_t > &vertexingOptions) const |
Method that tries to recover from cases where no tracks were added to the vertex candidate after seeding. | |
Result< bool > | canPrepareVertexForFit (const std::vector< const InputTrack_t * > &allTracks, const std::vector< const InputTrack_t * > &seedTracks, Vertex< InputTrack_t > &vtx, const Vertex< InputTrack_t > ¤tConstraint, FitterState_t &fitterState, const VertexingOptions< InputTrack_t > &vertexingOptions) const |
Method that tries to prepare the vertex for the fit. | |
std::pair< int, bool > | checkVertexAndCompatibleTracks (Vertex< InputTrack_t > &vtx, const std::vector< const InputTrack_t * > &seedTracks, FitterState_t &fitterState, bool useVertexConstraintInFit) const |
Method that checks if vertex is a good vertex and if compatible tracks are available. | |
void | removeCompatibleTracksFromSeedTracks (Vertex< InputTrack_t > &vtx, std::vector< const InputTrack_t * > &seedTracks, FitterState_t &fitterState, std::vector< const InputTrack_t * > &removedSeedTracks) const |
Method that removes all tracks that are compatible with current vertex from seedTracks. | |
bool | removeTrackIfIncompatible (Vertex< InputTrack_t > &vtx, std::vector< const InputTrack_t * > &seedTracks, FitterState_t &fitterState, std::vector< const InputTrack_t * > &removedSeedTracks, const GeometryContext &geoCtx) const |
Method that tries to remove an incompatible track from seed tracks after removing a compatible track failed. | |
bool | keepNewVertex (Vertex< InputTrack_t > &vtx, const std::vector< Vertex< InputTrack_t > * > &allVertices, FitterState_t &fitterState) const |
Method that evaluates if the new vertex candidate should be kept, i.e. saved, or not. | |
bool | isMergedVertex (const Vertex< InputTrack_t > &vtx, const std::vector< Vertex< InputTrack_t > * > &allVertices) const |
Method that evaluates if the new vertex candidate is merged with one of the previously found vertices. | |
Result< void > | deleteLastVertex (Vertex< InputTrack_t > &vtx, std::vector< std::unique_ptr< Vertex< InputTrack_t >>> &allVertices, std::vector< Vertex< InputTrack_t > * > &allVerticesPtr, FitterState_t &fitterState, const VertexingOptions< InputTrack_t > &vertexingOptions) const |
Method that deletes last vertex from list of all vertices and refits all vertices afterwards. | |
Result< std::vector< Vertex < InputTrack_t > > > | getVertexOutputList (const std::vector< Vertex< InputTrack_t > * > &allVerticesPtr, FitterState_t &fitterState) const |
Prepares the output vector of vertices. | |
Private Attributes | |
Config | m_cfg |
Configuration object. | |
std::function < BoundTrackParameters(InputTrack_t)> | m_extractParameters |
Function to extract track parameters, InputTrack_t objects are BoundTrackParameters by default, function to be overwritten to return BoundTrackParameters for other InputTrack_t objects. | |
std::unique_ptr< const Logger > | m_logger |
Logging instance. | |
Implements an iterative vertex finder.
Brief description of the algorithm implemented: TODO
Definition at line 35 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 35 of file AdaptiveMultiVertexFinder.hpp
|
private |
Definition at line 39 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 39 of file AdaptiveMultiVertexFinder.hpp
|
private |
Definition at line 37 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 37 of file AdaptiveMultiVertexFinder.hpp
|
private |
Definition at line 38 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 38 of file AdaptiveMultiVertexFinder.hpp
|
private |
Definition at line 36 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 36 of file AdaptiveMultiVertexFinder.hpp
|
private |
Definition at line 40 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 40 of file AdaptiveMultiVertexFinder.hpp
|
inline |
Constructor used if InputTrack_t type == BoundTrackParameters.
cfg | Configuration object |
logger | The logging instance |
Definition at line 172 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 172 of file AdaptiveMultiVertexFinder.hpp
|
inline |
Constructor for user-defined InputTrack_t type != BoundTrackParameters.
cfg | Configuration object |
func | Function extracting BoundTrackParameters from InputTrack_t object |
logger | The logging instance |
Definition at line 187 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 187 of file AdaptiveMultiVertexFinder.hpp
|
default |
|
private |
Adds compatible track to vertex candidate.
tracks | The tracks | |
vtx | The vertex candidate | |
[out] | fitterState | The vertex fitter state |
vertexingOptions | Vertexing options |
Definition at line 226 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 226 of file AdaptiveMultiVertexFinder.ipp
References eZ, m_cfg(), Acts::Test::pos, and tracks().
|
private |
Method that tries to prepare the vertex for the fit.
allTracks | The tracks to be considered (either origTrack or seedTracks) | |
seedTracks | The seed tracks | |
[out] | vtx | The vertex candidate |
currentConstraint | Vertex constraint | |
[out] | fitterState | The vertex fitter state |
vertexingOptions | Vertexing options |
Definition at line 317 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 317 of file AdaptiveMultiVertexFinder.ipp
|
private |
Method that tries to recover from cases where no tracks were added to the vertex candidate after seeding.
allTracks | The tracks to be considered (either origTrack or seedTracks) | |
seedTracks | The seed tracks | |
[out] | vtx | The vertex candidate |
currentConstraint | Vertex constraint | |
[out] | fitterState | The vertex fitter state |
vertexingOptions | Vertexing options |
return True if recovery was successful, false otherwise
Definition at line 258 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 258 of file AdaptiveMultiVertexFinder.ipp
References ACTS_DEBUG, eZ, and Acts::Test::pos.
|
private |
Method that checks if vertex is a good vertex and if compatible tracks are available.
vtx | The vertex candidate |
seedTracks | The seed tracks |
fitterState | The vertex fitter state |
useVertexConstraintInFit | Indicates whether constraint is used in the vertex fit |
Definition at line 349 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 349 of file AdaptiveMultiVertexFinder.ipp
References ACTS_DEBUG, and m_cfg().
|
private |
Method that deletes last vertex from list of all vertices and refits all vertices afterwards.
vtx | The last added vertex which will be removed |
allVertices | Vector containing the unique_ptr to vertices |
allVerticesPtr | Vector containing the actual addresses |
fitterState | The current vertex fitter state |
vertexingOptions | Vertexing options |
Definition at line 549 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 549 of file AdaptiveMultiVertexFinder.ipp
References entry, and m_cfg().
|
private |
Calls the seed finder and sets constraints on the found seed vertex if desired.
trackVector | All tracks to be used for seeding |
currentConstraint | Vertex constraint |
vertexingOptions | Vertexing options |
seedFinderState | The seed finder state |
removedSeedTracks | Seed track that have been removed from seed track collection in last iteration |
Definition at line 139 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 139 of file AdaptiveMultiVertexFinder.ipp
References Acts::VertexingOptions< input_track_t >::constraint, m_cfg(), and Acts::VertexingOptions< input_track_t >::useConstraintInFit.
auto Acts::AdaptiveMultiVertexFinder< vfitter_t, sfinder_t >::find | ( | const std::vector< const InputTrack_t * > & | allTracks, |
const VertexingOptions< InputTrack_t > & | vertexingOptions, | ||
State & | state | ||
) | const |
Function that performs the adaptive multi-vertex finding.
allTracks | Input track collection |
vertexingOptions | Vertexing options |
state | State for fulfilling interfaces |
Definition at line 13 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 13 of file AdaptiveMultiVertexFinder.ipp
References ACTS_DEBUG, ACTS_ERROR, Acts::VertexingOptions< input_track_t >::constraint, Acts::Vertex< input_track_t >::fullPosition(), Acts::VertexingOptions< input_track_t >::geoContext, m_cfg(), Acts::VertexingOptions< input_track_t >::magFieldContext, Acts::Vertex< input_track_t >::position(), and Acts::VertexingOptions< input_track_t >::useConstraintInFit.
|
private |
Calculates the IP significance of a track to a given vertex.
track | The track |
vtx | The vertex |
vertexingOptions | Vertexing options |
Definition at line 192 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 192 of file AdaptiveMultiVertexFinder.ipp
References Acts::ImpactParametersAndSigma::d0, m_cfg(), Acts::Vertex< input_track_t >::setFullCovariance(), Acts::ImpactParametersAndSigma::sigmaD0, Acts::ImpactParametersAndSigma::sigmaZ0, and Acts::ImpactParametersAndSigma::z0.
|
private |
Prepares the output vector of vertices.
allVerticesPtr | Vector of pointers to vertices |
fitterState | The vertex fitter state |
Definition at line 580 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 580 of file AdaptiveMultiVertexFinder.ipp
|
private |
Method that evaluates if the new vertex candidate is merged with one of the previously found vertices.
vtx | The vertex candidate |
allVertices | All so far found vertices |
Definition at line 502 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 502 of file AdaptiveMultiVertexFinder.ipp
References eZ, Acts::Vertex< input_track_t >::fullCovariance(), Acts::Vertex< input_track_t >::fullPosition(), m_cfg(), and Acts::safeInverse().
|
private |
Method that evaluates if the new vertex candidate should be kept, i.e. saved, or not.
vtx | The vertex candidate |
allVertices | All so far found vertices |
fitterState | The vertex fitter state |
Definition at line 473 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 473 of file AdaptiveMultiVertexFinder.ipp
References m_cfg().
|
inlineprivate |
Private access to logging instance.
Definition at line 223 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 223 of file AdaptiveMultiVertexFinder.hpp
References Acts::AdaptiveMultiVertexFinder< vfitter_t, sfinder_t >::m_logger.
|
inline |
Definition at line 178 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 178 of file AdaptiveMultiVertexFinder.hpp
|
private |
Method that removes all tracks that are compatible with current vertex from seedTracks.
vtx | The vertex candidate | |
[out] | seedTracks | The seed tracks |
fitterState | The vertex fitter state | |
[out] | removedSeedTracks | Collection of seed track that will be removed |
Definition at line 390 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 390 of file AdaptiveMultiVertexFinder.ipp
References m_cfg().
|
private |
Method that tries to remove an incompatible track from seed tracks after removing a compatible track failed.
vtx | The vertex candidate | |
[out] | seedTracks | The seed tracks |
fitterState | The vertex fitter state | |
[out] | removedSeedTracks | Collection of seed track that will be removed |
[in] | geoCtx | The geometry context to access global positions |
Definition at line 416 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 416 of file AdaptiveMultiVertexFinder.ipp
References ACTS_DEBUG, eZ, geoCtx, i, and Acts::Test::pos.
|
private |
Sets constraint vertex after seeding.
currentConstraint | Vertex constraint |
useVertexConstraintInFit | Indicates whether constraint is used during vertex fit |
seedVertex | Seed vertex |
Definition at line 171 of file AdaptiveMultiVertexFinder.ipp.
View newest version in sPHENIX GitHub at line 171 of file AdaptiveMultiVertexFinder.ipp
References m_cfg().
|
private |
Configuration object.
Definition at line 212 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 212 of file AdaptiveMultiVertexFinder.hpp
|
private |
Function to extract track parameters, InputTrack_t objects are BoundTrackParameters by default, function to be overwritten to return BoundTrackParameters for other InputTrack_t objects.
Definition at line 217 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 217 of file AdaptiveMultiVertexFinder.hpp
|
private |
Logging instance.
Definition at line 220 of file AdaptiveMultiVertexFinder.hpp.
View newest version in sPHENIX GitHub at line 220 of file AdaptiveMultiVertexFinder.hpp
Referenced by Acts::AdaptiveMultiVertexFinder< vfitter_t, sfinder_t >::logger().