Retrieve the BeamSpot information (official ID s/w result) More...

#include <BeamSpotRetriever.h>

Inheritance diagram for JiveXML::BeamSpotRetriever:

Collaboration diagram for JiveXML::BeamSpotRetriever:

Public Member Functions
virtual StatusCode	initialize () override
	BeamSpotRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor.
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool) override
	Retrieve all the data.
virtual std::string	dataTypeName () const override
	Return the name of the data type.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Return the interface identifier.

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
SG::ReadCondHandleKey< InDet::BeamSpotData >	m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" }
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

Retrieve the BeamSpot information (official ID s/w result)

Retrieved Data
- id: BeamSpot dump

Definition at line 23 of file BeamSpotRetriever.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

◆ BeamSpotRetriever()

JiveXML::BeamSpotRetriever::BeamSpotRetriever	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard constructor.

Standard AthAlgTool constructor.

Parameters

type	AlgTool type name
name	AlgTool instance name
parent	AlgTools parent owning this tool

Definition at line 17 of file BeamSpotRetriever.cxx.

                                                                                                          :
    AthAlgTool(type,name,parent) {
    
    //Declare the interface
    declareInterface<IDataRetriever>(this);
  }

Member Function Documentation

◆ dataTypeName()

virtual std::string JiveXML::BeamSpotRetriever::dataTypeName ( ) const

inlineoverridevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 37 of file BeamSpotRetriever.h.

37{ return "BeamSpot"; };

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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 JiveXML::BeamSpotRetriever::initialize ( )

overridevirtual

Definition at line 24 of file BeamSpotRetriever.cxx.

                                           {
      ATH_CHECK(m_beamSpotKey.initialize());
      return StatusCode::SUCCESS;
  }

◆ 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.

◆ interfaceID()

const InterfaceID & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

40{ return IID_IDataRetriever; }

JiveXML::IID_IDataRetriever

static const InterfaceID IID_IDataRetriever("JiveXML::IDataRetriever", 3, 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);
  }

◆ 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.

◆ 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();
  }

◆ retrieve()

StatusCode JiveXML::BeamSpotRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

overridevirtual

Retrieve all the data.

Implementation of DataRetriever interface.

for each pixel raw data object obtain the identifier
find the corresponding detector element and get its coordinates
fill in all information in the data map
Parameters

FormatTool the tool that will create formated output from the DataMap

from: https://twiki.cern.ch/twiki/bin/view/Atlas/InDetBeamSpotFAQ#How_can_I_retrieve_the_beam_spot

Implements JiveXML::IDataRetriever.

Definition at line 36 of file BeamSpotRetriever.cxx.

                                                                            {
 
    //be verbose
    ATH_MSG_DEBUG( "Retrieving " << dataTypeName() ); 
 
    DataVect x; x.reserve( 1 );  
    DataVect y; y.reserve( 1 );  
    DataVect z; z.reserve( 1 );  
    DataVect sigmaX; sigmaX.reserve( 1 );  
    DataVect sigmaXY; sigmaXY.reserve( 1 );  
    DataVect sigmaY; sigmaY.reserve( 1 );  
    DataVect sigmaZ; sigmaZ.reserve( 1 );  
    DataVect tiltX; tiltX.reserve( 1 );  
    DataVect tiltY; tiltY.reserve( 1 );  
    DataVect label; label.reserve( 1 );  
    DataVect status; status.reserve( 1 );  
    SG::ReadCondHandle<InDet::BeamSpotData> beamSpotHandle { m_beamSpotKey };
// add the following into the initialize routine.
  if ( !beamSpotHandle.isValid() ) {
    ATH_MSG_ERROR( "Failed to retrieve beamspot " );
    return StatusCode::RECOVERABLE;
  } else {
 
// references:
//    https://twiki.cern.ch/twiki/bin/view/Atlas/InDetBeamSpotFAQ#How_can_I_retrieve_the_beam_spot
//    InnerDetector/InDetCalibAlgs/InDetBeamSpotFinder/trunk/#path_InnerDetector_InDetCalibAlgs_InDetBeamSpotFinder_trunk_
//
// https://twiki.cern.ch/twiki/bin/view/Atlas/CoolBeamSpotParameters#Beam_Spot_Parametrization
//
// status    Status word - see bit definition below
// posX     x position of beam spot center (mm)
// posY     y position of beam spot center (mm)
// posZ     z position of beam spot center (mm)
// sigmaX   Width of beam spot in x (mm)
// sigmaY   Width of beam spot in x (mm)
// sigmaXY  rhoXY*sigmaX*sigmaY (mm^2) (describes rotation of non-circular beam spot in transverse plane)
// sigmaZ   Width of beam spot in z (mm)
// tiltX    Tilt angle in x-z plane (rad)
// tiltY    Tilt angle in y-z plane (rad)
 
 
 
    label.push_back( "Beamspot_position_at_PV_z_position" ); 
    
    Trk::RecVertex beamposition(beamSpotHandle->beamVtx());
    Amg::Vector3D posBS(beamposition.position());
 
    x.push_back( posBS.x() );
    y.push_back( posBS.y() );
    z.push_back( posBS.z() );
 
    sigmaX.push_back( beamSpotHandle->beamSigma(0) );
    sigmaY.push_back( beamSpotHandle->beamSigma(1) );
    sigmaZ.push_back( beamSpotHandle->beamSigma(2) );
    sigmaXY.push_back( beamSpotHandle->beamSigmaXY() );
 
    tiltX.push_back( beamSpotHandle->beamTilt(0) );
    tiltY.push_back( beamSpotHandle->beamTilt(1) );
 
    status.push_back( beamSpotHandle->beamStatus() );
 
    ATH_MSG_DEBUG( "BeamSpot Position: "
                   << beamSpotHandle->beamPos() );
    ATH_MSG_DEBUG( "BeamSpot Sigma "
                   << beamSpotHandle->beamSigma(0) << ", "
                   << beamSpotHandle->beamSigma(1) << ", "
                   << beamSpotHandle->beamSigma(2) );
    ATH_MSG_DEBUG( "BeamSpot Tilt: "
                   << beamSpotHandle->beamTilt(0) << ", "
                   << beamSpotHandle->beamTilt(1) );
    ATH_MSG_DEBUG( "Beamspot position at PV z-position" );
 
    //be verbose about the amount of data we retrieved
    ATH_MSG_DEBUG( "Retrieved " << label.size() << "Beamspot" );
 
    //Create a data map
    DataMap dataMap;
    //Add the data vectors to our map
    dataMap["x"]=std::move(x);
    dataMap["y"]=std::move(y);
    dataMap["z"]=std::move(z);
    dataMap["sigmaX"]=std::move(sigmaX);
    dataMap["sigmaY"]=std::move(sigmaY);
    dataMap["sigmaXY"]=std::move(sigmaXY);
    dataMap["sigmaZ"]=std::move(sigmaZ);
    dataMap["tiltX"]=std::move(tiltX);
    dataMap["tiltY"]=std::move(tiltY);
    dataMap["label"]=std::move(label);
    dataMap["status"]=std::move(status);
 
    //Forward data to formatting tool
    if ( FormatTool->AddToEvent(dataTypeName(), "BeamSpot", &dataMap).isFailure())
      return StatusCode::RECOVERABLE;
 
    //Clean up and exit
    ATH_MSG_DEBUG( dataTypeName() << " retrieved" );
    
    return StatusCode::SUCCESS;
    }
  }

◆ 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);
      }
    }
  }

Member Data Documentation

◆ m_beamSpotKey

SG::ReadCondHandleKey<InDet::BeamSpotData> JiveXML::BeamSpotRetriever::m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" }

private

Definition at line 41 of file BeamSpotRetriever.h.

41{ this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" };

◆ 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_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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ BeamSpotRetriever()

Member Function Documentation

◆ dataTypeName()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ retrieve()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_beamSpotKey

◆ m_detStore

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka