Trk::AlignAlg Class Reference

#include <AlignAlg.h>

Inheritance diagram for Trk::AlignAlg:

Collaboration diagram for Trk::AlignAlg:

Public Member Functions
virtual	~AlignAlg ()
	destructor
virtual StatusCode	initialize ()
	initialize method
virtual StatusCode	start ()
	set up geometry and prepare the tools
virtual StatusCode	execute (const EventContext &ctx)
	loops over tracks in event, and accumulates information necessary for alignmnet
virtual StatusCode	stop ()
	processes information accumulated in execute method to determine alignment parameters
virtual StatusCode	finalize ()
	finalize method
void	showStatistics ()
	dumps statistics accumulated in each event
	AthAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	constructor
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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	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
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
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
ToolHandle< ITrackCollectionProvider >	m_trackCollectionProvider
ToolHandle< IAlignTrackPreProcessor >	m_alignTrackPreProcessor
	Pointer to AlignTrackPreProcessor, used to select hits on tracks and/or tracks before passing to AlignTrackCreator.
ToolHandle< IAlignTrackCreator >	m_alignTrackCreator
	Pointer to alignTrackCreator, used to convert Trk::Track to vector of AlignTrack.
ToolHandle< IAlignTrackDresser >	m_alignTrackDresser
	Pointer to alignTrackDresser, used to add residuals, derivatives, etc.
ToolHandle< IAlignTool >	m_alignTool
	Pointer to alignTool.
PublicToolHandle< IGeometryManagerTool >	m_geometryManagerTool
	Pointer to GeometryManagerTool, used to get lists of chambers for which alignment parameters will be determined.
ToolHandle< ITrkAlignDBTool >	m_trkAlignDBTool
	Pointer to TrkAlignDBTool, used for reading/writing alignment parameters from/to the database.
ToolHandle< IFillNtupleTool >	m_fillNtupleTool
	Pointer to FillNtupleTool, used to write track information to ntuple.
StringProperty	m_filename {this, "FileName", "Align.root", "name of ntuple file"}
StringProperty	m_filepath {this, "FilePath", "./", "path to ntuple file"}
BooleanProperty	m_solveOnly
BooleanProperty	m_writeNtuple
IntegerProperty	m_alignSolveLevel
TFile *	m_ntuple = nullptr
	output ntuple
BooleanProperty	m_writeLogfile
StringProperty	m_logfileName
std::ostream *	m_logStream = nullptr
	logfile output stream
int	m_nevents = 0
	number of processed events
int	m_ntracks = 0
	number of processed tracks
int	m_ntracksSel = 0
	number of selected tracks
int	m_ntracksProc = 0
	number of tracks successfully processed
int	m_ntracksDress = 0
	number of tracks successfully dressed
int	m_ntracksAccum = 0
	number of tracks successfully accumulated
StringProperty	m_alignTracksName
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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 40 of file AlignAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

~AlignAlg()

AlignAlg::~AlignAlg ( )

virtual

destructor

Definition at line 17 of file AlignAlg.cxx.

{
 
  if (m_ntuple && m_solveOnly) {  
    ATH_MSG_DEBUG("closing file");
    m_ntuple->Close(); 
    ATH_MSG_DEBUG("file closed");
  }
}

Member Function Documentation

AthAlgorithm()

AthAlgorithm::AthAlgorithm	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

constructor

Definition at line 31 of file AthAlgorithm.cxx.

                                                       :
  AthCommonAlgorithm<Gaudi::Algorithm>( name, pSvcLocator )
{
  // default cardinality for non-reentrant algorithms
  setProperty( "Cardinality", 1 ).orThrow("Unable to set property 'Cardinality'", name);
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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; }

execute()

StatusCode AlignAlg::execute ( const EventContext & ctx )

virtual

loops over tracks in event, and accumulates information necessary for alignmnet

Implements AthAlgorithm.

Definition at line 181 of file AlignAlg.cxx.

{
  ATH_MSG_DEBUG("AlignAlg::execute()");
 
 
  // increment number of events
  m_nevents++;
 
  if(m_solveOnly) {    
    if (m_nevents<=1)
      return StatusCode::SUCCESS;    
    else { 
      // return FAILURE to make sure that the job ends after 1st event
      msg(MSG::INFO)<<"Only doing the solving. Aborting event processing after first event."<<endmsg;
      msg(MSG::INFO)<<"Following ERROR message is not a problem..."<<endmsg;
      return StatusCode::FAILURE;
    }
  }
 

  //  1.  apply event selection, select hits, refit tracks
  // m_trackSelector->cleanTracks();
 
  // loop over tracks
  TrackCollection * alignTracks;
  const TrackCollection* originalTracks;
  
  StatusCode sc = m_trackCollectionProvider->trackCollection(originalTracks);
  if (!originalTracks || sc.isFailure()) return sc;
 
  if(originalTracks->empty()) {
    ATH_MSG_DEBUG("found no tracks");
    return StatusCode::SUCCESS;
  }
 
  // increment number of processed tracks
  m_ntracks += originalTracks->size();
  ATH_MSG_DEBUG("nTracks: "<<m_ntracks);
 
  // process track collection and create collection of AlignTracks
  alignTracks = m_alignTrackPreProcessor->processTrackCollection(originalTracks);
 
  // method returns zero or empty collection
  if (!alignTracks || alignTracks->empty()) {
    ATH_MSG_DEBUG("processTrackCollection() returned empty Track collection.");
    return StatusCode::SUCCESS;
  }
 
  // increment number of selected tracks
  m_ntracksSel += alignTracks->size();
 
  // loop over AlignTracks and pass to AlignTrackCreator and Dresser for more processing
  int itrk = 0;
  for (Track* trk : *alignTracks) {                               //  first loop over AlignTracks
 
    ATH_MSG_DEBUG("1st loop: Processing track "<<itrk);
 
    // each track in the collection HAS to be an AlignTrack
    AlignTrack * alignTrack = dynamic_cast<AlignTrack*>(trk);
    if(!alignTrack) {
      msg(MSG::FATAL)<<"Track is not an AlignTrack. PreProcessor returns TrackCollection but"
                     <<"it has to be filled with AlignTracks. Otherwise the code doesn't work."<<endmsg;
      return StatusCode::FAILURE;
    }
 
    // process AlignTrack
    bool success = m_alignTrackCreator->processAlignTrack(alignTrack);
    if (!success) {
      ATH_MSG_DEBUG("processAlignTrack() returned FALSE, Skipping the track.");
      continue;
    }
 
    m_ntracksProc++;
 
    // dress AlignTrack with extra info
    success = m_alignTrackDresser->dressAlignTrack(alignTrack);
    ATH_MSG_DEBUG("back from dressing AlignTrack");
    
    if (!success) {
      ATH_MSG_DEBUG("dressAlignTrack() returned FALSE, Skipping the track.");
      continue;
    }
    
    m_ntracksDress++;
 
    // accumulate vertex fit information:
    m_alignTrackPreProcessor->accumulateVTX(alignTrack);   
 
    ATH_MSG_DEBUG("back from accumulateVTX");
    
  }                                                                   // end of the first loop over AlignTracks
 
 
  // solve existing vertices:
  m_alignTrackPreProcessor->solveVTX();   
 
                                    
  for (Track* trk : *alignTracks) {                               //  second loop over AlignTracks
 
    ATH_MSG_DEBUG("2nd loop: Processing tracks");
 
    // each track in the collection HAS to be an AlignTrack
    AlignTrack * alignTrack = dynamic_cast<AlignTrack*>(trk);
    if(!alignTrack) {
      msg(MSG::FATAL)<<"Track is not an AlignTrack. PreProcessor returns TrackCollection but"
                     <<"it has to be filled with AlignTracks. Otherwise the code doesn't work."<<endmsg;
      return StatusCode::FAILURE;
    }
 
 
    // check if the dressing was successful:
    const Amg::SymMatrixX    * ptrWeights   = alignTrack->weightMatrix(); //Symmetric Matrix
    if ( !ptrWeights ) {
      ATH_MSG_DEBUG("dressAlignTrack failed, Skipping the track.");
      continue;
    }
 
    // check if the eventual VTX solving was successful:
    const AlignVertex        * ptrVertex    = alignTrack->getVtx();
    if ( ptrVertex && (ptrVertex->type() < AlignVertex::Refitted) ) {
      ATH_MSG_DEBUG("Vertex fit failed for this track. Skipping the track.");
      continue;
    }
 
 
    // pass to AlignTool for processing of track information
    bool success = m_alignTool->accumulate(alignTrack);
    ATH_MSG_DEBUG("back from accumulate");
    
    if (!success) {
      ATH_MSG_DEBUG("accumulate() returned FALSE, Skipping the track.");
      continue;
    }
    
    ATH_MSG_DEBUG("calling fillntuple::dumptrack");
 
    m_ntracksAccum++;
    
    if (m_writeNtuple)
      m_fillNtupleTool->dumpTrack(ctx, itrk,alignTrack);
    ATH_MSG_DEBUG("done with track "<<itrk);
 
  }                                                                   // end of the second loop over AlignTracks
 
 
 
 
  // record the collection in the StoreGate
  // the ownership is transferred to StoreGate so we don't delete the collection here
  if(evtStore()->record(alignTracks,m_alignTracksName,false).isFailure()) {
    ATH_MSG_ERROR("Unable to record "<<m_alignTracksName<<" in the StoreGate");
    delete alignTracks;
    alignTracks = nullptr;
  }
  if (alignTracks) ATH_MSG_DEBUG("Recorded \'"<<m_alignTracksName<<"\' with size "<<alignTracks->size()<<" to StoreGate");
 
  ATH_MSG_DEBUG("returning SUCCESS");
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 89 of file AthCommonAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

finalize()

StatusCode AlignAlg::finalize ( )

virtual

finalize method

Definition at line 416 of file AlignAlg.cxx.

{
  ATH_MSG_INFO("AlignAlg::finalize()");
 
  // close the logfile
  if(m_writeLogfile) {
    if(std::ofstream * ofs = dynamic_cast<std::ofstream *>(m_logStream)) {
      if(ofs->is_open()) {
        *ofs<<std::flush;
        ofs->close();
      }
      delete m_logStream;
    }
  }
  
  if (m_writeNtuple) {
    ATH_MSG_INFO("closing "<<m_ntuple->GetName());
    m_ntuple->Close();
  }
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode AlignAlg::initialize ( )

virtual

initialize method

Definition at line 28 of file AlignAlg.cxx.

{
  ATH_MSG_INFO("AlignAlg::initialize()");
 
  // Get GeometryManagerTool
  if ( m_geometryManagerTool.retrieve().isFailure() ) {
    msg(MSG::FATAL)<<"Failed to retrieve tool " << m_geometryManagerTool
       << endmsg;
    return StatusCode::FAILURE;
  }
  else
    ATH_MSG_INFO("Retrieved tool " << m_geometryManagerTool);
 
  // some tools are not needed if only solving is done
  if ( !m_solveOnly ) {
 
    // get TrackCollectionProvider
    if (m_trackCollectionProvider.retrieve().isSuccess())
      ATH_MSG_INFO("Retrieved " << m_trackCollectionProvider);
    else{
      msg(MSG::FATAL) << "Could not get " << m_trackCollectionProvider << endmsg; 
      return StatusCode::FAILURE;
    }
 
    // get AlignTrackPreProcessor
    if (m_alignTrackPreProcessor.retrieve().isSuccess())
      ATH_MSG_INFO("Retrieved " << m_alignTrackPreProcessor);
    else{
      msg(MSG::FATAL) << "Could not get " << m_alignTrackPreProcessor << endmsg; 
      return StatusCode::FAILURE;
    }
 
    // Get AlignTrackCreator tool
    if ( m_alignTrackCreator.retrieve().isFailure() ) {
      msg(MSG::FATAL)<<"Failed to retrieve tool "<<m_alignTrackCreator<<endmsg;
      return StatusCode::FAILURE;
    } 
    else
      ATH_MSG_INFO("Retrieved tool "<<m_alignTrackCreator);
 
    // Get AlignTrackDresser tool
    if ( m_alignTrackDresser.retrieve().isFailure() ) {
      msg(MSG::FATAL)<<"Failed to retrieve tool "<<m_alignTrackDresser<<endmsg;
      return StatusCode::FAILURE;
    } 
    else
      ATH_MSG_INFO("Retrieved tool "<<m_alignTrackDresser);
 
    // Get TrkAlign::FillTrack
    if (m_writeNtuple) {
      if ( m_fillNtupleTool.retrieve().isFailure() ) {
        msg(MSG::FATAL)<<"Failed to retrieve tool "<<m_fillNtupleTool<<endmsg;
        return StatusCode::FAILURE;
      }
      else
        ATH_MSG_INFO("Retrieved tool "<<m_fillNtupleTool);
    }
  }
  
  // Get AlignTool tool
  if ( m_alignTool.retrieve().isFailure() ) {
    msg(MSG::FATAL)<<"Failed to retrieve tool "<<m_alignTool<<endmsg;
    return StatusCode::FAILURE;
  } 
  else
    ATH_MSG_INFO("Retrieved tool "<<m_alignTool);
 
  // Get TrkAlignDataBaseTool  
  if ( m_trkAlignDBTool.retrieve().isFailure() ) {
    msg(MSG::FATAL)<<"Failed to retrieve tool "<<m_trkAlignDBTool<<endmsg;
    return StatusCode::FAILURE;
  } 
  else
    ATH_MSG_INFO("Retrieved tool "<<m_trkAlignDBTool);
 
  // Alignment Level
  // Number of layers in the superstructures
  if (m_alignSolveLevel>3 || m_alignSolveLevel<1) {
    msg(MSG::FATAL)<<"AlignSolveLevel could be 1, 2 or 3"<<endmsg;
    return StatusCode::FAILURE;
  }
 
  // open logfile
  if(m_writeLogfile) {
    std::ostream  * out   = &std::cout;
    std::ofstream * ofile = new std::ofstream(m_logfileName.value().c_str());
    if(!ofile->is_open()) {
      msg(MSG::ERROR)<<"Couldn't open logfile. Writing to standard output."<<endmsg;
      delete ofile;
    }
    else
      out = ofile;
 
    m_logStream = out;
 
    // set logStream in the tools
    m_geometryManagerTool->setLogStream(m_logStream);
    m_alignTool->setLogStream(m_logStream);
    m_trkAlignDBTool->setLogStream(m_logStream);
    if( !m_solveOnly ) {
         m_trackCollectionProvider->setLogStream(m_logStream);
         m_alignTrackPreProcessor->setLogStream(m_logStream);
         m_alignTrackCreator->setLogStream(m_logStream);
         m_alignTrackDresser->setLogStream(m_logStream);
         if (m_writeNtuple)
             m_fillNtupleTool->setLogStream(m_logStream);
    }
  }
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

{ return false; }

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

showStatistics()

void Trk::AlignAlg::showStatistics

(

)

dumps statistics accumulated in each event

start()

StatusCode AlignAlg::start ( )

virtual

set up geometry and prepare the tools

Definition at line 141 of file AlignAlg.cxx.

{
  ATH_MSG_DEBUG("AlignAlg::start()");
 
  if (m_writeNtuple) {
      m_ntuple = new TFile((m_filepath.value()+m_filename.value()).c_str(),"RECREATE");
      // set the ntuple points of the tools
      m_geometryManagerTool->setNtuple(m_ntuple);
      m_trackCollectionProvider->setNtuple(m_ntuple);
      m_alignTrackPreProcessor->setNtuple(m_ntuple);
      m_alignTool->setNtuple(m_ntuple);
      m_trkAlignDBTool->setNtuple(m_ntuple);
      m_fillNtupleTool->setNtuple(m_ntuple);
  }
 
  ATH_MSG_DEBUG("reading geometry");
  int NDoF = m_geometryManagerTool->ReadGeometry(m_alignSolveLevel);
  ATH_MSG_DEBUG("read geometry, "<<NDoF<<" alignment parameters");
 
  m_geometryManagerTool->PrintModPositions();
 
  // fix pathname (used to be m_pathbin+m+prefixName)
  // m_geometryManagerTool->StoreModPositions(pathname);
 
  StatusCode sc = m_alignTool->firstEventInitialize();
 
  if (sc != StatusCode::SUCCESS) {
    msg(MSG::FATAL)<<"problem with alignTool->firstEventInitialize()"<<endmsg;
    return StatusCode::FAILURE;
  }
 
  if(m_solveOnly) {
    ATH_MSG_DEBUG("getting data from files");
    m_alignTool->accumulateFromFiles();
  }
 
  return StatusCode::SUCCESS;
}

stop()

StatusCode AlignAlg::stop ( )

virtual

processes information accumulated in execute method to determine alignment parameters

Definition at line 344 of file AlignAlg.cxx.

{
  ATH_MSG_INFO("AlignAlg::stop()");
 
  if(m_logStream && !m_solveOnly) {
    *m_logStream<<"*************************************************************"<<std::endl;
    *m_logStream<<"******              Alignment Job summary              ******"<<std::endl;
    *m_logStream<<"*************************************************************"<<std::endl;
    *m_logStream<<"*"<<std::endl;
    *m_logStream<<"* number of processed events:     "<<m_nevents<<std::endl;
    *m_logStream<<"* number of processed tracks:     "<<m_ntracks<<std::endl;
    *m_logStream<<"* number of selected tracks:      "<<m_ntracksSel<<std::endl;
    *m_logStream<<"* number of tracks processed:     "<<m_ntracksProc<<std::endl;
    *m_logStream<<"* number of tracks dressed:       "<<m_ntracksDress<<std::endl;
    *m_logStream<<"* number of tracks accumulated:   "<<m_ntracksAccum<<std::endl;
 
    *m_logStream<<"*"<<std::endl;
 
     m_alignTrackPreProcessor->printSummary();
     m_trackCollectionProvider->printSummary();
  }
 
  // fill ntuple for all tools
  if (m_writeNtuple) {
    ATH_MSG_INFO("calling alignTool->fillNtuple()");
    if(m_alignTool->fillNtuple().isFailure()) {
      msg(MSG::ERROR)<<"problem with alignTool fillNtuple()!"<<endmsg;
      return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("calling fillNtupleTool->fillNtuple()");
    if(m_fillNtupleTool->fillNtuple().isFailure()) {
      msg(MSG::ERROR)<<"problem with fillNtupleTool fillNtuple()!"<<endmsg;
      return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO("calling alignTrackPreProcessor->fillNtuple()");
    if(m_alignTrackPreProcessor->fillNtuple().isFailure()) {
       msg(MSG::ERROR)<<"problem with alignTrackPreProcessor fillNtuple()!"<<endmsg;
       return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO("calling trackCollectionProvider->fillNtuple()");
    if(m_trackCollectionProvider->fillNtuple().isFailure()) {
       msg(MSG::ERROR)<<"problem with trackCollectionProvider fillNtuple()!"<<endmsg;
       return StatusCode::FAILURE;
    }
  }
  
  if(!m_solveOnly && m_ntracksSel==0) {
    msg(MSG::WARNING)<<"No tracks passed track selection. No solving."<<endmsg;
    return StatusCode::SUCCESS;
  }
 
  ATH_MSG_INFO("calling trkAlignDBTool->preSolve()");
  if (m_trkAlignDBTool->preSolve().isFailure()) {
    msg(MSG::FATAL)<<"failure in ITrkAlignDBTool->preSolve()"<<endmsg;
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("calling alignTool->solve()");
  if (m_alignTool->solve().isFailure()) {
    msg(MSG::FATAL)<<"failure in IAlignTool->solve()"<<endmsg;
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_INFO("calling trkAlignDBTool->writeAlignPar()");
  m_trkAlignDBTool->writeAlignPar();
 
  return StatusCode::SUCCESS;
}

sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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);
      }
    }
  }

Member Data Documentation

m_alignSolveLevel

IntegerProperty Trk::AlignAlg::m_alignSolveLevel

private

Initial value:

{this, "AlignSolveLevel", 3,
      "Set the Alignment Solve Level"}

Definition at line 117 of file AlignAlg.h.

                                     {this, "AlignSolveLevel", 3,
      "Set the Alignment Solve Level"};

m_alignTool

ToolHandle<IAlignTool> Trk::AlignAlg::m_alignTool

private

Initial value:

{
      this, "AlignTool", "Trk::GlobalChi2AlignTool",
      "alignment algorithm-specific tool"}

Pointer to alignTool.

Definition at line 90 of file AlignAlg.h.

                                        {
      this, "AlignTool", "Trk::GlobalChi2AlignTool",
      "alignment algorithm-specific tool"};

m_alignTrackCreator

ToolHandle<IAlignTrackCreator> Trk::AlignAlg::m_alignTrackCreator

private

Initial value:

{
      this, "AlignTrackCreator", "Trk::AlignTrackCreator",
      "tool for creating AlignTSOSCollection to store on AlignTrack"}

Pointer to alignTrackCreator, used to convert Trk::Track to vector of AlignTrack.

Definition at line 80 of file AlignAlg.h.

                                                        {
      this, "AlignTrackCreator", "Trk::AlignTrackCreator",
      "tool for creating AlignTSOSCollection to store on AlignTrack"};

m_alignTrackDresser

ToolHandle<IAlignTrackDresser> Trk::AlignAlg::m_alignTrackDresser

private

Initial value:

{
      this, "AlignTrackDresser", "Trk::AlignTrackDresser",
      "tool for dressing AlignTrack with residuals, derivatives, etc."}

Pointer to alignTrackDresser, used to add residuals, derivatives, etc.

to vector of AlignTrack

Definition at line 85 of file AlignAlg.h.

                                                        {
      this, "AlignTrackDresser", "Trk::AlignTrackDresser",
      "tool for dressing AlignTrack with residuals, derivatives, etc."};

m_alignTrackPreProcessor

ToolHandle<IAlignTrackPreProcessor> Trk::AlignAlg::m_alignTrackPreProcessor

private

Initial value:

{
      this, "AlignTrackPreProcessor", "Trk::AlignTrackPreProcessor",
      "tool for converting Trk::Track to AlignTrack after processing if necessary"}

Pointer to AlignTrackPreProcessor, used to select hits on tracks and/or tracks before passing to AlignTrackCreator.

Definition at line 75 of file AlignAlg.h.

                                                                {
      this, "AlignTrackPreProcessor", "Trk::AlignTrackPreProcessor",
      "tool for converting Trk::Track to AlignTrack after processing if necessary"};

m_alignTracksName

StringProperty Trk::AlignAlg::m_alignTracksName

private

Initial value:

{this, "AlignTracksName", "AlignTracks",
      "name of the AlignTrack collection in the StoreGate"}

Definition at line 134 of file AlignAlg.h.

                                    {this, "AlignTracksName", "AlignTracks",
      "name of the AlignTrack collection in the StoreGate"};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

m_filename

StringProperty Trk::AlignAlg::m_filename {this, "FileName", "Align.root", "name of ntuple file"}

private

Definition at line 109 of file AlignAlg.h.

{this, "FileName", "Align.root", "name of ntuple file"};

m_filepath

StringProperty Trk::AlignAlg::m_filepath {this, "FilePath", "./", "path to ntuple file"}

private

Definition at line 110 of file AlignAlg.h.

{this, "FilePath", "./", "path to ntuple file"};

m_fillNtupleTool

ToolHandle<IFillNtupleTool> Trk::AlignAlg::m_fillNtupleTool

private

Initial value:

{
      this, "FillNtupleTool", "",
      "tool for storing Trk::Track information into the ntuple"}

Pointer to FillNtupleTool, used to write track information to ntuple.

Definition at line 104 of file AlignAlg.h.

                                                 {
      this, "FillNtupleTool", "",
      "tool for storing Trk::Track information into the ntuple"};

m_geometryManagerTool

PublicToolHandle<IGeometryManagerTool> Trk::AlignAlg::m_geometryManagerTool

private

Initial value:

{
      this, "GeometryManagerTool", "InDet::InDetGeometryManagerTool",
      "tool for configuring geometry"}

Pointer to GeometryManagerTool, used to get lists of chambers for which alignment parameters will be determined.

Definition at line 95 of file AlignAlg.h.

                                                                 {
      this, "GeometryManagerTool", "InDet::InDetGeometryManagerTool",
      "tool for configuring geometry"};

m_logfileName

StringProperty Trk::AlignAlg::m_logfileName

private

Initial value:

{this, "LogFileName", "alignlogfile.txt",
      "name of the logfile"}

Definition at line 123 of file AlignAlg.h.

                                {this, "LogFileName", "alignlogfile.txt",
      "name of the logfile"};

m_logStream

std::ostream* Trk::AlignAlg::m_logStream = nullptr

private

logfile output stream

Definition at line 125 of file AlignAlg.h.

m_nevents

int Trk::AlignAlg::m_nevents = 0

private

number of processed events

Definition at line 127 of file AlignAlg.h.

m_ntracks

int Trk::AlignAlg::m_ntracks = 0

private

number of processed tracks

Definition at line 128 of file AlignAlg.h.

m_ntracksAccum

int Trk::AlignAlg::m_ntracksAccum = 0

private

number of tracks successfully accumulated

Definition at line 132 of file AlignAlg.h.

m_ntracksDress

int Trk::AlignAlg::m_ntracksDress = 0

private

number of tracks successfully dressed

Definition at line 131 of file AlignAlg.h.

m_ntracksProc

int Trk::AlignAlg::m_ntracksProc = 0

private

number of tracks successfully processed

Definition at line 130 of file AlignAlg.h.

m_ntracksSel

int Trk::AlignAlg::m_ntracksSel = 0

private

number of selected tracks

Definition at line 129 of file AlignAlg.h.

m_ntuple

TFile* Trk::AlignAlg::m_ntuple = nullptr

private

output ntuple

Definition at line 120 of file AlignAlg.h.

m_solveOnly

BooleanProperty Trk::AlignAlg::m_solveOnly

private

Initial value:

{this, "SolveOnly", false,
      "only do the solving (accumulate from binaries)"}

Definition at line 112 of file AlignAlg.h.

                               {this, "SolveOnly", false,
      "only do the solving (accumulate from binaries)"};

m_trackCollectionProvider

ToolHandle<ITrackCollectionProvider> Trk::AlignAlg::m_trackCollectionProvider

private

Initial value:

{
      this, "TrackCollectionProvider", "Trk::TrackCollectionProvider",
    "tool for getting track collection from StoreGate"}

Definition at line 70 of file AlignAlg.h.

                                                                   {
      this, "TrackCollectionProvider", "Trk::TrackCollectionProvider",
    "tool for getting track collection from StoreGate"};

m_trkAlignDBTool

ToolHandle<ITrkAlignDBTool> Trk::AlignAlg::m_trkAlignDBTool

private

Initial value:

{
      this, "AlignDBTool", "Trk::TrkAlignDBTool", "tool for handling DB stuff"}

Pointer to TrkAlignDBTool, used for reading/writing alignment parameters from/to the database.

Definition at line 100 of file AlignAlg.h.

                                                 {
      this, "AlignDBTool", "Trk::TrkAlignDBTool", "tool for handling DB stuff"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_writeLogfile

BooleanProperty Trk::AlignAlg::m_writeLogfile

private

Initial value:

{this, "WriteLogFile", true,
      "write a logfile for solving"}

Definition at line 121 of file AlignAlg.h.

                                  {this, "WriteLogFile", true,
      "write a logfile for solving"};

m_writeNtuple

BooleanProperty Trk::AlignAlg::m_writeNtuple

private

Initial value:

{this, "WriteNtuple", true,
      "write track and event information to ntuple"}

Definition at line 114 of file AlignAlg.h.

                                 {this, "WriteNtuple", true,
      "write track and event information to ntuple"};

---

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

• AlignAlg.h
• AlignAlg.cxx