Dataobject to store the results of the cut calculations performed by the SoftwareTriggerModule. More...

#include <SoftwareTriggerResult.h>

Inheritance diagram for SoftwareTriggerResult:

Public Member Functions
void	addResult (const std::string &triggerIdentifier, SoftwareTriggerCutResult result, SoftwareTriggerCutResult nonPrescaledResult=SoftwareTriggerCutResult::c_noResult)
	Add a new cut result to the storage or override the result with the same name.

std::pair< SoftwareTriggerCutResult, SoftwareTriggerCutResult >	getResultPair (const std::string &triggerIdentifier) const
	Return the cut result and the non-prescaled cut result with the given name or throw an error if no result is there.

SoftwareTriggerCutResult	getResult (const std::string &triggerIdentifier) const
	Return the cut result with the given name or throw an error if no result is there.

SoftwareTriggerCutResult	getNonPrescaledResult (const std::string &triggerIdentifier) const
	Return the non-prescaled cut result with the given name or throw an error if no result is there.

const std::map< std::string, std::pair< int, int > > &	getResultPairs () const
	Return all stored cut tags with their results as a map identifier -> [prescaled cut result, non prescaled cut result].

std::map< std::string, int >	getResults () const
	Return all stored cut tags with their results as a map identifier -> cut result.

std::map< std::string, int >	getNonPrescaledResults () const
	Return all stored cut tags with their non-prescaled results as a map identifier -> cut result.

void	clear ()
	Clear all results.

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

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.

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.

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
	ClassDefOverride (SoftwareTriggerResult, 5)
	Making this class a ROOT class.

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

Private Attributes
std::map< std::string, std::pair< int, int > >	m_results
	Internal storage of the cut decisions with names.

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

Dataobject to store the results of the cut calculations performed by the SoftwareTriggerModule.

This is basically a map storing cut/trigger identifier -> result where cut/trigger identifier is the identifier of the checked cut and result is a bool variable with the result of the decision. and result is a bool variable with the result of the decision.

Definition at line 36 of file SoftwareTriggerResult.h.

Member Function Documentation

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

◆ addResult()

void addResult	(	const std::string &	triggerIdentifier,
		SoftwareTriggerCutResult	result,
		SoftwareTriggerCutResult	nonPrescaledResult = `SoftwareTriggerCutResult::c_noResult`
	)

Add a new cut result to the storage or override the result with the same name.

Definition at line 17 of file SoftwareTriggerResult.cc.

{
  m_results[triggerIdentifier] = std::make_pair(static_cast<int>(result), static_cast<int>(nonPrescalesResult));
}

◆ clear()

void clear ( )

Clear all results.

Definition at line 62 of file SoftwareTriggerResult.cc.

{
  m_results.clear();
}

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

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

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

std::string getInfoHTML ( ) const

overridevirtual

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

Reimplemented from RelationsInterface< BASE >.

Definition at line 67 of file SoftwareTriggerResult.cc.

{
  std::stringstream out;
  out << "<table>";
 
  const std::string colorNeutral = gROOT->GetColor(kWhite)->AsHexString();
  const std::string colorReject = gROOT->GetColor(kRed)->AsHexString();
  const std::string colorAccept = gROOT->GetColor(kGreen)->AsHexString();
 
  for (const auto& result : m_results) {
    out << "<tr>";
    std::string name = result.first;
    boost::replace_all(name, "software_trigger_cut&", "");
    boost::replace_all(name, "&", "/");
    const int value = result.second.first;
 
    auto thisColor = colorNeutral;
    if (value > 0) {
      thisColor = colorAccept;
    } else if (value < 0) {
      thisColor = colorReject;
    }
 
    out << "<td>" << name << "</td>";
    out << "<td bgcolor=\"" << thisColor << "\">" << value << "</td>";
    out << "</tr>";
  }
  out << "</table>";
  return out.str();
}

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in Particle, MCParticle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getNonPrescaledResult()

SoftwareTriggerCutResult getNonPrescaledResult ( const std::string & triggerIdentifier ) const

Return the non-prescaled cut result with the given name or throw an error if no result is there.

Return the cut result with the given name or throw an error if no result is there.

Definition at line 36 of file SoftwareTriggerResult.cc.

{
  return getResultPair(triggerIdentifier).second;
}

◆ getNonPrescaledResults()

std::map< std::string, int > getNonPrescaledResults ( ) const

Return all stored cut tags with their non-prescaled results as a map identifier -> cut result.

Please be aware that the cut result is an integer (because of ROOT reasons).

Definition at line 51 of file SoftwareTriggerResult.cc.

{
  std::map<std::string, int> result;
  // cppcheck-suppress unassignedVariable ; cppcheck doesn't understand the assignment in the range-based for loop
  for (const auto& [key, valuePair] : m_results) {
    result[key] = valuePair.second;
  }
  return result;
}

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

◆ getResult()

SoftwareTriggerCutResult getResult ( const std::string & triggerIdentifier ) const

Return the cut result with the given name or throw an error if no result is there.

Definition at line 30 of file SoftwareTriggerResult.cc.

{
  return getResultPair(triggerIdentifier).first;
}

◆ getResultPair()

std::pair< SoftwareTriggerCutResult, SoftwareTriggerCutResult > getResultPair ( const std::string & triggerIdentifier ) const

Return the cut result and the non-prescaled cut result with the given name or throw an error if no result is there.

Definition at line 23 of file SoftwareTriggerResult.cc.

{
  auto pair = m_results.at(triggerIdentifier);
  return {static_cast<SoftwareTriggerCutResult>(pair.first), static_cast<SoftwareTriggerCutResult>(pair.second)};
}

◆ getResultPairs()

const std::map< std::string, std::pair< int, int > > & getResultPairs ( ) const

inline

Return all stored cut tags with their results as a map identifier -> [prescaled cut result, non prescaled cut result].

Please be aware that the cut result is an integer (because of ROOT reasons).

Definition at line 55 of file SoftwareTriggerResult.h.

    {
      return m_results;
    }

◆ getResults()

std::map< std::string, int > getResults ( ) const

Return all stored cut tags with their results as a map identifier -> cut result.

Please be aware that the cut result is an integer (because of ROOT reasons).

Definition at line 41 of file SoftwareTriggerResult.cc.

{
  std::map<std::string, int> result;
  // cppcheck-suppress unassignedVariable ; cppcheck doesn't understand the assignment in the range-based for loop
  for (const auto& [key, valuePair] : m_results) {
    result[key] = valuePair.first;
  }
  return result;
}

Member Data Documentation

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

std::map<std::string, std::pair<int, int> > m_results

private

Internal storage of the cut decisions with names.

Definition at line 80 of file SoftwareTriggerResult.h.

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

mdst/dataobjects/include/SoftwareTriggerResult.h
mdst/dataobjects/src/SoftwareTriggerResult.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ addResult()

◆ clear()

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getNonPrescaledResult()

◆ getNonPrescaledResults()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getResult()

◆ getResultPair()

◆ getResultPairs()

◆ getResults()

Member Data Documentation

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_results