class Gambit::ColliderBit::Analysis

A class for collider analyses within ColliderBit.

#include <Analysis.hpp>

Public Functions

	Name
void	analyze(const HEPUtils::Event & e) Analyze the event (accessed by reference).
void	analyze(const HEPUtils::Event * e) Analyze the event (accessed by pointer).
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.
	Analysis() Construction.
virtual	~Analysis() Destruction.
void	reset() Public method to reset this instance for reuse, avoiding the need for “new” or “delete”.
double	luminosity() const Return the integrated luminosity.
void	set_luminosity(double lumi) Set the integrated luminosity.
void	set_analysis_name(str aname) Set the analysis name.
str	analysis_name() Get the analysis name.
void	set_detector_name(str detname) Set the detector name.
str	detector_name() Get the detector name.
void	set_collider_name(str collname) Set the collider name.
str	collider_name() Get the collider name.
const AnalysisData &	get_results() Get the collection of SignalRegionData for likelihood computation.
const AnalysisData &	get_results(str & warning) An overload of get_results() with some additional consistency checks.
AnalysisData *	get_results_ptr() Get a (non-const!) pointer to _results.
AnalysisData *	get_results_ptr(str & warning) An overload of get_results_ptr() with some additional consistency checks.
const Cutflows &	get_cutflows() Get the cutflows.
void	scale(double xsec_per_event) Scale by xsec per event.
void	set_store_accepted_event_IDs(bool setting) Set the store_accepted_event_IDs bool for the EventCounter instances in this analysis.
void	addCuts(std::vector< std::string > & )
template <typename First ,typename… Rest> void	addCuts(std::vector< std::string > & v, First && first, Rest &&… rest)
template <typename… Cuts> void	defineSignalRegion(const std::string & name, Cuts &&… cuts)
template <typename… Cuts> void	defineSignalRegions(const std::string & baseName, int count, const Cuts &… cuts)

Protected Functions

	Name
virtual void	run(const HEPUtils::Event * ) =0
void	add_result(const SignalRegionData & sr) Add the given result to the internal results list.
void	add_cutflows(const Cutflows & cf) Add cutflows to the internal results list.
void	set_covariance(const Eigen::MatrixXd & srcov) Set the covariance matrix, expressing SR correlations.
void	set_covariance(const std::vector< std::vector< double > > & srcov) A convenience function for setting the SR covariance from a nested vector/initialiser list.
void	set_bkgjson(const std::string & bkgpath) A convenience function for setting the path to the ATLAS FullLikes BKG Json file.
virtual void	collect_results() =0 Gather together the info for likelihood calculation.
virtual void	analysis_specific_reset() =0 Reset the analysis-specific variables.

Protected Attributes

	Name
Cutflows	_cutflows
std::map< str, EventCounter > &	_counters

Public Functions Documentation

function analyze

void analyze(
    const HEPUtils::Event & e
)

Analyze the event (accessed by reference).

function analyze

void analyze(
    const HEPUtils::Event * e
)

Analyze the event (accessed by pointer).

function add

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.

TodoAccess by name, including merging disjoint region sets?

function Analysis

Analysis()

Construction.

function ~Analysis

inline virtual ~Analysis()

Destruction.

function reset

void reset()

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

function luminosity

double luminosity() const

Return the integrated luminosity.

function set_luminosity

void set_luminosity(
    double lumi
)

Set the integrated luminosity.

function set_analysis_name

void set_analysis_name(
    str aname
)

Set the analysis name.

function analysis_name

str analysis_name()

Get the analysis name.

function set_detector_name

void set_detector_name(
    str detname
)

Set the detector name.

function detector_name

str detector_name()

Get the detector name.

function set_collider_name

void set_collider_name(
    str collname
)

Set the collider name.

function collider_name

str collider_name()

Get the collider name.

function get_results

const AnalysisData & get_results()

Get the collection of SignalRegionData for likelihood computation.

function get_results

const AnalysisData & get_results(
    str & warning
)

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

function get_results_ptr

AnalysisData * get_results_ptr()

Get a (non-const!) pointer to _results.

function get_results_ptr

AnalysisData * get_results_ptr(
    str & warning
)

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

function get_cutflows

const Cutflows & get_cutflows()

Get the cutflows.

function scale

void scale(
    double xsec_per_event
)

Scale by xsec per event.

function set_store_accepted_event_IDs

void set_store_accepted_event_IDs(
    bool setting
)

Set the store_accepted_event_IDs bool for the EventCounter instances in this analysis.

function addCuts

inline void addCuts(
    std::vector< std::string > & 
)

function addCuts

template <typename First ,
typename... Rest>
inline void addCuts(
    std::vector< std::string > & v,
    First && first,
    Rest &&... rest
)

function defineSignalRegion

template <typename... Cuts>
inline void defineSignalRegion(
    const std::string & name,
    Cuts &&... cuts
)

function defineSignalRegions

template <typename... Cuts>
inline void defineSignalRegions(
    const std::string & baseName,
    int count,
    const Cuts &... cuts
)

Define multiple signal regions that share a common name and only vary on sequential numbering

Protected Functions Documentation

function run

virtual void run(
    const HEPUtils::Event * 
) =0

function add_result

void add_result(
    const SignalRegionData & sr
)

Add the given result to the internal results list.

function add_cutflows

void add_cutflows(
    const Cutflows & cf
)

Add cutflows to the internal results list.

function set_covariance

void set_covariance(
    const Eigen::MatrixXd & srcov
)

Set the covariance matrix, expressing SR correlations.

function set_covariance

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

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

function set_bkgjson

void set_bkgjson(
    const std::string & bkgpath
)

A convenience function for setting the path to the ATLAS FullLikes BKG Json file.

Set the path to the FullLikes BKG file.

function collect_results

virtual void collect_results() =0

Gather together the info for likelihood calculation.

function analysis_specific_reset

virtual void analysis_specific_reset() =0

Reset the analysis-specific variables.

Protected Attributes Documentation

variable _cutflows

Cutflows _cutflows;

variable _counters

std::map< str, EventCounter > & _counters;

Updated on 2026-11-03 at 14:50:42 +0000

class Gambit::ColliderBit::Analysis #

Public Functions #

Protected Functions #

Protected Attributes #

Public Functions Documentation #

function analyze #

function analyze #

function add #

function Analysis #

function ~Analysis #

function reset #

function luminosity #

function set_luminosity #

function set_analysis_name #

function analysis_name #

function set_detector_name #

function detector_name #

function set_collider_name #

function collider_name #

function get_results #

function get_results #

function get_results_ptr #

function get_results_ptr #

function get_cutflows #

function scale #

function set_store_accepted_event_IDs #

function addCuts #

function addCuts #

function defineSignalRegion #

function defineSignalRegions #

Protected Functions Documentation #

function run #

function add_result #

function add_cutflows #

function set_covariance #

function set_covariance #

function set_bkgjson #

function collect_results #

function analysis_specific_reset #

Protected Attributes Documentation #

variable _cutflows #

variable _counters #

class Gambit::ColliderBit::Analysis

Public Functions

Protected Functions

Protected Attributes

Public Functions Documentation

function analyze

function analyze

function add

function Analysis

function ~Analysis

function reset

function luminosity

function set_luminosity

function set_analysis_name

function analysis_name

function set_detector_name

function detector_name

function set_collider_name

function collider_name

function get_results

function get_results

function get_results_ptr

function get_results_ptr

function get_cutflows

function scale

function set_store_accepted_event_IDs

function addCuts

function addCuts

function defineSignalRegion

function defineSignalRegions

Protected Functions Documentation

function run

function add_result

function add_cutflows

function set_covariance

function set_covariance

function set_bkgjson

function collect_results

function analysis_specific_reset

Protected Attributes Documentation

variable _cutflows

variable _counters