FPGATrackSimBinStep Class Reference

#include <FPGATrackSimBinStep.h>

Inheritance diagram for FPGATrackSimBinStep:

Collaboration diagram for FPGATrackSimBinStep:

Public Member Functions
	FPGATrackSimBinStep (const std::string &algname, const std::string &name, const IInterface *ifc)
virtual StatusCode	initialize () override
StatusCode	setRanges (FPGATrackSimBinStep *prev, const FPGATrackSimBinUtil::ParSet &parMin, const FPGATrackSimBinUtil::ParSet &parMax)
const std::vector< unsigned >	stepIdx (FPGATrackSimBinUtil::IdxSet idx) const
const std::vector< unsigned >	stepBins () const
const std::vector< unsigned > &	stepPars () const
const std::vector< unsigned >	nBins () const
const std::string	stepName () const
unsigned	stepNum () const
double	binCenter (unsigned par, unsigned bin) const
double	binLowEdge (unsigned par, unsigned bin) const
double	binHighEdge (unsigned par, unsigned bin) const
double	binWidth (unsigned par) const
FPGATrackSimBinUtil::ParSet	binLowEdge (const FPGATrackSimBinUtil::IdxSet &idx) const
FPGATrackSimBinUtil::ParSet	binCenter (const FPGATrackSimBinUtil::IdxSet &idx) const
unsigned	binIdx (unsigned par, double val) const
FPGATrackSimBinUtil::IdxSet	binIdx (const FPGATrackSimBinUtil::ParSet &pars) const
FPGATrackSimBinUtil::IdxSet	convertToPrev (const FPGATrackSimBinUtil::IdxSet &cur) const
bool	isFirstStep () const
void	initValidBins ()
void	setValidBin (const std::vector< unsigned > &idx)
void	printValidBin () const
const FPGATrackSimBinArray< int > &	validBinsFull () const
const FPGATrackSimBinArray< int > &	validBinsLocal () const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::vector< unsigned > >	m_parBinsConfig {this,"parBins",{},"Vector of number of bins for each parameter (expect 5)"}
std::vector< unsigned >	m_pars {}
FPGATrackSimBinArray< int >	m_validBinFull
FPGATrackSimBinArray< int >	m_validBinLocal
FPGATrackSimBinStep *	m_prev {0}
unsigned	m_stepNum {}
FPGATrackSimBinUtil::IdxSet	m_parBins
FPGATrackSimBinUtil::ParSet	m_parStep
FPGATrackSimBinUtil::ParSet	m_parMin
FPGATrackSimBinUtil::ParSet	m_parMax
friend	FPGATrackSimBinTool
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 45 of file FPGATrackSimBinStep.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

FPGATrackSimBinStep()

FPGATrackSimBinStep::FPGATrackSimBinStep ( const std::string & algname, const std::string & name, const IInterface * ifc )

inline

Definition at line 47 of file FPGATrackSimBinStep.h.

                                              : AthAlgTool(algname, name, ifc) {}

Member Function Documentation

binCenter() [1/2]

ParSet FPGATrackSimBinStep::binCenter

(

const FPGATrackSimBinUtil::IdxSet &

idx

)

const

Definition at line 91 of file FPGATrackSimBinStep.cxx.

{
    ParSet parset;
    for (unsigned i = 0; i < FPGATrackSimTrackPars::NPARS; i++)
    {
        parset[i] = binCenter(i, idx[i]);
    }
    return parset;
}

binCenter() [2/2]

double FPGATrackSimBinStep::binCenter ( unsigned par, unsigned bin ) const

inline

Definition at line 62 of file FPGATrackSimBinStep.h.

{ return m_parMin[par] + m_parStep[par] * (double(bin) + 0.5); }

binHighEdge()

double FPGATrackSimBinStep::binHighEdge ( unsigned par, unsigned bin ) const

inline

Definition at line 64 of file FPGATrackSimBinStep.h.

{ return m_parMin[par] + m_parStep[par] * (double(bin) + 1.0);}

binIdx() [1/2]

IdxSet FPGATrackSimBinStep::binIdx

(

const FPGATrackSimBinUtil::ParSet &

pars

)

const

Definition at line 101 of file FPGATrackSimBinStep.cxx.

{
    IdxSet retv;
    for (unsigned i = 0; i < FPGATrackSimTrackPars::NPARS; i++)
    {
        retv[i] = binIdx(i, pars[i]);
    }
    return retv;
}

binIdx() [2/2]

unsigned FPGATrackSimBinStep::binIdx ( unsigned par, double val ) const

inline

Definition at line 70 of file FPGATrackSimBinStep.h.

                                                  {
    // Guard against both underflow and overflow.
    if (val < m_parMin[par]) return 0;
    else if (val > m_parMax[par]) return unsigned(floor((m_parMax[par] - m_parMin[par]) / m_parStep[par])) - 1;
    else return unsigned(floor((val - m_parMin[par]) / m_parStep[par]));
  }

binLowEdge() [1/2]

ParSet FPGATrackSimBinStep::binLowEdge

(

const FPGATrackSimBinUtil::IdxSet &

idx

)

const

Definition at line 81 of file FPGATrackSimBinStep.cxx.

{
    ParSet parset;
    for (unsigned i = 0; i < FPGATrackSimTrackPars::NPARS; i++)
    {
        parset[i] = binLowEdge(i, idx[i]);
    }
    return parset;
}

binLowEdge() [2/2]

double FPGATrackSimBinStep::binLowEdge ( unsigned par, unsigned bin ) const

inline

Definition at line 63 of file FPGATrackSimBinStep.h.

{ return m_parMin[par] + m_parStep[par] * (double(bin)); }

binWidth()

double FPGATrackSimBinStep::binWidth ( unsigned par ) const

inline

Definition at line 65 of file FPGATrackSimBinStep.h.

{ return m_parStep[par]; }

convertToPrev()

IdxSet FPGATrackSimBinStep::convertToPrev

(

const FPGATrackSimBinUtil::IdxSet &

cur

)

const

Definition at line 114 of file FPGATrackSimBinStep.cxx.

                                                                                    {
  IdxSet retv{};
  if (m_prev) {
    for (unsigned par =0; par < FPGATrackSimTrackPars::NPARS; par++) {
      retv[par] = int(cur[par]*((const FPGATrackSimBinStep*)m_prev)->m_parBins[par]/m_parBins[par]);
    }
  } else {
    ATH_MSG_FATAL("convertToPrev called, but no previous");
  }
  return retv;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

initialize()

StatusCode FPGATrackSimBinStep::initialize ( )

overridevirtual

Definition at line 19 of file FPGATrackSimBinStep.cxx.

{
  // Dump the configuration to make sure it propagated through right
  const std::vector<Gaudi::Details::PropertyBase*> props = this->getProperties();
  for( Gaudi::Details::PropertyBase* prop : props ) {
    if (prop->ownerTypeName()==this->type()) {      
      ATH_MSG_DEBUG("Property:\t" << prop->name() << "\t : \t" << prop->toString());
    }
  }
 
  return StatusCode::SUCCESS;
}

initValidBins()

void FPGATrackSimBinStep::initValidBins

(

)

Definition at line 139 of file FPGATrackSimBinStep.cxx.

                                        {
  m_validBinFull.setsize(m_parBins, false);
  m_validBinLocal.setsize(stepIdx(m_parBins), false);
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isFirstStep()

bool FPGATrackSimBinStep::isFirstStep ( ) const

inline

Definition at line 84 of file FPGATrackSimBinStep.h.

{return m_prev==0;}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

nBins()

const std::vector< unsigned > FPGATrackSimBinStep::nBins ( ) const

inline

Definition at line 57 of file FPGATrackSimBinStep.h.

{return m_parBins;}   // bin sizes for only the pars used in this step

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

printValidBin()

void FPGATrackSimBinStep::printValidBin

(

)

const

Definition at line 144 of file FPGATrackSimBinStep.cxx.

                                              {
  // count valid bins
  int validBinsFull = 0;
  
  for (FPGATrackSimBinArray<int>::ConstIterator bin : m_validBinFull) {
    if (bin.data())
      validBinsFull++;
  }
  ATH_MSG_INFO("Step" << name() << "Valid Bins Full: " << validBinsFull);
 
  // count valid bins local
  int validBinsLocal = 0;
  for (FPGATrackSimBinArray<int>::ConstIterator bin : m_validBinLocal) {
  if (bin.data())
    validBinsLocal++;
  }
  ATH_MSG_INFO("Step" << name() <<  "Valid Bins Local: " << validBinsLocal);
    
}

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setRanges()

StatusCode FPGATrackSimBinStep::setRanges	(	FPGATrackSimBinStep *	prev,
		const FPGATrackSimBinUtil::ParSet &	parMin,
		const FPGATrackSimBinUtil::ParSet &	parMax )

Definition at line 32 of file FPGATrackSimBinStep.cxx.

                                                                {
 
  m_prev = prev;
  if (prev) {
    m_stepNum = prev->m_stepNum+1;
  } else {
    m_stepNum = 0;    
  }
  m_parMin = parMin;
  m_parMax = parMax;
  m_parBins = std::vector<unsigned>(m_parBinsConfig);
  for (unsigned par = 0; par < FPGATrackSimTrackPars::NPARS; par++) {
    if (m_parBins[par] <= 0) {
      ATH_MSG_FATAL("Every dimension must be at least one bin");
      return StatusCode::FAILURE;
    }
    m_parStep[par] = (m_parMax[par] - m_parMin[par]) / m_parBins[par];
    if (m_parBins[par] <= 0)
    {
      ATH_MSG_FATAL("Every dimension must be at least one bin (set #bins=1 for not binning in that parameter)");
    }
    if (prev) {
      if (m_parBins[par] < prev->m_parBins[par]) {
        ATH_MSG_FATAL("Number of bins can only increase with each step");
        return StatusCode::FAILURE;
      }
      if (m_parBins[par] % prev->m_parBins[par] !=0) {
        ATH_MSG_FATAL("Number of bins must be integer multiple of bins in previous step");
        return StatusCode::FAILURE;
      }
      if (m_parBins[par] != prev->m_parBins[par]) {
        // This step involves this parameter
        m_pars.push_back(par);
      }
    } else {
      if (m_parBins[par] != 1) {
        // This step involves this parameter
        m_pars.push_back(par);
      }
    }
  }
 
  ATH_MSG_DEBUG("Parameters = " << m_pars);
 
  return StatusCode::SUCCESS;
}

setValidBin()

void FPGATrackSimBinStep::setValidBin

(

const std::vector< unsigned > &

idx

)

Definition at line 133 of file FPGATrackSimBinStep.cxx.

                                                                    {
  m_validBinFull[idx] = true;
  m_validBinLocal[stepIdx(idx)] = true;
  if (m_prev) m_prev->setValidBin(convertToPrev(idx));
}

stepBins()

const std::vector< unsigned > FPGATrackSimBinStep::stepBins

(

)

const

Definition at line 130 of file FPGATrackSimBinStep.cxx.

                                                              {
    return FPGATrackSimBinUtil::subVec(m_pars, m_parBins);}

stepIdx()

const std::vector< unsigned > FPGATrackSimBinStep::stepIdx

(

FPGATrackSimBinUtil::IdxSet

idx

)

const

Definition at line 127 of file FPGATrackSimBinStep.cxx.

                                                                       {
       return FPGATrackSimBinUtil::subVec(m_pars, idx);}

stepName()

const std::string FPGATrackSimBinStep::stepName ( ) const

inline

Definition at line 58 of file FPGATrackSimBinStep.h.

{return this->name().substr(this->name().find_last_of(".")+1);}

stepNum()

unsigned FPGATrackSimBinStep::stepNum ( ) const

inline

Definition at line 59 of file FPGATrackSimBinStep.h.

{return m_stepNum;}

stepPars()

const std::vector< unsigned > & FPGATrackSimBinStep::stepPars ( ) const

inline

Definition at line 56 of file FPGATrackSimBinStep.h.

{return m_pars;}  // parameters used for this step

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

validBinsFull()

const FPGATrackSimBinArray< int > & FPGATrackSimBinStep::validBinsFull ( ) const

inline

Definition at line 97 of file FPGATrackSimBinStep.h.

{ return m_validBinFull;}

validBinsLocal()

const FPGATrackSimBinArray< int > & FPGATrackSimBinStep::validBinsLocal ( ) const

inline

Definition at line 98 of file FPGATrackSimBinStep.h.

{ return m_validBinLocal;}

Member Data Documentation

FPGATrackSimBinTool

friend FPGATrackSimBinStep::FPGATrackSimBinTool

private

Definition at line 124 of file FPGATrackSimBinStep.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_parBins

FPGATrackSimBinUtil::IdxSet FPGATrackSimBinStep::m_parBins

private

Definition at line 117 of file FPGATrackSimBinStep.h.

m_parBinsConfig

Gaudi::Property<std::vector<unsigned> > FPGATrackSimBinStep::m_parBinsConfig {this,"parBins",{},"Vector of number of bins for each parameter (expect 5)"}

private

Definition at line 101 of file FPGATrackSimBinStep.h.

{this,"parBins",{},"Vector of number of bins for each parameter (expect 5)"};

m_parMax

FPGATrackSimBinUtil::ParSet FPGATrackSimBinStep::m_parMax

private

Definition at line 122 of file FPGATrackSimBinStep.h.

m_parMin

FPGATrackSimBinUtil::ParSet FPGATrackSimBinStep::m_parMin

private

Definition at line 121 of file FPGATrackSimBinStep.h.

m_pars

std::vector<unsigned> FPGATrackSimBinStep::m_pars {}

private

Definition at line 104 of file FPGATrackSimBinStep.h.

{}; 

m_parStep

FPGATrackSimBinUtil::ParSet FPGATrackSimBinStep::m_parStep

private

Definition at line 118 of file FPGATrackSimBinStep.h.

m_prev

FPGATrackSimBinStep* FPGATrackSimBinStep::m_prev {0}

private

Definition at line 113 of file FPGATrackSimBinStep.h.

{0};

m_stepNum

unsigned FPGATrackSimBinStep::m_stepNum {}

private

Definition at line 114 of file FPGATrackSimBinStep.h.

{}; // number of step

m_validBinFull

FPGATrackSimBinArray<int> FPGATrackSimBinStep::m_validBinFull

private

Definition at line 109 of file FPGATrackSimBinStep.h.

m_validBinLocal

FPGATrackSimBinArray<int> FPGATrackSimBinStep::m_validBinLocal

private

Definition at line 110 of file FPGATrackSimBinStep.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• FPGATrackSimBinStep.h
• FPGATrackSimBinStep.cxx