Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::VertexingOptions< input_track_t > Struct Template Reference

Vertex Finder Options. More...

#include <acts/blob/sPHENIX/Core/include/Acts/Vertexing/VertexingOptions.hpp>

Public Member Functions

 VertexingOptions ()=delete
 Default constructor is deleted.
 
 VertexingOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx, const Vertex< input_track_t > &constr, const bool useConstr=true)
 
 VertexingOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx)
 

Public Attributes

std::reference_wrapper< const
GeometryContext
geoContext
 Context object for the geometry.
 
std::reference_wrapper< const
MagneticFieldContext
magFieldContext
 Context object for the magnetic field.
 
Vertex< input_track_t > constraint
 
bool useConstraintInFit
 

Detailed Description

template<typename input_track_t>
struct Acts::VertexingOptions< input_track_t >

Vertex Finder Options.

Definition at line 23 of file VertexingOptions.hpp.

View newest version in sPHENIX GitHub at line 23 of file VertexingOptions.hpp

Constructor & Destructor Documentation

template<typename input_track_t>
Acts::VertexingOptions< input_track_t >::VertexingOptions ( )
delete

Default constructor is deleted.

template<typename input_track_t>
Acts::VertexingOptions< input_track_t >::VertexingOptions ( const GeometryContext gctx,
const MagneticFieldContext mctx,
const Vertex< input_track_t > &  constr,
const bool  useConstr = true 
)
inline

VertexingOptions with context and vertex constraint

Parameters
gctxGeometry context
mctxMagnetic field context
constrVertex constraint
useConstrBoolean indicating whether vertex constraint should be used during the vertex fit

Definition at line 33 of file VertexingOptions.hpp.

View newest version in sPHENIX GitHub at line 33 of file VertexingOptions.hpp

References Acts::VertexingOptions< input_track_t >::constraint, and Acts::VertexingOptions< input_track_t >::useConstraintInFit.

template<typename input_track_t>
Acts::VertexingOptions< input_track_t >::VertexingOptions ( const GeometryContext gctx,
const MagneticFieldContext mctx 
)
inline

VertexingOptions with context and without vertex constraint

Parameters
gctxGeometry context
mctxMagnetic field context

Definition at line 51 of file VertexingOptions.hpp.

View newest version in sPHENIX GitHub at line 51 of file VertexingOptions.hpp

References Acts::VertexingOptions< input_track_t >::constraint, and Acts::VertexingOptions< input_track_t >::useConstraintInFit.

Member Data Documentation

template<typename input_track_t>
Vertex<input_track_t> Acts::VertexingOptions< input_track_t >::constraint

Vertex constraint. Important note: While this variable is not used during the vertex fit if useConstraintInFit is set to false, it is always used during vertex finding.

Definition at line 65 of file VertexingOptions.hpp.

View newest version in sPHENIX GitHub at line 65 of file VertexingOptions.hpp

Referenced by Acts::AdaptiveMultiVertexFinder< vfitter_t, sfinder_t >::doSeeding(), Acts::TrackDensityVertexFinder< vfitter_t, track_density_t >::find(), Acts::ZScanVertexFinder< vfitter_t >::find(), Acts::AdaptiveMultiVertexFinder< vfitter_t, sfinder_t >::find(), Acts::FullBilloirVertexFitter< input_track_t, linearizer_t >::fit(), and Acts::VertexingOptions< input_track_t >::VertexingOptions().

template<typename input_track_t>
bool Acts::VertexingOptions< input_track_t >::useConstraintInFit

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