This is a general purpose class for collecting reconstructed MDST data objects that are not used in reconstruction of given Particle – referred also as Rest Of the Event. More...

#include <RestOfEvent.h>

Inheritance diagram for RestOfEvent:

[legend]

Collaboration diagram for RestOfEvent:

[legend]

Classes
struct	Mask
	Structure of Rest of Event mask. More...

Public Member Functions
	RestOfEvent (int pdgCode=0, bool isNested=false, bool isFromMC=false, bool useKLMEnergy=false, bool builtWithMostLikely=false)
	Default constructor.

void	addParticles (const std::vector< const Particle * > &particle)
	Add StoreArray indices of given Particles to the list of unused particles in the event.

void	setPDGCode (int pdgCode)
	Sets the PDG code of the rest of event.

Particle *	convertToParticle (const std::string &maskName=c_defaultMaskName, int pdgCode=0, bool isSelfConjugated=true)
	Converts ROE to Particle and adds it to StoreArray.

int	getPDGCode () const
	Gets the PDG code of the rest of event.

bool	hasParticle (const Particle *particle, const std::string &maskName=c_defaultMaskName) const
	Check if ROE has StoreArray index of given to the list of unused tracks in the event.

void	initializeMask (const std::string &name, const std::string &origin="unknown")
	Initialize new mask.

void	updateMaskWithCuts (const std::string &name, const std::shared_ptr< Variable::Cut > &trackCut=nullptr, const std::shared_ptr< Variable::Cut > &eclCut=nullptr, const std::shared_ptr< Variable::Cut > &klmCut=nullptr, bool updateExisting=false)
	Update mask with cuts.

void	excludeParticlesFromMask (const std::string &maskName, const std::vector< const Particle * > &particles, Particle::EParticleSourceObject listType, bool discard)
	Update mask by keeping or excluding particles.

bool	hasMask (const std::string &name) const
	True if this ROE object has mask.

void	updateMaskWithV0 (const std::string &name, const Particle *particleV0)
	Update mask with composite particle.

bool	checkCompatibilityOfMaskAndV0 (const std::string &name, const Particle *particleV0)
	Check if V0 can be added, maybe should be moved to private.

bool	getIsNested () const
	Returns true if the ROE is nested.

bool	isBuiltWithMostLikely () const
	Returns true if the ROE was built with most-likely particle lists.

std::vector< const Particle * >	getParticles (const std::string &maskName=c_defaultMaskName, bool unpackComposite=true) const
	Get all Particles from ROE mask.

std::vector< const Particle * >	getPhotons (const std::string &maskName=c_defaultMaskName, bool unpackComposite=true) const
	Get photons from ROE mask.

std::vector< const Particle * >	getHadrons (const std::string &maskName=c_defaultMaskName, bool unpackComposite=true) const
	Get hadrons from ROE mask.

std::vector< const Particle * >	getChargedParticles (const std::string &maskName=c_defaultMaskName, unsigned int pdg=0, bool unpackComposite=true) const
	Get charged particles from ROE mask.

ROOT::Math::PxPyPzEVector	get4Vector (const std::string &maskName=c_defaultMaskName) const
	Get 4-momentum vector all (no mask) or a subset (use mask) of all Tracks and ECLClusters in ROE.

ROOT::Math::PxPyPzEVector	get4VectorNeutralECLClusters (const std::string &maskName=c_defaultMaskName) const
	Get 4-momentum vector all (no mask) or a subset (use mask) of all ECLClusters in ROE.

int	getNTracks (const std::string &maskName=c_defaultMaskName) const
	Get number of all (no mask) or a subset (use mask) of all Tracks in ROE.

int	getNECLClusters (const std::string &maskName=c_defaultMaskName) const
	Get number of all (no mask) or a subset (use mask) of all ECLclusters in ROE.

int	getNKLMClusters (const std::string &maskName=c_defaultMaskName) const
	Get number of all remaining KLM clusters.

std::vector< std::string >	getMaskNames () const
	Get vector of all mask names of the ROE object.

void	print (const std::string &maskName=c_defaultMaskName, bool unpackComposite=true) const
	Prints the contents of a RestOfEvent object to screen.

void	addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (with caching).

void	addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
	Add a relation from this object to another object (no caching, can be quite slow).

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

template<class TO >
RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.

template<class FROM >
RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.

template<class T >
RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation.

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation.

template<class T >
T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.

template<class TO >
std::pair< TO *, float >	getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing to an array.

template<class FROM >
std::pair< FROM *, float >	getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from an array.

template<class T >
std::pair< T *, float >	getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
	Get first related object & weight of relation pointing from/to an array.

virtual std::string	getName () const
	Return a short name that describes this object, e.g.

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format.

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format.

std::string	getArrayName () const
	Get name of array this object is stored in, or "" if not found.

int	getArrayIndex () const
	Returns this object's array index (in StoreArray), or -1 if not found.

Static Public Attributes
static constexpr const char *	c_defaultMaskName = "all"
	Default mask name.

Protected Member Functions
TClonesArray *	getArrayPointer () const
	Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Private Member Functions
bool	isInParticleList (const Particle roeParticle, const std::vector< const Particle > &particlesToUpdate) const
	Checks if a particle has its copy in the provided list.

Mask *	findMask (const std::string &name)
	Helper method to find ROE mask.

void	printIndices (const std::string &maskName=c_defaultMaskName, bool unpackComposite=true, const std::string &tab=" - ") const
	Prints indices in the given set in a single line.

	ClassDef (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

Private Attributes
std::set< int >	m_particleIndices
	StoreArray indices to unused particles.

std::vector< Mask >	m_masks
	List of the ROE masks.

int	m_pdgCode
	PDG code of the 'ROE particle' if we are going to create one.

bool	m_isNested
	Nested ROE indicator.

bool	m_isFromMC
	MC ROE indicator.

bool	m_useKLMEnergy
	Include KLM energy into ROE 4-vector.

bool	m_builtWithMostLikely
	indicates whether most-likely particle lists were used in build of ROE

DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

int	m_cacheArrayIndex
	Cache of the index in the TClonesArray to which this object belongs.

Detailed Description

This is a general purpose class for collecting reconstructed MDST data objects that are not used in reconstruction of given Particle – referred also as Rest Of the Event.

From remaining photons, K_L0 and charged particles, etc., we infer for example the decay vertex and flavor of the tagging B meson, which are needed in measurements of t-dependent CP violation, or we determine whether or not the rest of the event is consistent with some B decay that involves neutrinos after we have reconstructed Btag hadronically or semileptonically. Remaining charged tracks and unused energy deposits are for example also needed in calculation of continuum suppression variables, like Kakuno-Super-Fox-Wolfram moments. The RestOfEvent class should be used as an input in all these cases.

The RestOfEvent object is created for given existing Particle object by the RestOfEventBuilder module and are related between each other with the basf2 relation.

Internally, the RestOfEvent class holds only StoreArray indices of all unused MDST particles. Indices are stored in std::set and not std::vector, since the former ensures uniqueness of all its elements.

Definition at line 57 of file RestOfEvent.h.

Constructor & Destructor Documentation

◆ RestOfEvent()

RestOfEvent	(	int	pdgCode = `0`,
		bool	isNested = `false`,
		bool	isFromMC = `false`,
		bool	useKLMEnergy = `false`,
		bool	builtWithMostLikely = `false`
	)

inlineexplicit

Default constructor.

All private members are set to 0 (all vectors are empty).

Definition at line 179 of file RestOfEvent.h.

                                                          :
      m_pdgCode(pdgCode), m_isNested(isNested), m_isFromMC(isFromMC), m_useKLMEnergy(useKLMEnergy),
      m_builtWithMostLikely(builtWithMostLikely) { };

Member Function Documentation

◆ addParticles()

void addParticles ( const std::vector< const Particle * > & particle )

Add StoreArray indices of given Particles to the list of unused particles in the event.

Parameters

particle Reference to a vector of unused Particles

Definition at line 24 of file RestOfEvent.cc.

{
  StoreArray<Particle> allParticles;
  for (auto* particleToAdd : particlesToAdd) {
    std::vector<const Particle*> daughters = particleToAdd->getFinalStateDaughters();
    for (auto* daughter : daughters) {
      bool toAdd = true;
      for (auto& myIndex : m_particleIndices) {
        if (allParticles[myIndex]->isCopyOf(daughter, true)) {
          toAdd = false;
          break;
        }
      }
      if (toAdd) {
        B2DEBUG(10, "\t\tAdding particle with PDG " << daughter->getPDGCode());
        m_particleIndices.insert(daughter->getArrayIndex());
      }
    }
  }
}

◆ addRelationTo() [1/2]

void addRelationTo	(	const RelationsInterface< BASE > *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (with caching).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

◆ addRelationTo() [2/2]

void addRelationTo	(	const TObject *	object,
		float	weight = `1.0`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

    {
      StoreEntry* toEntry = nullptr;
      int toIndex = -1;
      DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
    }

◆ checkCompatibilityOfMaskAndV0()

bool checkCompatibilityOfMaskAndV0	(	const std::string &	name,
		const Particle *	particleV0
	)

Check if V0 can be added, maybe should be moved to private.

Definition at line 268 of file RestOfEvent.cc.

{
  if (name == RestOfEvent::c_defaultMaskName) {
    B2FATAL("ROE Mask name '" << RestOfEvent::c_defaultMaskName << "' is reserved for no mask case! " <<
            "Please check your inputs.");
  }
  Mask* mask = findMask(name);
  if (!mask) {
    B2FATAL("ROE Mask '" << name << "' does not exist!");
  }
  if (!mask->isValid()) {
    return false; //We should have particles here!
  }
  if (particleV0->getParticleSource() != Particle::EParticleSourceObject::c_Composite and
      particleV0->getParticleSource() != Particle::EParticleSourceObject::c_V0) {
    return false;
  }
  std::vector<const Particle*> daughtersV0 =  particleV0->getFinalStateDaughters();
  for (auto* daughter : daughtersV0) {
    if (daughter->getParticleSource() != Particle::EParticleSourceObject::c_Track) {
      return false; // Non tracks are not supported yet
    }
  }
  if (mask->hasV0(particleV0)) {
    return false; // We are not going to add another one
  }
  return true;
}

◆ convertToParticle()

Particle * convertToParticle	(	const std::string &	maskName = `c_defaultMaskName`,
		int	pdgCode = `0`,
		bool	isSelfConjugated = `true`
	)

Converts ROE to Particle and adds it to StoreArray.

Parameters

maskName	Name of the ROE mask to use for 4-vector and daughters
pdgCode	PDG code
isSelfConjugated	is the particle self-conjugated

Definition at line 443 of file RestOfEvent.cc.

{
  StoreArray<Particle> particles;
  std::set<int> source;
  if (maskName == RestOfEvent::c_defaultMaskName) {
    // if no mask provided work with internal source
    source = m_particleIndices;
  } else {
    bool maskFound = false;
    for (auto& mask : m_masks) {
      if (mask.getName() == maskName) {
        maskFound = true;
        source = mask.getParticles();
        break;
      }
    }
    if (!maskFound) {
      B2FATAL("No '" << maskName << "' mask defined in current ROE!");
    }
  }
  int particlePDG = (pdgCode == 0) ? getPDGCode() : pdgCode;
  auto isFlavored = (isSelfConjugated) ? Particle::EFlavorType::c_Unflavored : Particle::EFlavorType::c_Flavored;
  // By default, the ROE-based particles should have unspecified property to simplify the MC-matching
  int propertyFlags = Particle::PropertyFlags::c_IsUnspecified;
  // Same properties as for "->" usage in DecayDescriptor
  propertyFlags |= Particle::PropertyFlags::c_IsIgnoreIntermediate;
  propertyFlags |= Particle::PropertyFlags::c_IsIgnoreRadiatedPhotons;
  return particles.appendNew(get4Vector(maskName), particlePDG, isFlavored, std::vector(source.begin(),
                             source.end()), propertyFlags);
}

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > * sourceObj )

inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

◆ excludeParticlesFromMask()

void excludeParticlesFromMask	(	const std::string &	maskName,
		const std::vector< const Particle * > &	particles,
		Particle::EParticleSourceObject	listType,
		bool	discard
	)

Update mask by keeping or excluding particles.

Parameters

maskName	Name of the mask to work with
particles	Reference to particle collection
listType	ParticleSourceObject of the collection
discard	Update the ROE mask by passing or discarding particles in the provided particle list

Definition at line 154 of file RestOfEvent.cc.

{
  if (maskName == RestOfEvent::c_defaultMaskName) {
    B2FATAL("ROE Mask name '" << RestOfEvent::c_defaultMaskName << "' is reserved for no mask case! " <<
            "Please check your inputs.");
  }
  Mask* mask = findMask(maskName);
  if (!mask) {
    B2FATAL("No '" << maskName << "' mask defined in current ROE!");
  }
  std::string maskNameToGetParticles = maskName;
  if (!mask->isValid()) {
    maskNameToGetParticles = RestOfEvent::c_defaultMaskName;
  }
  std::vector<const Particle*> allROEParticles =  getParticles(maskNameToGetParticles);
  std::vector<const Particle*> toKeepinROE;
  for (auto* roeParticle : allROEParticles) {
    if (isInParticleList(roeParticle, particlesToUpdate)) {
      if (!discard) {
        // If keep particles option is on, take the equal particles
        toKeepinROE.push_back(roeParticle);
      }
    } else {
      // Keep all particles which has different type than provided list
      if (listType != roeParticle->getParticleSource()) {
        toKeepinROE.push_back(roeParticle);
      } else if (discard) {
        // If keep particles option is off, take not equal particles
        toKeepinROE.push_back(roeParticle);
      }
    }
  }
  mask->clearParticles();
  mask->addParticles(toKeepinROE);
}

◆ findMask()

RestOfEvent::Mask * findMask ( const std::string & name )

private

Helper method to find ROE mask.

Definition at line 322 of file RestOfEvent.cc.

{
  for (auto& mask : m_masks) {
    if (mask.getName() == name) {
      return &mask;
    }
  }
  return nullptr;
 
}

◆ get4Vector()

ROOT::Math::PxPyPzEVector get4Vector ( const std::string & maskName = c_defaultMaskName ) const

Get 4-momentum vector all (no mask) or a subset (use mask) of all Tracks and ECLClusters in ROE.

Parameters

maskName Name of mask

Returns: 4-momentum of unused Tracks and ECLClusters in ROE

Definition at line 306 of file RestOfEvent.cc.

{
  ROOT::Math::PxPyPzEVector roe4Vector;
  std::vector<const Particle*> myParticles = RestOfEvent::getParticles(maskName);
  for (const Particle* particle : myParticles) {
    // KLMClusters are discarded, because KLM energy estimation is based on hit numbers, therefore it is unreliable
    // also, enable it as an experimental option:
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_KLMCluster and !m_useKLMEnergy) {
      continue;
    }
    roe4Vector += particle->get4Vector();
  }
  return roe4Vector;
}

◆ get4VectorNeutralECLClusters()

ROOT::Math::PxPyPzEVector get4VectorNeutralECLClusters ( const std::string & maskName = c_defaultMaskName ) const

Get 4-momentum vector all (no mask) or a subset (use mask) of all ECLClusters in ROE.

Parameters

maskName Name of mask

Returns: 4-momentum of unused Tracks and ECLClusters in ROE

Definition at line 356 of file RestOfEvent.cc.

{
  auto roeClusters = getPhotons(maskName);
  ROOT::Math::PxPyPzEVector roe4VectorECLClusters;
 
  // Add all momenta from neutral ECLClusters which have the nPhotons hypothesis
  for (auto& roeCluster : roeClusters) {
    if (roeCluster->getECLClusterEHypothesisBit() == ECLCluster::EHypothesisBit::c_nPhotons)
      roe4VectorECLClusters += roeCluster->get4Vector();
  }
 
  return roe4VectorECLClusters;
}

◆ getArrayIndex()

int getArrayIndex ( ) const

inlineinherited

Returns this object's array index (in StoreArray), or -1 if not found.

Definition at line 385 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

◆ getArrayName()

std::string getArrayName ( ) const

inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

◆ getArrayPointer()

TClonesArray * getArrayPointer ( ) const

inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

◆ getChargedParticles()

std::vector< const Particle * > getChargedParticles	(	const std::string &	maskName = `c_defaultMaskName`,
		unsigned int	pdg = `0`,
		bool	unpackComposite = `true`
	)		const

Get charged particles from ROE mask.

Parameters

maskName	Name of mask
pdg	absolute value of PDG code of charged particle
unpackComposite	return daughters of composite particles

Returns: vector of pointers to ROE Particles

Definition at line 108 of file RestOfEvent.cc.

{
  auto particles = getParticles(maskName, unpackComposite);
  std::vector<const Particle*> charged;
  for (auto* particle : particles) {
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_Track) {
      if (pdg == 0 || pdg == abs(particle->getPDGCode())) {
        charged.push_back(particle);
      }
    }
  }
  return charged;
}

◆ getHadrons()

std::vector< const Particle * > getHadrons	(	const std::string &	maskName = `c_defaultMaskName`,
		bool	unpackComposite = `true`
	)		const

Get hadrons from ROE mask.

Parameters

maskName	Name of mask
unpackComposite	return daughters of composite particles

Returns: vector of pointers to ROE Particles

Definition at line 96 of file RestOfEvent.cc.

{
  auto particles = getParticles(maskName, unpackComposite);
  std::vector<const Particle*> hadrons;
  for (auto* particle : particles) {
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_KLMCluster) {
      hadrons.push_back(particle);
    }
  }
  return hadrons;
}

◆ getInfo()

std::string getInfo ( ) const

inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note: : You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const

inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();

See also: Particle::getInfoHTML() for a more complex example.; HTML for some utility functions.; Use getInfo() to get a raw text version of this output.

Reimplemented in Particle, Cluster, MCParticle, PIDLikelihood, SoftwareTriggerResult, Track, TrackFitResult, and TRGSummary.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getIsNested()

bool getIsNested ( ) const

inline

Returns true if the ROE is nested.

Definition at line 266 of file RestOfEvent.h.

266{return m_isNested;}

◆ getMaskNames()

std::vector< std::string > getMaskNames ( ) const

Get vector of all mask names of the ROE object.

Returns: list of all mask names

Definition at line 380 of file RestOfEvent.cc.

{
  std::vector<std::string> maskNames;
 
  for (auto& mask : m_masks) {
    maskNames.push_back(mask.getName());
  }
 
  return maskNames;
}

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in Particle, and MCParticle.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getNECLClusters()

int getNECLClusters ( const std::string & maskName = c_defaultMaskName ) const

Get number of all (no mask) or a subset (use mask) of all ECLclusters in ROE.

Parameters

maskName Name of mask

Returns: number of all remaining ECL clusters

Definition at line 339 of file RestOfEvent.cc.

{
  int nROEneutralECLClusters = getPhotons(maskName).size();
  int nROEchargedECLClusters = 0;
  for (auto& roeParticle : getChargedParticles(maskName)) {
    if (roeParticle->getECLCluster()) ++nROEchargedECLClusters;
  }
 
  return nROEneutralECLClusters + nROEchargedECLClusters;
}

◆ getNKLMClusters()

int getNKLMClusters ( const std::string & maskName = c_defaultMaskName ) const

Get number of all remaining KLM clusters.

Parameters

maskName Name of mask

Returns: number of all remaining KLM clusters

Definition at line 350 of file RestOfEvent.cc.

{
  int nROEKLMClusters = getHadrons(maskName).size();
  return nROEKLMClusters;
}

◆ getNTracks()

int getNTracks ( const std::string & maskName = c_defaultMaskName ) const

Get number of all (no mask) or a subset (use mask) of all Tracks in ROE.

Parameters

maskName Name of mask

Returns: number of all remaining tracks

Definition at line 333 of file RestOfEvent.cc.

{
  int nTracks = getChargedParticles(maskName).size();
  return nTracks;
}

◆ getParticles()

std::vector< const Particle * > getParticles	(	const std::string &	maskName = `c_defaultMaskName`,
		bool	unpackComposite = `true`
	)		const

Get all Particles from ROE mask.

Parameters

maskName	Name of mask
unpackComposite	return daughters of composite particles

Returns: vector of pointers to ROE Particles

Definition at line 45 of file RestOfEvent.cc.

{
  std::vector<const Particle*> result;
  StoreArray<Particle> allParticles;
  std::set<int> source;
  if (m_particleIndices.size() == 0) {
    B2DEBUG(10, "ROE contains no particles, masks are empty too");
    return result;
  }
  if (maskName == RestOfEvent::c_defaultMaskName or maskName.empty()) {
    // if no mask provided work with internal source
    source = m_particleIndices;
  } else {
    bool maskFound = false;
    for (auto& mask : m_masks) {
      if (mask.getName() == maskName) {
        maskFound = true;
        source = mask.getParticles();
        break;
      }
    }
    if (!maskFound) {
      B2FATAL("No '" << maskName << "' mask defined in current ROE!");
    }
  }
  for (const int index : source) {
    if ((allParticles[index]->getParticleSource() == Particle::EParticleSourceObject::c_Composite or
         allParticles[index]->getParticleSource() == Particle::EParticleSourceObject::c_V0) && unpackComposite) {
      auto fsdaughters = allParticles[index]->getFinalStateDaughters();
      for (auto* daughter : fsdaughters) {
        result.push_back(daughter);
      }
      continue;
    }
    result.push_back(allParticles[index]);
  }
  return result;
}

◆ getPDGCode()

int getPDGCode ( ) const

inline

Gets the PDG code of the rest of event.

Definition at line 211 of file RestOfEvent.h.

    {
      return m_pdgCode;
    }

◆ getPhotons()

std::vector< const Particle * > getPhotons	(	const std::string &	maskName = `c_defaultMaskName`,
		bool	unpackComposite = `true`
	)		const

Get photons from ROE mask.

Parameters

maskName	Name of mask
unpackComposite	return daughters of composite particles

Returns: vector of pointers to unused Particles

Definition at line 84 of file RestOfEvent.cc.

{
  auto particles = getParticles(maskName, unpackComposite);
  std::vector<const Particle*> photons;
  for (auto* particle : particles) {
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_ECLCluster) {
      photons.push_back(particle);
    }
  }
  return photons;
}

◆ getRelated()

T * getRelated	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to or from which this object has a relation.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

◆ getRelatedFrom()

FROM * getRelatedFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object from which this object has a relation.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

◆ getRelatedFromWithWeight()

std::pair< FROM *, float > getRelatedFromWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters

FROM	The class of objects from which the relation points.

Parameters

name	The name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

◆ getRelatedTo()

TO * getRelatedTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the object to which this object has a relation.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

◆ getRelatedToWithWeight()

std::pair< TO *, float > getRelatedToWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters

TO	The class of objects to which the relation points.

Parameters

name	The name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

◆ getRelatedWithWeight()

std::pair< T *, float > getRelatedWithWeight	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters

T	The class of objects to or from which the relation points.

Parameters

name	The name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

◆ getRelationsFrom()

RelationVector< FROM > getRelationsFrom	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from another store array to this object.

Template Parameters

FROM	The class of objects from which the relations point.

Parameters

name	The name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

◆ getRelationsTo()

RelationVector< TO > getRelationsTo	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations that point from this object to another store array.

Template Parameters

TO	The class of objects to which the relations point.

Parameters

name	The name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

◆ getRelationsWith()

RelationVector< T > getRelationsWith	(	const std::string &	name = `""`,
		const std::string &	namedRelation = `""`
	)		const

inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters

T	The class of objects to or from which the relations point.

Parameters

name	The name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

◆ hasMask()

bool hasMask ( const std::string & name ) const

True if this ROE object has mask.

Parameters

name	Name of the mask to work with

Definition at line 297 of file RestOfEvent.cc.

{
  for (auto& mask : m_masks) {
    if (mask.getName() == name) {
      return true;
    }
  }
  return false;
}

◆ hasParticle()

bool hasParticle	(	const Particle *	particle,
		const std::string &	maskName = `c_defaultMaskName`
	)		const

Check if ROE has StoreArray index of given to the list of unused tracks in the event.

Parameters

particle	Pointer to the Particle
maskName	Name of the mask to work with

Definition at line 124 of file RestOfEvent.cc.

{
  if (maskName != RestOfEvent::c_defaultMaskName && !hasMask(maskName) && !maskName.empty()) {
    B2FATAL("No '" << maskName << "' mask defined in current ROE!");
  }
 
  std::vector<const Particle*> particlesROE = getParticles(maskName);
  return isInParticleList(particle, particlesROE);
}

◆ initializeMask()

void initializeMask	(	const std::string &	name,
		const std::string &	origin = `"unknown"`
	)

Initialize new mask.

Parameters

name	Name of the mask to work with
origin	origin of the creator module

Definition at line 134 of file RestOfEvent.cc.

{
  if (name == "") {
    B2FATAL("Creation of ROE Mask with an empty name is not allowed!");
  }
  if (name == RestOfEvent::c_defaultMaskName) {
    B2FATAL("Creation of ROE Mask with a name " << RestOfEvent::c_defaultMaskName << " is not allowed!");
  }
  std::regex word_regex("^[a-zA-Z][a-zA-Z0-9_]*$");
  if (!std::regex_match(name, word_regex)) {
    B2FATAL("Mask name '" << name << "' contains forbidden characters or it does not start with a letter. "
            "Only alphanumeric and underscore characters are allowed in ROE mask names.");
  }
  if (findMask(name)) {
    B2FATAL("ROE Mask '" << name << "' already exists!");
  }
  Mask elon(name, origin);
  m_masks.push_back(elon);
}

◆ isBuiltWithMostLikely()

bool isBuiltWithMostLikely ( ) const

inline

Returns true if the ROE was built with most-likely particle lists.

Definition at line 271 of file RestOfEvent.h.

271{return m_builtWithMostLikely;}

◆ isInParticleList()

bool isInParticleList	(	const Particle *	roeParticle,
		const std::vector< const Particle * > &	particlesToUpdate
	)		const

private

Checks if a particle has its copy in the provided list.

Definition at line 370 of file RestOfEvent.cc.

{
  for (auto* listParticle : particlesToUpdate) {
    if (roeParticle->isCopyOf(listParticle, true)) {
      return true;
    }
  }
  return false;
}

◆ print()

void print	(	const std::string &	maskName = `c_defaultMaskName`,
		bool	unpackComposite = `true`
	)		const

Prints the contents of a RestOfEvent object to screen.

Definition at line 391 of file RestOfEvent.cc.

{
  std::string tab = " - ";
  if (maskName != RestOfEvent::c_defaultMaskName) {
    // Disable possible B2FATAL in printing method, might be useful for tests
    if (!hasMask(maskName)) {
      B2WARNING("No mask with the name '" << maskName << "' exists in this ROE! Nothing else to print");
      return;
    }
    tab = " - - ";
  } else {
    if (m_isNested) {
      B2INFO(tab << "ROE is nested");
    }
    if (m_isFromMC) {
      B2INFO(tab << "ROE is build from generated particles");
    }
  }
  if (m_useKLMEnergy) {
    B2WARNING("This ROE has KLM energy included into its 4-vector!");
  }
  if (!m_isFromMC) {
    unsigned int nCharged = getChargedParticles(maskName, 0, unpackComposite).size();
    unsigned int nPhotons = getPhotons(maskName, unpackComposite).size();
    unsigned int nNeutralHadrons = getHadrons(maskName, unpackComposite).size();
    B2INFO(tab << "No. of Charged particles in ROE: " << nCharged);
    B2INFO(tab << "No. of Photons           in ROE: " << nPhotons);
    B2INFO(tab << "No. of K_L0 and neutrons in ROE: " << nNeutralHadrons);
  } else {
    unsigned int nParticles = getParticles(maskName, unpackComposite).size();
    B2INFO(tab << "No. of generated particles in ROE: " << nParticles);
  }
  printIndices(maskName, unpackComposite, tab);
}

◆ printIndices()

void printIndices	(	const std::string &	maskName = `c_defaultMaskName`,
		bool	unpackComposite = `true`,
		const std::string &	tab = `" - "`
	)		const

private

Prints indices in the given set in a single line.

Definition at line 426 of file RestOfEvent.cc.

{
  auto particles = getParticles(maskName, unpackComposite);
  if (particles.size() == 0) {
    B2INFO(tab << "No indices to print");
    return;
  }
  std::string printoutIndex =  tab + "|";
  std::string printoutPDG =  tab + "|";
  for (const auto particle : particles) {
    printoutIndex += std::to_string(particle->getArrayIndex()) +  " |  ";
    printoutPDG   += std::to_string(particle->getPDGCode()) +  " | ";
  }
  B2INFO(printoutPDG);
  B2INFO(printoutIndex);
}

◆ setPDGCode()

void setPDGCode ( int pdgCode )

inline

Sets the PDG code of the rest of event.

Definition at line 196 of file RestOfEvent.h.

    {
      m_pdgCode = pdgCode;
    }

◆ updateMaskWithCuts()

void updateMaskWithCuts	(	const std::string &	name,
		const std::shared_ptr< Variable::Cut > &	trackCut = `nullptr`,
		const std::shared_ptr< Variable::Cut > &	eclCut = `nullptr`,
		const std::shared_ptr< Variable::Cut > &	klmCut = `nullptr`,
		bool	updateExisting = `false`
	)

Update mask with cuts.

Parameters

name	Name of the mask to work with
trackCut	Cut on Track particles
eclCut	Cut on ECL particles
klmCut	Cut on KLM particles
updateExisting	Update existing mask if true or not if false

Definition at line 191 of file RestOfEvent.cc.

{
  if (maskName == RestOfEvent::c_defaultMaskName) {
    B2FATAL("ROE Mask name '" << RestOfEvent::c_defaultMaskName << "' is reserved for no mask case! " <<
            "Please check your inputs.");
  }
  Mask* mask = findMask(maskName);
  if (!mask) {
    B2FATAL("ROE Mask '" << maskName << "' does not exist!");
  }
  std::string sourceName = RestOfEvent::c_defaultMaskName;
  if (updateExisting) {
    // if mask already exists, take its particles to update
    sourceName = maskName;
  }
  // get all initial ROE particles, don't touch the possible V0s, otherwise, some daughters may be excluded, and some not... This may be revisited if needed
  std::vector<const Particle*> allROEParticles = getParticles(sourceName, false);
  std::vector<const Particle*> maskedParticles;
  // First check particle type, then check cuts, if no cuts provided, take all particles of this type
  for (auto* particle : allROEParticles) {
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_Track && (!trackCut || trackCut->check(particle))) {
      maskedParticles.push_back(particle);
    }
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_ECLCluster && (!eclCut || eclCut->check(particle))) {
      maskedParticles.push_back(particle);
    }
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_KLMCluster && (!klmCut || klmCut->check(particle))) {
      maskedParticles.push_back(particle);
    }
    // don't lose a possible V0 particle
    if (particle->getParticleSource() == Particle::EParticleSourceObject::c_Composite or
        particle->getParticleSource() == Particle::EParticleSourceObject::c_V0) {
      maskedParticles.push_back(particle);
    }
  }
  mask->clearParticles();
  mask->addParticles(maskedParticles);
}

◆ updateMaskWithV0()

void updateMaskWithV0	(	const std::string &	name,
		const Particle *	particleV0
	)

Update mask with composite particle.

Parameters

name	Name of the mask to work with
particleV0	Pointer to composite particle

Definition at line 231 of file RestOfEvent.cc.

{
  if (name == RestOfEvent::c_defaultMaskName) {
    B2FATAL("ROE Mask name '" << RestOfEvent::c_defaultMaskName << "' is reserved for no mask case! " <<
            "Please check your inputs.");
  }
  Mask* mask = findMask(name);
  if (!mask) {
    B2FATAL("ROE Mask '" << name << "' does not exist!");
  }
  std::vector<const Particle*> allROEParticles = getParticles(name, false);
  std::vector<int> indicesToErase;
  std::vector<const Particle*> daughtersV0 =  particleV0->getFinalStateDaughters();
  for (auto* maskParticle : allROEParticles) {
    bool toKeep = true;
    for (auto* daughterV0 : daughtersV0) {
      if (daughterV0->isCopyOf(maskParticle, true)) {
        toKeep = false;
      }
    }
    if (!toKeep) {
      indicesToErase.push_back(maskParticle->getArrayIndex());
    }
  }
  if (daughtersV0.size() != indicesToErase.size()) {
    B2DEBUG(10, "Only " << indicesToErase.size() << " daughters are excluded from mask particles. Abort");
    return;
  }
  std::string toprint = "We will erase next indices from " + name + " mask: ";
  for (auto& i : indicesToErase) {
    toprint += std::to_string(i) + " ";
  }
  B2DEBUG(10, toprint);
  // If everything is good, we add
  mask->addV0(particleV0, indicesToErase);
}

Member Data Documentation

◆ c_defaultMaskName

constexpr const char* c_defaultMaskName = "all"

staticconstexpr

Default mask name.

Definition at line 60 of file RestOfEvent.h.

◆ m_builtWithMostLikely

bool m_builtWithMostLikely

private

indicates whether most-likely particle lists were used in build of ROE

Definition at line 368 of file RestOfEvent.h.

◆ m_cacheArrayIndex

int m_cacheArrayIndex

mutableprivateinherited

Cache of the index in the TClonesArray to which this object belongs.

Definition at line 432 of file RelationsObject.h.

◆ m_cacheDataStoreEntry

DataStore::StoreEntry* m_cacheDataStoreEntry

mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

◆ m_isFromMC

bool m_isFromMC

private

MC ROE indicator.

Definition at line 366 of file RestOfEvent.h.

◆ m_isNested

bool m_isNested

private

Nested ROE indicator.

Definition at line 365 of file RestOfEvent.h.

◆ m_masks

std::vector<Mask> m_masks

private

List of the ROE masks.

Definition at line 363 of file RestOfEvent.h.

◆ m_particleIndices

std::set<int> m_particleIndices

private

StoreArray indices to unused particles.

Definition at line 362 of file RestOfEvent.h.

◆ m_pdgCode

int m_pdgCode

private

PDG code of the 'ROE particle' if we are going to create one.

Definition at line 364 of file RestOfEvent.h.

◆ m_useKLMEnergy

bool m_useKLMEnergy

private

Include KLM energy into ROE 4-vector.

Definition at line 367 of file RestOfEvent.h.

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

analysis/dataobjects/include/RestOfEvent.h
analysis/dataobjects/src/RestOfEvent.cc

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RestOfEvent()

Member Function Documentation

◆ addParticles()

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ checkCompatibilityOfMaskAndV0()

◆ convertToParticle()

◆ copyRelations()

◆ excludeParticlesFromMask()

◆ findMask()

◆ get4Vector()

◆ get4VectorNeutralECLClusters()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getChargedParticles()

◆ getHadrons()

◆ getInfo()

◆ getInfoHTML()

◆ getIsNested()

◆ getMaskNames()

◆ getName()

◆ getNECLClusters()

◆ getNKLMClusters()

◆ getNTracks()

◆ getParticles()

◆ getPDGCode()

◆ getPhotons()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ hasMask()

◆ hasParticle()

◆ initializeMask()

◆ isBuiltWithMostLikely()

◆ isInParticleList()

◆ print()

◆ printIndices()

◆ setPDGCode()

◆ updateMaskWithCuts()

◆ updateMaskWithV0()

Member Data Documentation

◆ c_defaultMaskName

◆ m_builtWithMostLikely

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_isFromMC

◆ m_isNested

◆ m_masks

◆ m_particleIndices

◆ m_pdgCode

◆ m_useKLMEnergy