Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::RoiDescriptor Class Reference

#include <acts/blob/sPHENIX/Core/include/Acts/TrackFinding/RoiDescriptor.hpp>

+ Collaboration diagram for Acts::RoiDescriptor:

Public Types

using roi_iterator = std::vector< const RoiDescriptor * >::const_iterator
 

Public Member Functions

 RoiDescriptor (double eta, double etaMinus, double etaPlus, double phi, double phiMinus, double phiPlus, double zed=0, double zedMinus=-s_zedWidthDefault, double zedPlus=s_zedWidthDefault)
 constructor
 
 RoiDescriptor (const RoiDescriptor &roi)
 
RoiDescriptoroperator= (const RoiDescriptor &r)
 
 ~RoiDescriptor ()
 
double phi () const
 
double eta () const
 
double zed () const
 
double zedPlus () const
 z at the most forward end of the RoI
 
double zedMinus () const
 z at the most backward end of the RoI
 
double etaPlus () const
 gets eta at zedPlus
 
double etaMinus () const
 gets eta at zMinus
 
double phiPlus () const
 gets phiPlus
 
double phiMinus () const
 gets phiMinus
 
int version () const
 versioning
 
void version (int v)
 
bool isFullscan () const
 output
 
bool composite () const
 SuperRoI compatibility methods.
 
void setComposite (bool b=true)
 
bool manageConstituents () const
 always manage constituents ???
 
void manageConstituents (bool b)
 
unsigned size () const
 number of constituents
 
const RoiDescriptorat (int i) const
 find an RoiDescriptor constituent
 
void clear ()
 clear the vector
 
void reserve (size_t s)
 reserve elements in vector
 
void push_back (const RoiDescriptor *roi)
 add a RoiDescriptor
 
roi_iterator begin () const
 iterators
 
roi_iterator end () const
 
double dzdrMinus () const
 return the gradients
 
double dzdrPlus () const
 dz/dr at the front of the RoI
 
double drdzMinus () const
 dr/dz at the rear of the RoI
 
double drdzPlus () const
 dr/dz at the front of the RoI
 
double zedMin (double r) const
 
double zedMax (double r) const
 
double zedOuterPlus () const
 z at the most forward end of the RoI
 
double zedOuterMinus () const
 z at the most backward end of the RoI
 
double rhoMin (double z) const
 
double rhoMax (double z) const
 
unsigned int roiId () const
 
unsigned int l1Id () const
 
unsigned int roiWord () const
 

Static Public Member Functions

static double zedWidthDefault ()
 
static void zedWidthDefault (double d)
 set default z-width (but only before any RoiDescriptor has been created)
 

Static Public Attributes

static constexpr bool FULLSCAN = true
 convenient
 
static constexpr bool ROI = false
 

Private Attributes

float m_phi {}
 phi of RoI center
 
float m_eta {}
 eta of RoI center
 
float m_zed {}
 zed of RoI center
 
float m_phiMinus {}
 most negative RoI in azimuthal
 
float m_phiPlus {}
 most positive RoI in azimuthal
 
float m_etaMinus {}
 eta of RoI at zedMinus
 
float m_etaPlus {}
 eta of RoI at zedPlus
 
float m_zedMinus {}
 
float m_zedPlus {}
 z position at most positive position along the beamline
 
float m_dzdrMinus {}
 dz/dr at the rear of the RoI
 
float m_dzdrPlus {}
 dz/dr at the front of the RoI
 
float m_drdzMinus {}
 dr/dz at the rear of the RoI
 
float m_drdzPlus {}
 dr/dz at the front of the RoI
 
float m_zedOuterMinus {}
 z at rear of RoI at the outer radius ( = 1100 mm)
 
float m_zedOuterPlus {}
 z at front of RoI at the outer radius ( = 1100 mm)
 
bool m_fullscan {}
 flag this as a full detector RoI
 
bool m_composite {}
 flag this as a composite RoI
 
bool m_manageConstituents {}
 
int m_version {}
 transient version identifier
 
std::vector< const
RoiDescriptor * > 
m_roiDescriptors
 roi constituents
 
unsigned int m_l1Id {0}
 lvl1 event number
 
unsigned int m_roiId {0}
 RoI number.
 
unsigned int m_roiWord {0}
 

Static Private Attributes

static std::atomic< doubles_zedWidthDefault
 default parameters - there may be better ways, but this will do
 
static std::atomic< bool > s_firstInstanceCreated
 to ensure default width is only set once at job startup
 

Detailed Description

Definition at line 22 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 22 of file RoiDescriptor.hpp

Member Typedef Documentation

using Acts::RoiDescriptor::roi_iterator = std::vector<const RoiDescriptor*>::const_iterator

Definition at line 25 of file RoiDescriptor.hpp.

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

Constructor & Destructor Documentation

Acts::RoiDescriptor::RoiDescriptor ( double  eta,
double  etaMinus,
double  etaPlus,
double  phi,
double  phiMinus,
double  phiPlus,
double  zed = 0,
double  zedMinus = -s_zedWidthDefault,
double  zedPlus = s_zedWidthDefault 
)

constructor

Parameters
etaeta of RoI
etaMinuseta at rear of RoI
etaPluseta at front of RoI
phiphi of RoI
phiMinusminimum phi of RoI
phiPlusmaximum phi of RoI
zedzed of RoI
zedMinuszed at rear of RoI
zedPluszed at front of RoI

Definition at line 17 of file RoiDescriptor.cpp.

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

Acts::RoiDescriptor::RoiDescriptor ( const RoiDescriptor roi)
Acts::RoiDescriptor::~RoiDescriptor ( )
default

Member Function Documentation

const RoiDescriptor* Acts::RoiDescriptor::at ( int  i) const
inline

find an RoiDescriptor constituent

Definition at line 104 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 104 of file RoiDescriptor.hpp

References m_roiDescriptors.

roi_iterator Acts::RoiDescriptor::begin ( ) const
inline

iterators

Definition at line 119 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 119 of file RoiDescriptor.hpp

References m_roiDescriptors.

void Acts::RoiDescriptor::clear ( )
inline

clear the vector

Definition at line 107 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 107 of file RoiDescriptor.hpp

References m_roiDescriptors.

bool Acts::RoiDescriptor::composite ( ) const
inline

SuperRoI compatibility methods.

am I a SuperRoi?

Definition at line 93 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 93 of file RoiDescriptor.hpp

References m_composite.

double Acts::RoiDescriptor::drdzMinus ( ) const
inline

dr/dz at the rear of the RoI

Definition at line 130 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 130 of file RoiDescriptor.hpp

References m_drdzMinus.

double Acts::RoiDescriptor::drdzPlus ( ) const
inline

dr/dz at the front of the RoI

Definition at line 133 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 133 of file RoiDescriptor.hpp

References m_drdzPlus.

double Acts::RoiDescriptor::dzdrMinus ( ) const
inline

return the gradients

dz/dr at the rear of the RoI

Definition at line 123 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 123 of file RoiDescriptor.hpp

References m_dzdrMinus.

Referenced by Acts::SeedFinderFTF< external_spacepoint_t >::runGNN_TrackFinder().

+ Here is the caller graph for this function:

double Acts::RoiDescriptor::dzdrPlus ( ) const
inline

dz/dr at the front of the RoI

Definition at line 126 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 126 of file RoiDescriptor.hpp

References m_dzdrPlus.

Referenced by Acts::SeedFinderFTF< external_spacepoint_t >::runGNN_TrackFinder().

+ Here is the caller graph for this function:

roi_iterator Acts::RoiDescriptor::end ( ) const
inline

Definition at line 120 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 120 of file RoiDescriptor.hpp

References m_roiDescriptors.

double Acts::RoiDescriptor::eta ( ) const
inline

Definition at line 60 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 60 of file RoiDescriptor.hpp

References m_eta.

double Acts::RoiDescriptor::etaMinus ( ) const
inline

gets eta at zMinus

Definition at line 75 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 75 of file RoiDescriptor.hpp

References m_etaMinus.

double Acts::RoiDescriptor::etaPlus ( ) const
inline

gets eta at zedPlus

Definition at line 74 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 74 of file RoiDescriptor.hpp

References m_etaPlus.

bool Acts::RoiDescriptor::isFullscan ( ) const
inline

output

is this a full scan RoI?

Definition at line 88 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 88 of file RoiDescriptor.hpp

References m_fullscan.

unsigned int Acts::RoiDescriptor::l1Id ( ) const
inline

Definition at line 159 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 159 of file RoiDescriptor.hpp

References m_l1Id.

bool Acts::RoiDescriptor::manageConstituents ( ) const
inline

always manage constituents ???

Definition at line 97 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 97 of file RoiDescriptor.hpp

References m_manageConstituents.

void Acts::RoiDescriptor::manageConstituents ( bool  b)
inline

Definition at line 98 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 98 of file RoiDescriptor.hpp

References KFPMath::b, and m_manageConstituents.

RoiDescriptor& Acts::RoiDescriptor::operator= ( const RoiDescriptor r)
double Acts::RoiDescriptor::phi ( ) const
inline

Definition at line 59 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 59 of file RoiDescriptor.hpp

References m_phi.

double Acts::RoiDescriptor::phiMinus ( ) const
inline

gets phiMinus

Definition at line 78 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 78 of file RoiDescriptor.hpp

References m_phiMinus.

double Acts::RoiDescriptor::phiPlus ( ) const
inline

gets phiPlus

Definition at line 77 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 77 of file RoiDescriptor.hpp

References m_phiPlus.

void Acts::RoiDescriptor::push_back ( const RoiDescriptor roi)
inline

add a RoiDescriptor

Definition at line 113 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 113 of file RoiDescriptor.hpp

References m_roiDescriptors, and setComposite().

+ Here is the call graph for this function:

void Acts::RoiDescriptor::reserve ( size_t  s)
inline

reserve elements in vector

Definition at line 110 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 110 of file RoiDescriptor.hpp

References m_roiDescriptors.

double Acts::RoiDescriptor::rhoMax ( double  z) const
double Acts::RoiDescriptor::rhoMin ( double  z) const
unsigned int Acts::RoiDescriptor::roiId ( ) const
inline

Definition at line 158 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 158 of file RoiDescriptor.hpp

References m_roiId.

unsigned int Acts::RoiDescriptor::roiWord ( ) const
inline

Definition at line 160 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 160 of file RoiDescriptor.hpp

References m_roiWord.

void Acts::RoiDescriptor::setComposite ( bool  b = true)
inline

Definition at line 94 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 94 of file RoiDescriptor.hpp

References KFPMath::b, and m_composite.

Referenced by push_back().

+ Here is the caller graph for this function:

unsigned Acts::RoiDescriptor::size ( ) const
inline

number of constituents

Definition at line 101 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 101 of file RoiDescriptor.hpp

References m_roiDescriptors.

int Acts::RoiDescriptor::version ( ) const
inline

versioning

Definition at line 81 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 81 of file RoiDescriptor.hpp

References m_version.

void Acts::RoiDescriptor::version ( int  v)
inline

Definition at line 82 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 82 of file RoiDescriptor.hpp

References m_version, and testSigmaEff::v.

double Acts::RoiDescriptor::zed ( ) const
inline

Definition at line 61 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 61 of file RoiDescriptor.hpp

References m_zed.

double Acts::RoiDescriptor::zedMax ( double  r) const
double Acts::RoiDescriptor::zedMin ( double  r) const

methods to calculate z position at the RoI boundary at a given radius

double Acts::RoiDescriptor::zedMinus ( ) const
inline

z at the most backward end of the RoI

Definition at line 70 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 70 of file RoiDescriptor.hpp

References m_zedMinus.

double Acts::RoiDescriptor::zedOuterMinus ( ) const
inline

z at the most backward end of the RoI

Definition at line 145 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 145 of file RoiDescriptor.hpp

References m_zedOuterMinus.

double Acts::RoiDescriptor::zedOuterPlus ( ) const
inline

z at the most forward end of the RoI

Definition at line 142 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 142 of file RoiDescriptor.hpp

References m_zedOuterPlus.

double Acts::RoiDescriptor::zedPlus ( ) const
inline

z at the most forward end of the RoI

these quantities probably don't need to be used any more

  • they are implemented here only because we had them in the original legacy interface

Definition at line 67 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 67 of file RoiDescriptor.hpp

References m_zedPlus.

static double Acts::RoiDescriptor::zedWidthDefault ( )
inlinestatic

Definition at line 152 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 152 of file RoiDescriptor.hpp

References s_zedWidthDefault.

static void Acts::RoiDescriptor::zedWidthDefault ( double  d)
static

set default z-width (but only before any RoiDescriptor has been created)

Member Data Documentation

constexpr bool Acts::RoiDescriptor::FULLSCAN = true
static

convenient

Definition at line 27 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 27 of file RoiDescriptor.hpp

bool Acts::RoiDescriptor::m_composite {}
private

flag this as a composite RoI

Definition at line 193 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 193 of file RoiDescriptor.hpp

Referenced by composite(), and setComposite().

float Acts::RoiDescriptor::m_drdzMinus {}
private

dr/dz at the rear of the RoI

Definition at line 184 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 184 of file RoiDescriptor.hpp

Referenced by drdzMinus().

float Acts::RoiDescriptor::m_drdzPlus {}
private

dr/dz at the front of the RoI

Definition at line 185 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 185 of file RoiDescriptor.hpp

Referenced by drdzPlus().

float Acts::RoiDescriptor::m_dzdrMinus {}
private

dz/dr at the rear of the RoI

Definition at line 181 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 181 of file RoiDescriptor.hpp

Referenced by dzdrMinus().

float Acts::RoiDescriptor::m_dzdrPlus {}
private

dz/dr at the front of the RoI

Definition at line 182 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 182 of file RoiDescriptor.hpp

Referenced by dzdrPlus().

float Acts::RoiDescriptor::m_eta {}
private

eta of RoI center

Definition at line 169 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 169 of file RoiDescriptor.hpp

Referenced by eta().

float Acts::RoiDescriptor::m_etaMinus {}
private

eta of RoI at zedMinus

Definition at line 174 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 174 of file RoiDescriptor.hpp

Referenced by etaMinus().

float Acts::RoiDescriptor::m_etaPlus {}
private

eta of RoI at zedPlus

Definition at line 175 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 175 of file RoiDescriptor.hpp

Referenced by etaPlus().

bool Acts::RoiDescriptor::m_fullscan {}
private

flag this as a full detector RoI

Definition at line 192 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 192 of file RoiDescriptor.hpp

Referenced by isFullscan().

unsigned int Acts::RoiDescriptor::m_l1Id {0}
private

lvl1 event number

Definition at line 202 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 202 of file RoiDescriptor.hpp

Referenced by l1Id().

bool Acts::RoiDescriptor::m_manageConstituents {}
private

flag to determine whether constituents should be managed

Definition at line 194 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 194 of file RoiDescriptor.hpp

Referenced by manageConstituents().

float Acts::RoiDescriptor::m_phi {}
private

phi of RoI center

Definition at line 168 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 168 of file RoiDescriptor.hpp

Referenced by phi().

float Acts::RoiDescriptor::m_phiMinus {}
private

most negative RoI in azimuthal

Definition at line 172 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 172 of file RoiDescriptor.hpp

Referenced by phiMinus().

float Acts::RoiDescriptor::m_phiPlus {}
private

most positive RoI in azimuthal

Definition at line 173 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 173 of file RoiDescriptor.hpp

Referenced by phiPlus().

std::vector<const RoiDescriptor*> Acts::RoiDescriptor::m_roiDescriptors
private

roi constituents

Definition at line 199 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 199 of file RoiDescriptor.hpp

Referenced by at(), begin(), clear(), end(), push_back(), reserve(), and size().

unsigned int Acts::RoiDescriptor::m_roiId {0}
private

RoI number.

Definition at line 203 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 203 of file RoiDescriptor.hpp

Referenced by roiId().

unsigned int Acts::RoiDescriptor::m_roiWord {0}
private

lvl1 RoI word from which this RoI was initially constructed

Definition at line 204 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 204 of file RoiDescriptor.hpp

Referenced by roiWord().

int Acts::RoiDescriptor::m_version {}
private

transient version identifier

Definition at line 197 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 197 of file RoiDescriptor.hpp

Referenced by version().

float Acts::RoiDescriptor::m_zed {}
private

zed of RoI center

Definition at line 170 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 170 of file RoiDescriptor.hpp

Referenced by zed().

float Acts::RoiDescriptor::m_zedMinus {}
private

z position at most negative position along the beamline

Definition at line 176 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 176 of file RoiDescriptor.hpp

Referenced by zedMinus().

float Acts::RoiDescriptor::m_zedOuterMinus {}
private

z at rear of RoI at the outer radius ( = 1100 mm)

Definition at line 188 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 188 of file RoiDescriptor.hpp

Referenced by zedOuterMinus().

float Acts::RoiDescriptor::m_zedOuterPlus {}
private

z at front of RoI at the outer radius ( = 1100 mm)

Definition at line 190 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 190 of file RoiDescriptor.hpp

Referenced by zedOuterPlus().

float Acts::RoiDescriptor::m_zedPlus {}
private

z position at most positive position along the beamline

Definition at line 179 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 179 of file RoiDescriptor.hpp

Referenced by zedPlus().

constexpr bool Acts::RoiDescriptor::ROI = false
static

Definition at line 28 of file RoiDescriptor.hpp.

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

std::atomic<bool> Acts::RoiDescriptor::s_firstInstanceCreated
staticprivate

to ensure default width is only set once at job startup

Definition at line 166 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 166 of file RoiDescriptor.hpp

std::atomic<double> Acts::RoiDescriptor::s_zedWidthDefault
staticprivate

default parameters - there may be better ways, but this will do

Definition at line 164 of file RoiDescriptor.hpp.

View newest version in sPHENIX GitHub at line 164 of file RoiDescriptor.hpp

Referenced by zedWidthDefault().


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