Class to stores ExtraInfo of the whole event. More...

#include <EventExtraInfo.h>

Inheritance diagram for EventExtraInfo:

Collaboration diagram for EventExtraInfo:

[legend]

Public Member Functions
float	getExtraInfo (const std::string &name) const
	Return given value if set.

bool	hasExtraInfo (const std::string &name) const
	Return whether the extra info with the given name is set.

void	removeExtraInfo ()
	Removes extra info from event.

void	addExtraInfo (const std::string &name, float value)
	Sets the user-defined data of given name to the given value.

void	setExtraInfo (const std::string &name, float value)
	Sets the user-defined data of given name to the given value.

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

std::vector< std::string >	getNames () const
	Grab the names in this event extra info (for printing etc)

std::string	getExtraStringInfo (const std::string &name) const
	Return given value if set.

bool	hasExtraStringInfo (const std::string &name) const
	Return whether the extra string info with the given name is set.

void	removeExtraStringInfo ()
	Removes extra string info from event.

void	addExtraStringInfo (const std::string &name, const std::string &value)
	Sets the user-defined data of given name to the given value.

void	setExtraStringInfo (const std::string &name, const std::string &value)
	Sets the user-defined data of given name to the given value.

std::vector< std::string >	getStringInfoNames () const
	Grab the names in this event extra string info (for printing etc)

void	addEventType (const std::string &eventType)
	Add the event type information.

std::string	getEventType () const
	Get the event type information.

Private Member Functions
	ClassDef (EventExtraInfo, 3)
	Class to store event extra info.

Private Attributes
std::map< std::string, float >	eventExtraInfo
	map variable names to values.

std::map< std::string, std::string >	eventExtraStringInfo
	map variable names to values for string data type.

Detailed Description

Class to stores ExtraInfo of the whole event.

Used by TMVAExpert to save expert output for a event-level training

Definition at line 25 of file EventExtraInfo.h.

Member Function Documentation

◆ addEventType()

void addEventType ( const std::string & eventType )

inline

Add the event type information.

Helper function for the GeneratorBaseModule.

Definition at line 90 of file EventExtraInfo.h.

    {
      addExtraStringInfo(std::string("eventType"), eventType);
    };

◆ addExtraInfo()

void addExtraInfo	(	const std::string &	name,
		float	value
	)

Sets the user-defined data of given name to the given value.

throws std::out_of_range if variable is already set.

Definition at line 34 of file EventExtraInfo.cc.

{
  if (hasExtraInfo(name)) {
    throw std::out_of_range(std::string("Key with name ") + name + " already exists in EventExtraInfo.");
  }
  eventExtraInfo[name] = value;
}

◆ addExtraStringInfo()

void addExtraStringInfo	(	const std::string &	name,
		const std::string &	value
	)

Sets the user-defined data of given name to the given value.

throws std::out_of_range if variable is already set.

Definition at line 84 of file EventExtraInfo.cc.

{
  if (hasExtraStringInfo(name)) {
    throw std::out_of_range(std::string("Key with name ") + name + " already exists in EventExtraInfo.");
  }
  eventExtraStringInfo[name] = value;
}

◆ getEventType()

std::string getEventType ( ) const

Get the event type information.

Helper function for the VariablesToNtupleModule

Definition at line 105 of file EventExtraInfo.cc.

{
  if (hasExtraStringInfo(std::string("eventType")))
    return getExtraStringInfo(std::string("eventType"));
  else
    return std::string("");
}

◆ getExtraInfo()

float getExtraInfo ( const std::string & name ) const

Return given value if set.

throws std::out_of_range if variable is not set.

Definition at line 16 of file EventExtraInfo.cc.

{
  if (hasExtraInfo(name)) return eventExtraInfo.at(name);
  else throw std::runtime_error("EventExtraInfo::getExtraInfo: You try to access the EventExtraInfo '" + name +
                                  "', but it doesn't exist.");
}

◆ getExtraStringInfo()

std::string getExtraStringInfo ( const std::string & name ) const

Return given value if set.

throws std::out_of_range if variable is not set.

Definition at line 66 of file EventExtraInfo.cc.

{
  if (hasExtraStringInfo(name)) return eventExtraStringInfo.at(name);
  else throw std::runtime_error("EventExtraInfo::getExtraStringInfo: You try to access the EventExtraInfo '" + name +
                                  "', but it doesn't exist.");
}

◆ getInfoHTML()

std::string getInfoHTML ( ) const

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

Definition at line 47 of file EventExtraInfo.cc.

{
  std::string s;
  for (const auto& pair : eventExtraInfo) {
    s += HTML::escape(pair.first) + " = " + std::to_string(pair.second) + "<br />";
  }
  return s;
}

◆ getNames()

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

Grab the names in this event extra info (for printing etc)

Definition at line 56 of file EventExtraInfo.cc.

{
  std::vector<std::string> out;
  for (const auto& pair : eventExtraInfo)
    out.push_back(pair.first);
  return out;
}

◆ getStringInfoNames()

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

Grab the names in this event extra string info (for printing etc)

Definition at line 97 of file EventExtraInfo.cc.

{
  std::vector<std::string> out;
  for (const auto& pair : eventExtraStringInfo)
    out.push_back(pair.first);
  return out;
}

◆ hasExtraInfo()

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

Return whether the extra info with the given name is set.

Definition at line 23 of file EventExtraInfo.cc.

{
  return not(eventExtraInfo.find(name) == eventExtraInfo.end());
}

◆ hasExtraStringInfo()

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

Return whether the extra string info with the given name is set.

Definition at line 73 of file EventExtraInfo.cc.

{
  return not(eventExtraStringInfo.find(name) == eventExtraStringInfo.end());
}

◆ removeExtraInfo()

void removeExtraInfo ( )

Removes extra info from event.

Definition at line 29 of file EventExtraInfo.cc.

{
  eventExtraInfo.clear();
}

◆ removeExtraStringInfo()

void removeExtraStringInfo ( )

Removes extra string info from event.

Definition at line 79 of file EventExtraInfo.cc.

{
  eventExtraStringInfo.clear();
}

◆ setExtraInfo()

void setExtraInfo	(	const std::string &	name,
		float	value
	)

Sets the user-defined data of given name to the given value.

Does not throw anything if the value is already set. Overrides existing values

Definition at line 42 of file EventExtraInfo.cc.

{
  eventExtraInfo[name] = value;
}

◆ setExtraStringInfo()

void setExtraStringInfo	(	const std::string &	name,
		const std::string &	value
	)

Sets the user-defined data of given name to the given value.

Does not throw anything if the value is already set. Overrides existing values

Definition at line 92 of file EventExtraInfo.cc.

{
  eventExtraStringInfo[name] = value;
}

Member Data Documentation

◆ eventExtraInfo

std::map<std::string, float> eventExtraInfo

private

map variable names to values.

Definition at line 100 of file EventExtraInfo.h.

◆ eventExtraStringInfo

std::map<std::string, std::string> eventExtraStringInfo

private

map variable names to values for string data type.

Definition at line 102 of file EventExtraInfo.h.

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

framework/dataobjects/include/EventExtraInfo.h
framework/dataobjects/src/EventExtraInfo.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addEventType()

◆ addExtraInfo()

◆ addExtraStringInfo()

◆ getEventType()

◆ getExtraInfo()

◆ getExtraStringInfo()

◆ getInfoHTML()

◆ getNames()

◆ getStringInfoNames()

◆ hasExtraInfo()

◆ hasExtraStringInfo()

◆ removeExtraInfo()

◆ removeExtraStringInfo()

◆ setExtraInfo()

◆ setExtraStringInfo()

Member Data Documentation

◆ eventExtraInfo

◆ eventExtraStringInfo