Storage element for the eventwise T0 estimation. More...

#include <EventT0.h>

Inheritance diagram for EventT0:

Collaboration diagram for EventT0:

[legend]

Classes
struct	EventT0Component
	Structure for storing the extracted event t0s together with its detector and its uncertainty. More...

Public Member Functions
bool	hasEventT0 () const
	Check if a final event t0 is set.

double	getEventT0 (bool fromTrackCreator=false) const
	Return the final event t0, if one is set.

std::optional< EventT0Component >	getEventT0Component () const
	Return the final event t0, if one is set. Else, return an empty optional.

double	getEventT0Uncertainty () const
	Return the final event t0 uncertainty, if one is set. Else, return NAN.

void	setEventT0 (double eventT0, double eventT0Uncertainty, const Const::DetectorSet &detector, const std::string &algorithm="")
	Replace/set the final double T0 estimation.

void	setEventT0 (const EventT0Component &eventT0)
	Replace/set the final double T0 estimation.

void	addTemporaryEventT0 (const EventT0Component &eventT0)
	Add another temporary double T0 estimation.

const std::vector< EventT0Component > &	getTemporaryEventT0s () const
	Return the list of all temporary event t0 estimations.

const std::vector< EventT0Component >	getTemporaryEventT0s (Const::EDetector detector) const
	Return the list of all temporary event t0 estimations for a specific detector.

bool	hasTemporaryEventT0 (const Const::DetectorSet &detectorSet=Const::allDetectors) const
	Check if one of the detectors in the given set has a temporary t0 estimation.

Const::DetectorSet	getTemporaryDetectors () const
	Get the detectors that have determined temporary event T0s.

unsigned long	getNumberOfTemporaryEventT0s () const
	Return the number of stored event T0s.

std::optional< EventT0Component >	getBestSVDTemporaryEventT0 () const
	Return the best SVD-based EventT0 candidate if it exists.

std::optional< EventT0Component >	getBestCDCTemporaryEventT0 () const
	Return the best CDC-based EventT0 candidate if it exists.

std::optional< EventT0Component >	getBestTOPTemporaryEventT0 () const
	Return the best TOP-based EventT0 candidate if it exists.

std::optional< EventT0Component >	getBestECLTemporaryEventT0 () const
	Return the best ECL-based EventT0 candidate if it exists.

bool	isEventT0Of (Const::EDetector detector) const
	Is the current EventT0 value based on information of the detector.

bool	isSVDEventT0 () const
	Is m_eventT0 based on SVD information?

bool	isCDCEventT0 () const
	Is m_eventT0 based on CDC information?

bool	isTOPEventT0 () const
	Is m_eventT0 based on TOP information?

bool	isECLEventT0 () const
	Is m_eventT0 based on ECL information?

void	clearTemporaries ()
	Clear the list of temporary event T0 estimations.

void	clearEventT0 ()
	Clear the final EventT0, this is needed in case some algorithm has set one for an itertive t0 finding procedure and none was set in the beginning.

Private Attributes
std::vector< EventT0Component >	m_temporaryEventT0List
	Internal storage of the temporary event t0 list.

EventT0Component	m_eventT0
	Internal storage for the final event t0.

bool	m_hasEventT0 = false
	Internal storage of the final eventT0 is set.

Detailed Description

Storage element for the eventwise T0 estimation.

It can store a double value with uncertainty together with the detector component.

Additionally, it can store an arbitrary number of temporary event t0 estimations not to be used for the final decision.

Definition at line 29 of file EventT0.h.

Member Function Documentation

◆ addTemporaryEventT0()

void addTemporaryEventT0 ( const EventT0Component & eventT0 )

Add another temporary double T0 estimation.

Definition at line 113 of file EventT0.cc.

{
  m_temporaryEventT0List.push_back(eventT0);
}

◆ clearEventT0()

void clearEventT0 ( )

Clear the final EventT0, this is needed in case some algorithm has set one for an itertive t0 finding procedure and none was set in the beginning.

Definition at line 123 of file EventT0.cc.

{
  m_hasEventT0 = false;
}

◆ clearTemporaries()

void clearTemporaries ( )

Clear the list of temporary event T0 estimations.

Definition at line 118 of file EventT0.cc.

{
  m_temporaryEventT0List.clear();
}

◆ getBestCDCTemporaryEventT0()

std::optional< EventT0::EventT0Component > getBestCDCTemporaryEventT0 ( ) const

Return the best CDC-based EventT0 candidate if it exists.

Definition at line 139 of file EventT0.cc.

{
  if (hasTemporaryEventT0(Const::EDetector::CDC)) {
    std::vector<EventT0::EventT0Component> cdcT0s = getTemporaryEventT0s(Const::EDetector::CDC);
    // The most accurate CDC EventT0 candidate is the last one in the list
    return std::make_optional(cdcT0s.back());
  }
 
  return {};
}

◆ getBestECLTemporaryEventT0()

std::optional< EventT0::EventT0Component > getBestECLTemporaryEventT0 ( ) const

Return the best ECL-based EventT0 candidate if it exists.

Definition at line 161 of file EventT0.cc.

{
  if (hasTemporaryEventT0(Const::EDetector::ECL)) {
    std::vector<EventT0::EventT0Component> eclT0s = getTemporaryEventT0s(Const::EDetector::ECL);
    // The most accurate ECL EevenT0 is assumed to be the one with smallest chi2/quality
    auto eclBestT0 = std::min_element(eclT0s.begin(), eclT0s.end(), [](EventT0::EventT0Component c1,
    EventT0::EventT0Component c2) {return c1.quality < c2.quality;});
    return std::make_optional(*eclBestT0);
  }
 
  return {};
}

◆ getBestSVDTemporaryEventT0()

std::optional< EventT0::EventT0Component > getBestSVDTemporaryEventT0 ( ) const

Return the best SVD-based EventT0 candidate if it exists.

Definition at line 128 of file EventT0.cc.

{
  if (hasTemporaryEventT0(Const::EDetector::SVD)) {
    std::vector<EventT0::EventT0Component> svdT0s = getTemporaryEventT0s(Const::EDetector::SVD);
    // The most accurate SVD EventT0 candidate is the last one in the list
    return std::make_optional(svdT0s.back());
  }
 
  return {};
}

◆ getBestTOPTemporaryEventT0()

std::optional< EventT0::EventT0Component > getBestTOPTemporaryEventT0 ( ) const

Return the best TOP-based EventT0 candidate if it exists.

Definition at line 150 of file EventT0.cc.

{
  if (hasTemporaryEventT0(Const::EDetector::TOP)) {
    std::vector<EventT0::EventT0Component> topT0s = getTemporaryEventT0s(Const::EDetector::TOP);
    // The most accurate TOP EventT0 candidate is the last one in the list, though there should only be one at max anyway
    return std::make_optional(topT0s.back());
  }
 
  return {};
}

◆ getEventT0()

double getEventT0 ( bool fromTrackCreator = false ) const

Return the final event t0, if one is set.

Return the final event t0, if one is set. Else, return NAN.

Else, return NAN.

Parameters

fromTrackCreator If true, return the event t0 for track creator with different preferences

Definition at line 25 of file EventT0.cc.

{
  B2ASSERT("Not EventT0 available, but someone tried to access it. Check with hasEventT0() method before!", hasEventT0());
 
  //if EventT0 is needed by Track Creator, first check SVD and CDC
  //use the combined eventT0 only as last resort
  if (fromTrackCreator) {
    const auto svdT0 = this->getBestSVDTemporaryEventT0();
    if (svdT0) return svdT0->eventT0;
    else {
      const auto cdcT0 = this->getBestCDCTemporaryEventT0();
      if (cdcT0) return cdcT0->eventT0;
    }
  }
  return m_eventT0.eventT0;
}

◆ getEventT0Component()

std::optional< EventT0::EventT0Component > getEventT0Component ( ) const

Return the final event t0, if one is set. Else, return an empty optional.

Definition at line 42 of file EventT0.cc.

{
  if (hasEventT0()) {
    return std::make_optional(m_eventT0);
  }
 
  return {};
}

◆ getEventT0Uncertainty()

double getEventT0Uncertainty ( ) const

Return the final event t0 uncertainty, if one is set. Else, return NAN.

Definition at line 52 of file EventT0.cc.

{
  return m_eventT0.eventT0Uncertainty;
}

◆ getNumberOfTemporaryEventT0s()

unsigned long getNumberOfTemporaryEventT0s ( ) const

Return the number of stored event T0s.

Definition at line 108 of file EventT0.cc.

{
  return m_temporaryEventT0List.size();
}

◆ getTemporaryDetectors()

Const::DetectorSet getTemporaryDetectors ( ) const

Get the detectors that have determined temporary event T0s.

Definition at line 97 of file EventT0.cc.

{
  Const::DetectorSet temporarySet;
 
  for (const EventT0Component& eventT0Component : m_temporaryEventT0List) {
    temporarySet += eventT0Component.detectorSet;
  }
 
  return temporarySet;
}

◆ getTemporaryEventT0s() [1/2]

const std::vector< EventT0::EventT0Component > & getTemporaryEventT0s ( ) const

Return the list of all temporary event t0 estimations.

Definition at line 81 of file EventT0.cc.

{
  return m_temporaryEventT0List;
}

◆ getTemporaryEventT0s() [2/2]

const std::vector< EventT0::EventT0Component > getTemporaryEventT0s ( Const::EDetector detector ) const

Return the list of all temporary event t0 estimations for a specific detector.

Definition at line 86 of file EventT0.cc.

{
  std::vector<EventT0::EventT0Component> detectorT0s;
 
  const auto lmdSelectDetector = [detector](EventT0::EventT0Component const & c) {return c.detectorSet.contains(detector);};
  std::copy_if(m_temporaryEventT0List.begin(), m_temporaryEventT0List.end(),
               std::back_inserter(detectorT0s), lmdSelectDetector);
  return detectorT0s;
}

◆ hasEventT0()

bool hasEventT0 ( ) const

Check if a final event t0 is set.

Definition at line 19 of file EventT0.cc.

{
  return m_hasEventT0;
}

◆ hasTemporaryEventT0()

bool hasTemporaryEventT0 ( const Const::DetectorSet & detectorSet = Const::allDetectors ) const

Check if one of the detectors in the given set has a temporary t0 estimation.

Definition at line 70 of file EventT0.cc.

{
  for (const EventT0Component& eventT0Component : m_temporaryEventT0List) {
    if (detectorSet.contains(eventT0Component.detectorSet)) {
      return true;
    }
  }
 
  return false;
}

◆ isCDCEventT0()

bool isCDCEventT0 ( ) const

inline

Is m_eventT0 based on CDC information?

Definition at line 125 of file EventT0.h.

    {
      return isEventT0Of(Const::EDetector::CDC);
    }

◆ isECLEventT0()

bool isECLEventT0 ( ) const

inline

Is m_eventT0 based on ECL information?

Definition at line 135 of file EventT0.h.

    {
      return isEventT0Of(Const::EDetector::ECL);
    }

◆ isEventT0Of()

bool isEventT0Of ( Const::EDetector detector ) const

inline

Is the current EventT0 value based on information of the detector.

Parameters

detector The detector for which one wants to know whether m_eventT0 is based on it

Returns: true if m_eventT0 is based on the detector under question, false otherwise

Definition at line 111 of file EventT0.h.

    {
      if (hasTemporaryEventT0(detector)) {
        return m_eventT0.detectorSet.contains(detector);
      }
      return false;
    }

◆ isSVDEventT0()

bool isSVDEventT0 ( ) const

inline

Is m_eventT0 based on SVD information?

Definition at line 120 of file EventT0.h.

    {
      return isEventT0Of(Const::EDetector::SVD);
    }

◆ isTOPEventT0()

bool isTOPEventT0 ( ) const

inline

Is m_eventT0 based on TOP information?

Definition at line 130 of file EventT0.h.

    {
      return isEventT0Of(Const::EDetector::TOP);
    }

◆ setEventT0() [1/2]

void setEventT0 ( const EventT0Component & eventT0 )

Replace/set the final double T0 estimation.

Definition at line 64 of file EventT0.cc.

{
  m_eventT0 = eventT0;
  m_hasEventT0 = true;
}

◆ setEventT0() [2/2]

void setEventT0	(	double	eventT0,
		double	eventT0Uncertainty,
		const Const::DetectorSet &	detector,
		const std::string &	algorithm = "" )

Replace/set the final double T0 estimation.

Definition at line 58 of file EventT0.cc.

{
  setEventT0(EventT0Component(eventT0, eventT0Uncertainty, detector, algorithm));
}

Member Data Documentation

◆ m_eventT0

EventT0Component m_eventT0

private

Internal storage for the final event t0.

Definition at line 155 of file EventT0.h.

◆ m_hasEventT0

bool m_hasEventT0 = false

private

Internal storage of the final eventT0 is set.

Definition at line 157 of file EventT0.h.

◆ m_temporaryEventT0List

std::vector<EventT0Component> m_temporaryEventT0List

private

Internal storage of the temporary event t0 list.

Definition at line 153 of file EventT0.h.

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

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

Classes

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addTemporaryEventT0()

◆ clearEventT0()

◆ clearTemporaries()

◆ getBestCDCTemporaryEventT0()

◆ getBestECLTemporaryEventT0()

◆ getBestSVDTemporaryEventT0()

◆ getBestTOPTemporaryEventT0()

◆ getEventT0()

◆ getEventT0Component()

◆ getEventT0Uncertainty()

◆ getNumberOfTemporaryEventT0s()

◆ getTemporaryDetectors()

◆ getTemporaryEventT0s() [1/2]

◆ getTemporaryEventT0s() [2/2]

◆ hasEventT0()

◆ hasTemporaryEventT0()

◆ isCDCEventT0()

◆ isECLEventT0()

◆ isEventT0Of()

◆ isSVDEventT0()

◆ isTOPEventT0()

◆ setEventT0() [1/2]

◆ setEventT0() [2/2]

Member Data Documentation

◆ m_eventT0

◆ m_hasEventT0

◆ m_temporaryEventT0List