SeedToTrackConversionTool.h

// -*- C++ -*-

/*
  Copyright (C) 2002-2019 CERN for the benefit of the ATLAS collaboration
*/

///////////////////////////////////////////////////////////////////
// SeedToTrackConversionTool.h
// Version 0.0 01/02/2016 Weiming Yao(LBNL)  
///////////////////////////////////////////////////////////////////

#ifndef INDETSEEDTOTRACKCONVERSIONTOOL_H
#define INDETSEEDTOTRACKCONVERSIONTOOL_H

#include "AthenaBaseComps/AthAlgTool.h"
#include "InDetRecToolInterfaces/ISeedToTrackConversionTool.h"
#include "StoreGate/WriteHandleKey.h"
#include "TrkExInterfaces/IExtrapolator.h"
#include "TrkToolInterfaces/IRIO_OnTrackCreator.h"
#include "TrkTrack/TrackCollection.h"

#include "GaudiKernel/ToolHandle.h"

#include <atomic>
#include <list>

class MsgStream;

namespace InDet 
{

  /** @class SeedToTrackConversionTool 

      InDet::SeedToTrackConversionTool is tool that converts the seeds
      into track collection. 

      In AthenaMT, event dependent cache inside SeedToTrackConversionTool
      is not preferred. SeedToTrackConversionData class holds
      event dependent data for SeedToTrackConversionTool.
      Its object is instantiated in SiSPSeededTrackFinder::execute
      through SiTrackMakerEventData_xk.
      
      @author  Weiming Yao <Weiming.Yao>
  */  

  class SeedToTrackConversionTool : public extends<AthAlgTool, ISeedToTrackConversionTool>
  {
  public:
    /** @name Constructor */
    //@{
    SeedToTrackConversionTool(const std::string&,const std::string&,const IInterface*);
    //@}

    /** @name Default destructor */
    //@{
    virtual ~SeedToTrackConversionTool() = default;
    //@}

    /** @name Standard Athena-Algorithm initialize method */
    //@{
    virtual StatusCode initialize() override;
    //@}

    /** @name Standard Athena-Algorithm initialize method */
    //@{
    virtual StatusCode finalize() override;
    //@}

    /** @name Main methods for seeds conversion */
    //@{
    virtual void executeSiSPSeedSegments(SeedToTrackConversionData& data, const Trk::TrackParameters*, const int&, const std::vector<const Trk::SpacePoint*>&) const override;
    //!<seed trackparameters, number of tracks found:m_track.size(), list of spacepoints
    virtual void newEvent(SeedToTrackConversionData& data, const Trk::TrackInfo&, const std::string&) const override;
    virtual void endEvent(SeedToTrackConversionData& data) const override;
    //@}

    /** @name Print internal tool parameters and status */
    //@{
    virtual MsgStream& dump(SeedToTrackConversionData& data, MsgStream& out) const override;
    //@}

  private:
    /** @name Tool handles */
    //@{
    PublicToolHandle<Trk::IExtrapolator> m_extrapolator
      {this, "Extrapolator","Trk::Extrapolator", "extrapolator"};
    ToolHandle<Trk::IRIO_OnTrackCreator > m_rotcreator
      {this, "RIO_OnTrackCreator", "Trk::RIO_OnTrackCreator/InDetRotCreator", "Creator ROT"};
    //@}

    /** @name Data handles */
    //@{
    SG::WriteHandleKey<TrackCollection> m_seedsegmentsOutput{this, "OutputName", "SiSPSeedSegments", "SiSpSeedSegments Output Collection"};
    //@}

    /** @name Counters */
    //@{
    mutable std::atomic_int m_nprint{0}; //!< Kind output information
    mutable std::atomic_int m_totseed{0}; //!< number of total seeds in the pass
    mutable std::atomic_int m_survived{0}; //!< number of survived seeds 
    //@}

    /** @name Messaging methods */
    //@{
    MsgStream& dumpconditions(SeedToTrackConversionData& data, MsgStream& out) const;
    MsgStream& dumpevent     (SeedToTrackConversionData& data, MsgStream& out) const;
    //@}

  }; 
} // end of namespace

#endif