TupleToolGeometry Class Reference

Fill geometry related information for DecayTreeTuple. More...

#include <jborel/TupleToolGeometry.h>

Inheritance diagram for TupleToolGeometry:

Collaboration diagram for TupleToolGeometry:

Public Member Functions
	TupleToolGeometry (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...
StatusCode	initialize () override
StatusCode	fill (const LHCb::Particle *, const LHCb::Particle *, const std::string &, Tuples::Tuple &) override
	Fill the tuple. More...
Public Member Functions inherited from IParticleTupleTool
	DeclareInterfaceID (IParticleTupleTool, 2, 0)
Public Member Functions inherited from extend_interfaces< IAlgTool >
	~extend_interfaces () override=default
	Virtual destructor. More...

Private Member Functions
StatusCode	fillVertexFull (const LHCb::VertexBase *vtx, const LHCb::Particle *P, const std::string &head, const std::string &vtx_name, Tuples::Tuple &) const
	fill end vertex stuff More...
const LHCb::VertexBase *	originVertex (const LHCb::Particle *top, const LHCb::Particle *P) const
	origin vertex More...
StatusCode	fillBPV (const LHCb::VertexBase *primVtx, const LHCb::Particle *P, const std::string &prefix, Tuples::Tuple &tuple, const std::string &trail="") const
	fill related pV stuff More...
StatusCode	fillMinIP (const LHCb::Particle *P, const std::string &prefix, Tuples::Tuple &tuple) const
	fill min IP More...
StatusCode	fillVertex (const LHCb::VertexBase *vtx, const std::string &vtx_name, Tuples::Tuple &) const
	fill end vertex stuff More...
StatusCode	fillFlight (const LHCb::VertexBase *oriVtx, const LHCb::Particle *P, const std::string &prefix, Tuples::Tuple &tuple, const std::string &trail="") const
	fill flight More...
double	dira (const LHCb::VertexBase *oriVtx, const LHCb::Particle *P) const
	Compute DIRA. More...

Private Attributes
const IDistanceCalculator *	m_dist = nullptr
bool	m_refitPVs
bool	m_fillMultiPV
	fill multiPV variables More...
IDVAlgorithm *	m_dva = nullptr
IPVReFitter *	m_pvReFitter = nullptr
std::string	m_pvReFitterName

Additional Inherited Members
Public Types inherited from extend_interfaces< IAlgTool >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Detailed Description

Fill geometry related information for DecayTreeTuple.

• head_MINIP : minimum impact parameter on any PV
• head_MINIPCHI2 : minimum chi2 IP on all PVs
• head_ENDVERTEX_[X|Y|Z] : decay vertex position for composite particles
• head_ENDVERTEX_[X|Y|Z]ERR : decay vertex position error estimate for composite particles
• head_ENDVERTEX_CHI2 : decay vertex chi2
• head_ENDVERTEX_NDOF : decay vertex nDoF
• head_OWNPV_[X|Y|Z] : related primary vertex position
• head_OWNPV_[X|Y|Z]ERR : related primary vertex position error estimate for composite particles
• head_OWNPV_CHI2 : related primary vertex chi2
• head_OWNPV_NDOF : related primary vertex nDoF
• head_IP_OWNPV : impact parameter with respect to the PhysDesktop::relatedVertex() considered particle
• head_IPCHI2_OWNPV : impact parameter chi2 with respect to the relatedVertex() considered particle
• head_FD_OWNPV : flight distance of composite particle wrt. the relatedVertex() considered particle
• head_FDCHI2_OWNPV : flight distance significance in units of chi2 wrt. the relatedVertex() considered particle

• head_DIRA_OWNPV : direction angle wrt. the PhysDesktop::relatedVertex() considered particle

  If Verbose is true:

• head_TOPPV_[X|Y|Z] : PhysDesktop::relatedVertex() of the top of decay chain position
• head_TOPPV_[X|Y|Z]ERR : PhysDesktop::relatedVertex() of the top of decay chain position error estimate
• head_TOPPV_CHI2 : PhysDesktop::relatedVertex() of the top of decay chain chi2
• head_TOPPV_NDOF : PhysDesktop::relatedVertex() of the top of decay chain nDoF
• head_IP_TOPPV : impact parameter with respect to the PhysDesktop::relatedVertex() of the top of decay chain
• head_IPCHI2_TOPPV : impact parameter chi2 with respect to the relatedVertex() of the top of decay chain
• head_FD_TOPPV : flight distance of composite particle wrt. the relatedVertex() of the top of decay chain
• head_FDCHI2_TOPPV : flight distance significance in units of chi2 wrt. the PhysDesktop::relatedVertex() of the top of decay chain
• head_DIRA_TOPPV : direction angle wrt. the relatedVertex() of the top of decay chain
• head_ORIVX_[X|Y|Z] : ancestor's related primary vertex position (when applicable)
• head_ORIVX_[X|Y|Z]ERR : ancestor's related primary vertex position error estimate (when applicable)
• head_ORIVX_CHI2 : ancestor's related primary vertex chi2 (when applicable)
• head_ORIVX_NDOF : ancestor's related primary vertex nDoF (when applicable)
• head_IP_ORIVX : impact parameter with respect to the ancestor's vertex (when applicable)
• head_IPCHI2_ORIVX : impact parameter chi2 with respect to the ancestor's vertex (when applicable)
• head_FD_ORIVX : flight distance of composite particle wrt. the ancestor's vertex (when applicable)
• head_FDCHI2_ORIVX : flight distance significance in units of chi2 wrt. ancestor's vertex (when applicable)
• head_DIRA_ORIVX : direction angle wrt. ancestor's vertex (when applicable)

Finally some arrays with FillMultiPV

• head_AllIP : IP wrt to all PVs
• head_AllIPchi2 : IPchi2 wrt to all Vs
• head_AllDIRA : DIRA wrt to all PVs

See also

DecayTreeTuple

Author

Jeremie Borel

Date

2007-11-07

Definition at line 73 of file TupleToolGeometry.h.

Constructor & Destructor Documentation

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

Standard constructor.

Definition at line 32 of file TupleToolGeometry.cpp.

    : TupleToolBase ( type, name , parent )
{
  declareInterface<IParticleTupleTool>(this);
  declareProperty("RefitPVs",m_refitPVs=false,
                  "Refit PVs when doing next best PV checks");
  declareProperty("PVReFitter", m_pvReFitterName = "LoKi::PVReFitter:PUBLIC",
                  "PV refitter algorithm name (':PUBLIC' at end of algo name makes sure a public instance is used)" );
  declareProperty("FillMultiPV",m_fillMultiPV=false,
                  "Fill Multi PV arrays");

  //declareProperty("FillMother",m_fillMother=true,
  //                "Turn false if the mother is expected to be NULL, will not fill mother PV info");
  // replaced by Verbose

  //setProperty( "OutputLevel", 1 );

}

Member Function Documentation

double TupleToolGeometry::dira ( const LHCb::VertexBase *  oriVtx, const LHCb::Particle *  P  ) const

private

Compute DIRA.

Definition at line 486 of file TupleToolGeometry.cpp.

{
  if ( !P || !oriVtx )
  {
    Exception("Wrong use of dira");
    return -1501. ;
  }
  const auto evtx = P->endVertex();
  if ( !evtx ) 
  {
    Warning("Cannot find end vertex",StatusCode::SUCCESS,1).ignore();
    return -999.;
  }
  const auto A = P->momentum().Vect();
  const auto B = evtx->position() - oriVtx->position();
  return A.Dot( B ) / std::sqrt( A.Mag2()*B.Mag2() );
}

StatusCode TupleToolGeometry::fill ( const LHCb::Particle *  top, const LHCb::Particle *  part, const std::string &  head, Tuples::Tuple &  tuple  )

overridevirtual

Fill the tuple.

• top : may be used to provide additional information about part, like the top particle of the decay.
• part : the particle about which some info are filled.
• head : prefix for the tuple column name.
• tuple: the tuple to fill

Implements IParticleTupleTool.

Definition at line 79 of file TupleToolGeometry.cpp.

{
  const auto prefix = fullName(head);

  StatusCode sc = StatusCode::SUCCESS;

  Assert( P && m_dist && m_dva
          , "No mother or particle, or tools misconfigured." );

  if ( isPureNeutralCalo(P) )
    return Warning( "Will not fill geometry tuple for neutral Calo particles. No worry",
                    StatusCode::SUCCESS, 10);
  if ( msgLevel(MSG::VERBOSE) )
    verbose() << "TupleToolGeometry::fill " << mother << " " << P << " " << prefix
              << endmsg ;

  //fill min IP
  if ( isVerbose() || m_fillMultiPV )
  {
    sc = fillMinIP(P,prefix,tuple);
    if ( sc.isFailure() )
    {
      return Warning("Could not fill minimum IP",1,StatusCode::FAILURE);
    }
  }
  //=========================================================================
  //fill end vertex info
  //=========================================================================
  if( P->isBasicParticle() )
  {
    if (msgLevel(MSG::VERBOSE))
      verbose() << "No need to look for endVertex of " << prefix << endmsg ;
  } 
  else
  {
    //=========================================================================
    if ( msgLevel(MSG::VERBOSE) && P->endVertex() )
    { // https://savannah.cern.ch/bugs/?92524
      verbose() << "Before cast : " << P->endVertex() << endmsg ;
      verbose() << "Container " << P->endVertex()->parent()->registry()->identifier()
                << " key " << P->endVertex()->key() << endmsg ;
    }

    const auto evtx = P->endVertex();
    if ( !evtx )
    {
      fatal() << "Can't retrieve the end vertex for " << prefix 
              << ". TupleToolGeometry cannot act on such a particle. Define a branch" << endmsg ;
      fatal() << "See https://twiki.cern.ch/twiki/bin/view/LHCb/DaVinciTutorial7#Branches" << endmsg ;
      return StatusCode::FAILURE ;
    }
      
    if ( msgLevel(MSG::VERBOSE) )
    { // https://savannah.cern.ch/bugs/?92524
      verbose() << "End Vertex : " << *evtx << endmsg ;
      verbose() << "Container " << evtx->parent()->registry()->identifier()
                << " key " << evtx->key() << endmsg ;
    }
    // end vertex
    sc = fillVertex(evtx,prefix+"_ENDVERTEX",tuple);
    if ( sc.isFailure() )
    {
      return Warning("Could not fill Endvertex "+prefix,1,sc);
    }
  }

  const VertexBase* aPV = nullptr;

  //=========================================================================
  // fill IP for Particles's Own BPV.. if it isn't the mother!
  //=========================================================================
  if ( true )
  {
    aPV = m_dva->bestVertex ( P );
    if ( aPV && msgLevel(MSG::VERBOSE) )
      verbose() << "Got best PV of particle : " << *aPV  << endmsg  ;
    sc = fillVertexFull(aPV,P,prefix,"_OWNPV",tuple);
    if ( sc.isFailure() )
    {
      return Warning("Could not fill best PV",1,sc);
    }
  }
  //=========================================================================
  // fill IP for head of chain's own BPV
  //=========================================================================
  if ( mother && isVerbose() )
  {
    aPV = m_dva->bestVertex ( mother );
    if ( aPV && msgLevel(MSG::VERBOSE))
      verbose() << "Got best PV of mother : " << *aPV  << endmsg  ;
    sc = fillVertexFull(aPV,P,prefix,"_TOPPV",tuple);
    if ( sc.isFailure() )
    {
      return Warning("Could not fill TOP PV",1,sc);
    }
  }
  //=========================================================================
  // fill IP wrt Mother's decay vertex, if it isn't the mother!
  //=========================================================================
  if ( mother && mother != P)
  {
    aPV = originVertex( mother, P );
    if(aPV && msgLevel(MSG::VERBOSE))
      verbose() << "Got originVertex of mother : " << *aPV << endmsg  ;
    if ( isVerbose() )
    {
      sc = fillVertexFull(aPV,P,prefix,"_ORIVX",tuple);
      if ( sc.isFailure() )
      {
        return Warning("Could not fill VertexFull "+prefix,1,sc);
      }
    }
    else
    {
      sc = fillVertex(aPV,prefix+"_ORIVX",tuple);
      if ( sc.isFailure() )
      {
        return Warning("Could not fill ORIVX",1,sc);
      }
      if( !P->isBasicParticle() ) sc = fillFlight(aPV,P,prefix,tuple,"_ORIVX");
      if ( sc.isFailure() )
      {
        return Warning("Could not fill Flight",1,sc);
      }

    }

    if ( sc.isFailure() ) return sc;
  }
  //=========================================================================

  return sc ;
}

StatusCode TupleToolGeometry::fillBPV ( const LHCb::VertexBase *  primVtx, const LHCb::Particle *  P, const std::string &  prefix, Tuples::Tuple &  tuple, const std::string &  trail = ""  ) const

private

fill related pV stuff

Definition at line 247 of file TupleToolGeometry.cpp.

                                                                       {
  bool test = true ;

  double ip{-999}, chi2{-999};

  if ( !primVtx )
  {
    ++counter("No BPV for "+prefix);
  }
  else
  {
    test &= m_dist->distance ( P, primVtx, ip, chi2 );
    if ( !test ) { ip = chi2 = -1; }
  }

  test &= tuple->column( prefix + "_IP"+trail,       ip );
  test &= tuple->column( prefix + "_IPCHI2"+trail, chi2 );

  if (!test) Warning("Error in fillBPV "+prefix,1).ignore();
  return StatusCode(test) ;
}

StatusCode TupleToolGeometry::fillFlight ( const LHCb::VertexBase *  oriVtx, const LHCb::Particle *  P, const std::string &  prefix, Tuples::Tuple &  tuple, const std::string &  trail = ""  ) const

private

fill flight

Definition at line 413 of file TupleToolGeometry.cpp.

{
  bool test = true ;
  // --------------------------------------------------
  if ( !oriVtx )
  {
    test &= tuple->column( prefix + "_FD"+trail, -999. );
    test &= tuple->column( prefix + "_FDCHI2"+trail, -999. );
    test &= tuple->column( prefix + "_DIRA"+trail, -999.);
  }
  else
  {

    // flight distance
    double dist{0}, chi2{0};
    const StatusCode sc = m_dist->distance( oriVtx, P->endVertex(), dist, chi2 );

    // always fill variables to make sure branches do not change ...
    test &= tuple->column( prefix + "_FD"+trail,     sc ? dist : -999 );
    test &= tuple->column( prefix + "_FDCHI2"+trail, sc ? chi2 : -999 );
    // --------------------------------------------------
    // cosine of (flight distance) dot (momentum):
    // find the origin vertex. Either the primary or the origin in the
    // decay
    test &= tuple->column( prefix + "_DIRA"+trail, sc ? dira(oriVtx,P) : -999 );

    if ( sc.isFailure() ) return sc ;
  }

  if (!test) Warning("Error in fillFlight "+prefix,1).ignore();
  return StatusCode(test);
}

StatusCode TupleToolGeometry::fillMinIP ( const LHCb::Particle *  P, const std::string &  prefix, Tuples::Tuple &  tuple  ) const

private

fill min IP

Definition at line 275 of file TupleToolGeometry.cpp.

{
  bool test = true ;
  // minimum IP
  double ipmin = -1;
  double minchi2 = -1 ;

  double ipminnextbest = -1;
  double minchi2nextbest = -1;

  if(msgLevel(MSG::VERBOSE)) verbose() << "Looking for Min IP"  << endmsg  ;
  const auto PVS = m_dva->primaryVertices();
  if(msgLevel(MSG::VERBOSE)) verbose() << "PV size: "  << PVS.size() << endmsg  ;

  std::vector<double> ips, ipchi2s, diras;
  if ( !PVS.empty() )
  {
    if(msgLevel(MSG::VERBOSE)) verbose() << "Filling IP " << prefix + "_MINIP : "
                                         << P << " PVs:" << PVS.size() << endmsg ;

    for ( const auto& pv : PVS )
    {
      RecVertex newPV(*pv);
      if (m_refitPVs)
      {

        StatusCode scfit = m_pvReFitter->remove(P, &newPV);
        if(!scfit) { Warning("ReFitter fails!",StatusCode::SUCCESS,10).ignore(); continue; }
      }

      double ip{0}, chi2{0};
      //StatusCode test2 = m_dist->distance ( P, *pv, ip, chi2 );

      auto newPVPtr = (LHCb::VertexBase*)&newPV;
      const auto test2 = m_dist->distance ( P, newPVPtr, ip, chi2 );
      ips.push_back(ip);
      ipchi2s.push_back(chi2);
      if ( P->endVertex()) { diras.push_back(dira(newPVPtr,P)); }
      if ( test2 && isVerbose() )
      {
        if ( ip<ipmin || ipmin<0. )
        {
          ipminnextbest = ipmin;
          ipmin = ip ;
        }
        else
        {
          if( ip < ipminnextbest || ipminnextbest < 0 )
          {
            ipminnextbest = ip;
          }
        }

        if ( chi2<minchi2 || minchi2<0. )
        {
          minchi2nextbest = minchi2;
          minchi2 = chi2 ;
        }
        else
        {
          if( chi2 < minchi2nextbest || minchi2nextbest < 0 )
          {
            minchi2nextbest = chi2;
          }
        }
      }
    }
  }
  if ( isVerbose() )
  {
    if ( msgLevel(MSG::VERBOSE) )
    {
      verbose() << "Filling IP " << prefix + "_MINIP " << ipmin << " at " << minchi2 << endmsg  ;
      verbose() << "Filling IP next best " << prefix + "_MINIP " << ipminnextbest << " at "
                << minchi2nextbest << endmsg  ;
    }
    test &= tuple->column( prefix + "_MINIP", ipmin );
    test &= tuple->column( prefix + "_MINIPCHI2", minchi2 );
    
    test &= tuple->column( prefix + "_MINIPNEXTBEST", ipminnextbest );
    test &= tuple->column( prefix + "_MINIPCHI2NEXTBEST", minchi2nextbest );
  }
  if (m_fillMultiPV)
  {
    test &= tuple->farray( prefix + "_AllIP", ips, "nPV", m_maxPV );
    test &= tuple->farray( prefix + "_AllIPchi2", ipchi2s, "nPV", m_maxPV );
    if (!diras.empty()) test &= tuple->farray( prefix + "_AllDIRA", diras, "nPV", m_maxPV );
    // --------------------------------------------------
  }
  
  if(msgLevel(MSG::VERBOSE))
    verbose() << "Return from fillMinIP: " << prefix  << " " << test << endmsg;
  if (!test)  Warning("Error in fillMinIP",1,StatusCode::FAILURE);
  return StatusCode(test) ;
}

StatusCode TupleToolGeometry::fillVertex ( const LHCb::VertexBase *  vtx, const std::string &  vtx_name, Tuples::Tuple &  tuple  ) const

private

fill end vertex stuff

Definition at line 375 of file TupleToolGeometry.cpp.

{
  bool test = true ;

  // decay vertex information:
  if ( !vtx )
  {
    Gaudi::XYZPoint pt(-999.,-999.,-999.) ; // arbitrary point
    test &= tuple->column( vtx_name+"_", pt );
    test &= tuple->column( vtx_name + "_XERR", -999. );
    test &= tuple->column( vtx_name + "_YERR", -999. );
    test &= tuple->column( vtx_name + "_ZERR", -999. );
    test &= tuple->column( vtx_name + "_CHI2", -999. );
    test &= tuple->column( vtx_name + "_NDOF", -1 );
    test &= tuple->matrix( vtx_name + "_COV_", Gaudi::SymMatrix3x3()  );
  }
  else
  {
    const auto & m = vtx->covMatrix ();
    test &= tuple->column( vtx_name+"_", vtx->position() );
    test &= tuple->column( vtx_name + "_XERR", std::sqrt( m(0,0) ) );
    test &= tuple->column( vtx_name + "_YERR", std::sqrt( m(1,1) ) );
    test &= tuple->column( vtx_name + "_ZERR", std::sqrt( m(2,2) ) );
    test &= tuple->column( vtx_name + "_CHI2", vtx->chi2() );
    test &= tuple->column( vtx_name + "_NDOF", vtx->nDoF() );
    test &= tuple->matrix( vtx_name + "_COV_", m );
  }

  // --------------------------------------------------
  if (!test) Warning("Error in fillVertex "+vtx_name,1).ignore();
  return StatusCode(test) ;

}

StatusCode TupleToolGeometry::fillVertexFull ( const LHCb::VertexBase *  vtx, const LHCb::Particle *  P, const std::string &  head, const std::string &  vtx_name, Tuples::Tuple &  tuple  ) const

private

fill end vertex stuff

Definition at line 219 of file TupleToolGeometry.cpp.

{
  if ( !vtx ) ++counter("Can't retrieve the " +vtx_name+ " vertex for " + prefix );
  auto sc = fillVertex(vtx,prefix+vtx_name,tuple);
  if ( sc.isFailure() )
  {
    return Warning("Could not fill Endvertex "+prefix,1,sc);
  }
  sc = fillBPV(vtx,P,prefix,tuple,vtx_name);
  if ( sc.isFailure() )
  {
    return Warning("Could not fillBPV "+prefix,1,sc);
  }
  if( !P->isBasicParticle() ) 
  {
    sc = fillFlight(vtx,P,prefix,tuple,vtx_name);
    if ( sc.isFailure() ) Warning("Error in fillFlight "+prefix,1).ignore();
  }
  return sc;
}

StatusCode TupleToolGeometry::initialize ( void  )

override

Definition at line 55 of file TupleToolGeometry.cpp.

{
  const StatusCode sc = TupleToolBase::initialize();
  if ( sc.isFailure() ) return sc;

  m_dva = Gaudi::Utils::getIDVAlgorithm ( contextSvc(), this ) ;
  if (!m_dva) return Error("Couldn't get parent DVAlgorithm");

  m_dist = m_dva->distanceCalculator();
  if ( !m_dist )
  {
    return Error("Unable to retrieve the IDistanceCalculator tool");
  }

  m_pvReFitter = tool<IPVReFitter>( m_pvReFitterName, this );
  if ( !m_pvReFitter )
  {
    return Error( "Unable to retrieve IPVReFitter instance" );
  }

  return sc;
}

const VertexBase * TupleToolGeometry::originVertex ( const LHCb::Particle *  top, const LHCb::Particle *  P  ) const

private

origin vertex

Definition at line 452 of file TupleToolGeometry.cpp.

{
  //this used to pass back zero if P was a basic particle.
  //I don't think that's necessary. R Lambert 2009-08-14
  if ( top == P || top->isBasicParticle() ) return nullptr;

  const auto & dau = top->daughters();
  if ( dau.empty() ) return nullptr;

  for ( const auto d : dau )
  {
    if( P == d )
    { // I found the daughter
      if(msgLevel(MSG::VERBOSE))
        verbose() << "It's a daughter, retrning mother's endvertex : "
                  << endmsg;
      return top->endVertex();
    }
  }

  // vertex not yet found, get deeper in the decay:
  for ( const auto d : dau )
  {
    if ( P != d && !d->isBasicParticle() )
    {
      const auto vv = originVertex( d, P );
      if ( msgLevel(MSG::VERBOSE) ) verbose() << "Went up : " << vv  << endmsg  ;
      if ( vv ) return vv;
    }
  }
  return nullptr;
}

Member Data Documentation

const IDistanceCalculator* TupleToolGeometry::m_dist = nullptr

private

Definition at line 132 of file TupleToolGeometry.h.

IDVAlgorithm* TupleToolGeometry::m_dva = nullptr

private

Definition at line 139 of file TupleToolGeometry.h.

bool TupleToolGeometry::m_fillMultiPV

private

fill multiPV variables

Definition at line 135 of file TupleToolGeometry.h.

IPVReFitter* TupleToolGeometry::m_pvReFitter = nullptr

private

Definition at line 141 of file TupleToolGeometry.h.

std::string TupleToolGeometry::m_pvReFitterName

private

Definition at line 142 of file TupleToolGeometry.h.

bool TupleToolGeometry::m_refitPVs

private

Definition at line 134 of file TupleToolGeometry.h.

---

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

• ANALYSIS_v20r5/Phys/DecayTreeTuple/src/TupleToolGeometry.h
• ANALYSIS_v20r5/Phys/DecayTreeTuple/src/TupleToolGeometry.cpp