Creates a new ROI centred on an object deriving from xAOD::IParticle. More...

#include <ViewCreatorCentredOnIParticleROITool.h>

Inheritance diagram for ViewCreatorCentredOnIParticleROITool:

Collaboration diagram for ViewCreatorCentredOnIParticleROITool:

Public Member Functions
	ViewCreatorCentredOnIParticleROITool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~ViewCreatorCentredOnIParticleROITool ()=default
virtual StatusCode	initialize () override
virtual StatusCode	attachROILinks (TrigCompositeUtils::DecisionContainer &decisions, const EventContext &ctx) const override
	Tool interface method.

Public Attributes
SG::WriteHandleKey< TrigRoiDescriptorCollection >	m_roisWriteHandleKey
Gaudi::Property< std::string >	m_iParticleLinkName
Gaudi::Property< double >	m_roiEtaWidth
Gaudi::Property< double >	m_roiPhiWidth
Gaudi::Property< double >	m_roiZedWidth
Gaudi::Property< double >	m_roiZedSinThetaFlag
Gaudi::Property< bool >	m_useZedPosition
Gaudi::Property< bool >	m_useBeamspot

Detailed Description

Creates a new ROI centred on an object deriving from xAOD::IParticle.

Stores this new ROI in the output container, and links it to the Decision Object

The new EventView spawned by the parent EventViewCreatorAlgorithm of this tool will process in this new ROI.

In the majority of cases, this tool will be used to create the new ROI centred on the "feature" from the previous Step.

Definition at line 24 of file ViewCreatorCentredOnIParticleROITool.h.

Constructor & Destructor Documentation

◆ ViewCreatorCentredOnIParticleROITool()

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

Definition at line 15 of file ViewCreatorCentredOnIParticleROITool.cxx.

16 : base_class(type, name, parent)

17 {}

◆ ~ViewCreatorCentredOnIParticleROITool()

virtual ViewCreatorCentredOnIParticleROITool::~ViewCreatorCentredOnIParticleROITool ( )

virtualdefault

Member Function Documentation

◆ attachROILinks()

StatusCode ViewCreatorCentredOnIParticleROITool::attachROILinks	(	TrigCompositeUtils::DecisionContainer &	decisions,
		const EventContext &	ctx ) const

overridevirtual

Tool interface method.

1/sin(theta) = cosh( eta )

Definition at line 26 of file ViewCreatorCentredOnIParticleROITool.cxx.

                                                                                                                                             {
  SG::WriteHandle<TrigRoiDescriptorCollection> roisWriteHandle = createAndStoreNoAux(m_roisWriteHandleKey, ctx);
  
  for ( Decision* outputDecision : decisions ) { 
    
    std::set<const Decision*> cache;
    std::vector<SG::sgkey_t> keys;
    std::vector<uint32_t> clids;
    std::vector<Decision::index_type> indices;
    std::vector<const Decision*> sources;
    typelessFindLinks(outputDecision, m_iParticleLinkName, keys, clids, indices, sources, TrigDefs::lastFeatureOfType, &cache);
 
    //expect only one link per decision
    if(keys.size()!=1){
      ATH_MSG_ERROR("Did not find exactly one object having searched for a link named '"<<m_iParticleLinkName<<"'. Found "<<keys.size()<<" instead");
      return StatusCode::FAILURE;
    }
 
    //first check if we've found a MET feature, and attach a FS RoI if so
    if( clids.at(0) == ClassID_traits<xAOD::TrigMissingETContainer>::ID()){
      ATH_MSG_DEBUG("Encountered a MET feature in the CentredOnIParticle ROITool. Cannot centre an ROI on this. Attaching a FullScan RoI");
      roisWriteHandle->push_back( new TrigRoiDescriptor( RoiDescriptor::FULLSCAN ) );
      const ElementLink<TrigRoiDescriptorCollection> roiEL = ElementLink<TrigRoiDescriptorCollection>(*roisWriteHandle, roisWriteHandle->size() - 1, ctx);
      outputDecision->setObjectLink(roiString(), roiEL);
      continue;
    }
 
    //If not MET, we should have an IParticle
    const ElementLink<xAOD::IParticleContainer> p4EL(keys.at(0), indices.at(0), ctx);
    ATH_CHECK(p4EL.isValid());
 
    const double reta  = (*p4EL)->eta();
    const double retap = reta + m_roiEtaWidth;
    const double retam = reta - m_roiEtaWidth;
    const double rphi  = (*p4EL)->phi();
    const double rphip = rphi + m_roiPhiWidth;
    const double rphim = rphi - m_roiPhiWidth;
 
    TrigRoiDescriptor *newROI = nullptr;
 
    if ( m_roiZedWidth >= 0  ) {
 
         const xAOD::Muon* muon = dynamic_cast< const xAOD::Muon*>(*p4EL); //get muon of this found object
         double zed0  = 0.0; //initialization
      
         bool update_z_width = true;
      
         if ( m_useZedPosition ) { 
        if ( muon && muon->primaryTrackParticle() ) { 
           zed0 = muon->primaryTrackParticle()->z0();
           if ( m_useBeamspot ) zed0 += muon->primaryTrackParticle()->vz();
        }
        else update_z_width = false;
         }
    
     if ( update_z_width ) { 
 
         double zed0p   = zed0 + m_roiZedWidth; // in mm
         double zed0m   = zed0 - m_roiZedWidth; // in mm
         
         if ( m_roiZedSinThetaFlag ) { 
           double cosheta = std::cosh( (*p4EL)->eta() );
           zed0p   = zed0 + m_roiZedWidth*cosheta; // in mm
           zed0m   = zed0 - m_roiZedWidth*cosheta; // in mm
         }
         
         ATH_MSG_DEBUG( "New ROI for xAOD::Particle ET="<< (*p4EL)->p4().Et()
                << " eta="<< (*p4EL)->eta() << " +- " << m_roiEtaWidth
                << " phi="<< (*p4EL)->phi() << " +- " << m_roiPhiWidth
                << " zed0="<<  zed0 << " +- " << m_roiZedWidth );
       
         newROI = new TrigRoiDescriptor( reta, retam, retap,
                         rphi, rphim, rphip,
                         zed0, zed0m, zed0p );
     }
     else {
       newROI = new TrigRoiDescriptor( reta, retam, retap,
                       rphi, rphim, rphip);
     }   
    }
    else {
      newROI = new TrigRoiDescriptor( reta, retam, retap,
                      rphi, rphim, rphip);
    }
    
    roisWriteHandle->push_back( newROI );
    
    const ElementLink<TrigRoiDescriptorCollection> roiEL = ElementLink<TrigRoiDescriptorCollection>(*roisWriteHandle, roisWriteHandle->size() - 1, ctx);
    
    outputDecision->setObjectLink(roiString(), roiEL);
  }
  
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode ViewCreatorCentredOnIParticleROITool::initialize ( )

overridevirtual

Definition at line 20 of file ViewCreatorCentredOnIParticleROITool.cxx.

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

Member Data Documentation

◆ m_iParticleLinkName

Gaudi::Property< std::string > ViewCreatorCentredOnIParticleROITool::m_iParticleLinkName

Initial value:

{this,"IParticleLinkName","feature",

"Name of linked IParticle object to centre the new ROI on. Normally the 'feature' from the previous Step."}

Definition at line 41 of file ViewCreatorCentredOnIParticleROITool.h.

41 {this,"IParticleLinkName","feature",

42 "Name of linked IParticle object to centre the new ROI on. Normally the 'feature' from the previous Step."};

◆ m_roiEtaWidth

Gaudi::Property< double > ViewCreatorCentredOnIParticleROITool::m_roiEtaWidth

Initial value:

{this,"RoIEtaWidth",0.1,

"Extent of the ROI in eta from its centre"}

Definition at line 44 of file ViewCreatorCentredOnIParticleROITool.h.

44 {this,"RoIEtaWidth",0.1,

45 "Extent of the ROI in eta from its centre"};

◆ m_roiPhiWidth

Gaudi::Property< double > ViewCreatorCentredOnIParticleROITool::m_roiPhiWidth

Initial value:

{this,"RoIPhiWidth",0.1,

"Extent of the ROI in phi from its centre"}

Definition at line 47 of file ViewCreatorCentredOnIParticleROITool.h.

47 {this,"RoIPhiWidth",0.1,

48 "Extent of the ROI in phi from its centre"};

◆ m_roisWriteHandleKey

SG::WriteHandleKey< TrigRoiDescriptorCollection > ViewCreatorCentredOnIParticleROITool::m_roisWriteHandleKey

Initial value:

{this,"RoisWriteHandleKey","",

"Name of the ROI collection produced by this tool."}

Definition at line 38 of file ViewCreatorCentredOnIParticleROITool.h.

38 {this,"RoisWriteHandleKey","",

39 "Name of the ROI collection produced by this tool."};

◆ m_roiZedSinThetaFlag

Gaudi::Property< double > ViewCreatorCentredOnIParticleROITool::m_roiZedSinThetaFlag

Initial value:

{this,"RoIZedSinThetaFlag", false,

"use a delta zed/sin\theta width rather than just a zed width"}

Definition at line 53 of file ViewCreatorCentredOnIParticleROITool.h.

53 {this,"RoIZedSinThetaFlag", false,

54 "use a delta zed/sin\theta width rather than just a zed width"};

◆ m_roiZedWidth

Gaudi::Property< double > ViewCreatorCentredOnIParticleROITool::m_roiZedWidth

Initial value:

{this,"RoIZedWidth",-999,

"Extent of the ROI in zed from its centre"}

Definition at line 50 of file ViewCreatorCentredOnIParticleROITool.h.

50 {this,"RoIZedWidth",-999,

51 "Extent of the ROI in zed from its centre"};

◆ m_useBeamspot

Gaudi::Property< bool > ViewCreatorCentredOnIParticleROITool::m_useBeamspot

Initial value:

{this,"UseBeamSpot", true,

"correct for the pointlessly adjusted average beamspot z"}

Definition at line 59 of file ViewCreatorCentredOnIParticleROITool.h.

59 {this,"UseBeamSpot", true,

60 "correct for the pointlessly adjusted average beamspot z"};

◆ m_useZedPosition

Gaudi::Property< bool > ViewCreatorCentredOnIParticleROITool::m_useZedPosition

Initial value:

{this,"UseZedPosition", true,

"use IParticle z position"}

Definition at line 56 of file ViewCreatorCentredOnIParticleROITool.h.

56 {this,"UseZedPosition", true,

57 "use IParticle z position"};

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ViewCreatorCentredOnIParticleROITool()

◆ ~ViewCreatorCentredOnIParticleROITool()

Member Function Documentation

◆ attachROILinks()

◆ initialize()

Member Data Documentation

◆ m_iParticleLinkName

◆ m_roiEtaWidth

◆ m_roiPhiWidth

◆ m_roisWriteHandleKey

◆ m_roiZedSinThetaFlag

◆ m_roiZedWidth

◆ m_useBeamspot

◆ m_useZedPosition