Gambit::ColliderBit::Analysis Class Reference

A class for collider analyses within ColliderBit. More...

#include <Analysis.hpp>

Inheritance diagram for Gambit::ColliderBit::Analysis:

Collaboration diagram for Gambit::ColliderBit::Analysis:

Public Member Functions
	Analysis ()
	Construction. More...
virtual	~Analysis ()
	Destruction. More...
void	reset ()
	Public method to reset this instance for reuse, avoiding the need for "new" or "delete". More...
double	luminosity () const
	Return the integrated luminosity. More...
void	set_luminosity (double)
	Set the integrated luminosity. More...
void	set_analysis_name (str)
	Set the analysis name. More...
str	analysis_name ()
	Get the analysis name. More...
const AnalysisData &	get_results ()
	Get the collection of SignalRegionData for likelihood computation. More...
const AnalysisData &	get_results (str &)
	An overload of get_results() with some additional consistency checks. More...
const AnalysisData *	get_results_ptr ()
	Get a pointer to _results. More...
const AnalysisData *	get_results_ptr (str &)
	Get a pointer to _results. More...
void	scale (double)
	Scale by xsec per event. More...
Event analysis, event number, and cross section functions:
Analyze the event (accessed by reference).
void	analyze (const HEPUtils::Event &)
	Analyze the event (accessed by reference). More...
void	analyze (const HEPUtils::Event *)
	Analyze the event (accessed by pointer). More...
Analysis combination operations
Add the results of another analysis to this one. Argument is not const, because the other needs to be able to gather its results if necessary.
void	add (Analysis *other)
	Add the results of another analysis to this one. Argument is not const, because the other needs to be able to gather its results if necessary. More...
virtual void	combine (const Analysis *other)=0
	Add the analysis-specific variables of another analysis to this one. More...

Protected Member Functions
virtual void	analysis_specific_reset ()=0
	Reset the analysis-specific variables. More...
Collection functions
Run the analysis.
virtual void	run (const HEPUtils::Event *)=0
void	add_result (const SignalRegionData &sr)
	Add the given result to the internal results list. More...
void	set_covariance (const Eigen::MatrixXd &srcov)
	Set the covariance matrix, expressing SR correlations. More...
void	set_covariance (const std::vector< std::vector< double >> &)
	A convenience function for setting the SR covariance from a nested vector/initialiser list. More...
virtual void	collect_results ()=0
	Gather together the info for likelihood calculation. More...

Private Attributes
double	_luminosity
bool	_luminosity_is_set
bool	_is_scaled
bool	_needs_collection
AnalysisData	_results
std::string	_analysis_name

Detailed Description

A class for collider analyses within ColliderBit.

Definition at line 41 of file Analysis.hpp.

Constructor & Destructor Documentation

Analysis()

Gambit::ColliderBit::Analysis::Analysis

(

)

Construction.

Definition at line 36 of file Analysis.cpp.

                       : _luminosity(0)
                         , _luminosity_is_set(false)
                         , _is_scaled(false)
                         , _needs_collection(true)
                         { }

~Analysis()

virtual Gambit::ColliderBit::Analysis::~Analysis ( )

inlinevirtual

Destruction.

Definition at line 49 of file Analysis.hpp.

References add(), add_result(), analysis_name(), analysis_specific_reset(), analyze(), collect_results(), combine(), get_results(), get_results_ptr(), luminosity(), reset(), run(), scale(), set_analysis_name(), set_covariance(), and set_luminosity().

{ }

Here is the call graph for this function:

Member Function Documentation

add()

void Gambit::ColliderBit::Analysis::add

(

Analysis *

other

)

Add the results of another analysis to this one. Argument is not const, because the other needs to be able to gather its results if necessary.

Definition at line 145 of file Analysis.cpp.

References _results, collect_results(), combine(), Gambit::ColliderBit::AnalysisData::empty(), get_results(), and Gambit::ColliderBit::AnalysisData::size().

Referenced by ~Analysis().

    {
      if (_results.empty()) collect_results();
      if (this == other) return;
      const AnalysisData otherResults = other->get_results();
      assert(otherResults.size() == _results.size());
      for (size_t i = 0; i < _results.size(); ++i)
      {
        _results[i].n_sig_MC += otherResults[i].n_sig_MC;
      }
      combine(other);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

add_result()

void Gambit::ColliderBit::Analysis::add_result ( const SignalRegionData &  sr )

protected

Add the given result to the internal results list.

Definition at line 113 of file Analysis.cpp.

References _results, and Gambit::ColliderBit::AnalysisData::add().

Referenced by ~Analysis().

{ _results.add(sr); }

Here is the call graph for this function:

Here is the caller graph for this function:

analysis_name()

str Gambit::ColliderBit::Analysis::analysis_name

(

)

Get the analysis name.

Definition at line 75 of file Analysis.cpp.

References _analysis_name.

Referenced by ~Analysis().

{ return _analysis_name; }

Here is the caller graph for this function:

analysis_specific_reset()

virtual void Gambit::ColliderBit::Analysis::analysis_specific_reset ( )

protectedpure virtual

Reset the analysis-specific variables.

Referenced by reset(), and ~Analysis().

Here is the caller graph for this function:

analyze() [1/2]

void Gambit::ColliderBit::Analysis::analyze

(

const HEPUtils::Event &

e

)

Analyze the event (accessed by reference).

Definition at line 52 of file Analysis.cpp.

Referenced by ~Analysis().

{ analyze(&e); }

Here is the caller graph for this function:

analyze() [2/2]

void Gambit::ColliderBit::Analysis::analyze

(

const HEPUtils::Event *

e

)

Analyze the event (accessed by pointer).

Definition at line 55 of file Analysis.cpp.

References _needs_collection, and run().

    {
      _needs_collection = true;
      run(e);
    }

Here is the call graph for this function:

collect_results()

virtual void Gambit::ColliderBit::Analysis::collect_results ( )

protectedpure virtual

Gather together the info for likelihood calculation.

Referenced by add(), get_results(), and ~Analysis().

Here is the caller graph for this function:

combine()

virtual void Gambit::ColliderBit::Analysis::combine ( const Analysis *  other )

pure virtual

Add the analysis-specific variables of another analysis to this one.

Referenced by add(), and ~Analysis().

Here is the caller graph for this function:

get_results() [1/2]

const AnalysisData & Gambit::ColliderBit::Analysis::get_results

(

)

Get the collection of SignalRegionData for likelihood computation.

Definition at line 78 of file Analysis.cpp.

References _needs_collection, _results, and collect_results().

Referenced by add(), get_results(), get_results_ptr(), and ~Analysis().

    {
      if (_needs_collection)
      {
        collect_results();
        _needs_collection = false;
      }
      return _results;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get_results() [2/2]

const AnalysisData & Gambit::ColliderBit::Analysis::get_results

(

str &

warning

)

An overload of get_results() with some additional consistency checks.

Definition at line 89 of file Analysis.cpp.

References _analysis_name, _is_scaled, _luminosity_is_set, and get_results().

    {
      warning = "";
      if (not _luminosity_is_set)
        warning += "Luminosity has not been set for analysis " + _analysis_name + ".";
      if (not _is_scaled)
        warning += "Results have not been scaled for analysis " + _analysis_name + ".";

      return get_results();
    }

Here is the call graph for this function:

get_results_ptr() [1/2]

const AnalysisData * Gambit::ColliderBit::Analysis::get_results_ptr

(

)

Get a pointer to _results.

Definition at line 101 of file Analysis.cpp.

References get_results().

Referenced by ~Analysis().

    {
      return &get_results();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get_results_ptr() [2/2]

const AnalysisData * Gambit::ColliderBit::Analysis::get_results_ptr

(

str &

warning

)

Get a pointer to _results.

Definition at line 107 of file Analysis.cpp.

References get_results().

    {
      return &get_results(warning);
    }

Here is the call graph for this function:

luminosity()

double Gambit::ColliderBit::Analysis::luminosity

(

)

const

Return the integrated luminosity.

Definition at line 62 of file Analysis.cpp.

References _luminosity.

Referenced by scale(), and ~Analysis().

{ return _luminosity; }

Here is the caller graph for this function:

reset()

void Gambit::ColliderBit::Analysis::reset

(

)

Public method to reset this instance for reuse, avoiding the need for "new" or "delete".

Definition at line 43 of file Analysis.cpp.

References _is_scaled, _needs_collection, _results, analysis_specific_reset(), and Gambit::ColliderBit::AnalysisData::clear().

Referenced by ~Analysis().

    {
      _is_scaled = false;
      _needs_collection = true;
      _results.clear();
      analysis_specific_reset();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

run()

virtual void Gambit::ColliderBit::Analysis::run ( const HEPUtils::Event *  )

protectedpure virtual

Referenced by analyze(), and ~Analysis().

Here is the caller graph for this function:

scale()

void Gambit::ColliderBit::Analysis::scale

(

double

xsec_per_event

)

Scale by xsec per event.

Definition at line 133 of file Analysis.cpp.

References _is_scaled, _results, and luminosity().

Referenced by ~Analysis().

    {
      double factor = luminosity() * xsec_per_event;
      assert(factor >= 0);
      for (SignalRegionData& sr : _results)
      {
        sr.n_sig_scaled = factor * sr.n_sig_MC;
      }
      _is_scaled = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set_analysis_name()

void Gambit::ColliderBit::Analysis::set_analysis_name

(

str

aname

)

Set the analysis name.

Definition at line 68 of file Analysis.cpp.

References _analysis_name, _results, and Gambit::ColliderBit::AnalysisData::analysis_name.

Referenced by ~Analysis().

    {
      _analysis_name = aname;
      _results.analysis_name = _analysis_name;
    }

Here is the caller graph for this function:

set_covariance() [1/2]

void Gambit::ColliderBit::Analysis::set_covariance ( const Eigen::MatrixXd &  srcov )

protected

Set the covariance matrix, expressing SR correlations.

Definition at line 116 of file Analysis.cpp.

References _results, and Gambit::ColliderBit::AnalysisData::srcov.

Referenced by set_covariance(), and ~Analysis().

{ _results.srcov = srcov; }

Here is the caller graph for this function:

set_covariance() [2/2]

void Gambit::ColliderBit::Analysis::set_covariance ( const std::vector< std::vector< double >> &  srcov )

protected

A convenience function for setting the SR covariance from a nested vector/initialiser list.

Definition at line 119 of file Analysis.cpp.

References set_covariance().

    {
      Eigen::MatrixXd cov(srcov.size(), srcov.front().size());
      for (size_t i = 0; i < srcov.size(); ++i)
      {
        for (size_t j = 0; j < srcov.front().size(); ++j)
        {
          cov(i,j) = srcov[i][j];
        }
      }
      set_covariance(cov);
    }

Here is the call graph for this function:

set_luminosity()

void Gambit::ColliderBit::Analysis::set_luminosity

(

double

lumi

)

Set the integrated luminosity.

Definition at line 65 of file Analysis.cpp.

References _luminosity, and _luminosity_is_set.

Referenced by ~Analysis().

{ _luminosity_is_set = true; _luminosity = lumi; }

Here is the caller graph for this function:

Member Data Documentation

_analysis_name

std::string Gambit::ColliderBit::Analysis::_analysis_name

private

Definition at line 118 of file Analysis.hpp.

Referenced by analysis_name(), get_results(), and set_analysis_name().

_is_scaled

bool Gambit::ColliderBit::Analysis::_is_scaled

private

Definition at line 115 of file Analysis.hpp.

Referenced by get_results(), reset(), and scale().

_luminosity

double Gambit::ColliderBit::Analysis::_luminosity

private

Definition at line 113 of file Analysis.hpp.

Referenced by luminosity(), and set_luminosity().

_luminosity_is_set

bool Gambit::ColliderBit::Analysis::_luminosity_is_set

private

Definition at line 114 of file Analysis.hpp.

Referenced by get_results(), and set_luminosity().

_needs_collection

bool Gambit::ColliderBit::Analysis::_needs_collection

private

Definition at line 116 of file Analysis.hpp.

Referenced by analyze(), get_results(), and reset().

_results

AnalysisData Gambit::ColliderBit::Analysis::_results

private

Definition at line 117 of file Analysis.hpp.

Referenced by add(), add_result(), get_results(), reset(), scale(), set_analysis_name(), and set_covariance().

---

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

• ColliderBit/include/gambit/ColliderBit/analyses/Analysis.hpp
• ColliderBit/src/analyses/Analysis.cpp