AnalysisG

Overview

Introduction
Installation

User Guide

Quick Start

Python Interface

Analysis (Python)
ParticleTemplate (Python)
EventTemplate (Python)
GraphTemplate (Python)
SelectionTemplate (Python)
MetricTemplate (Python)
- Properties
- Methods
ModelTemplate (Python)
- Properties
- C++ Interface (called from forward)
IO (Python)
Meta / AMI (Python)
Tools (Python)
- Methods
Notification (Python)
- C++ notification Interface
Plotting (Python)
ROC (Python)
- Properties
- Usage Example
OptimizerConfig (Python)
- Optimiser / Scheduler Selection
- Hyper-parameter Properties
Structs (Python)

Built-In Events

BSM 4-Tops Event (bsm_4tops)
- BSM4Tops
- Particle Classes
  - top
  - top_children
  - truthjet
  - truthjetparton
  - jet
  - jetparton
  - electron / muon
Experimental MC20 Event (exp_mc20)
- ExpMC20
- Particle Classes
  - Top
  - Child
  - PhysicsDetector / PhysicsTruth
  - Electron
  - Muon
  - Jet
GNN Inference Event (gnn)
- EventGNN
- Particle Classes
  - Top
  - ZPrime
Same-Sign Multi-Lepton MC20 Event (ssml_mc20)
- SSML_MC20
- Particle Classes
  - electron

Built-In Graphs

BSM 4-Tops Graphs (graphs.bsm_4tops)
Experimental MC20 Graphs (graphs.exp_mc20)
- Graph Classes
Same-Sign Multi-Lepton MC20 Graphs (graphs.ssml_mc20)
- Graph Classes

Built-In Models

Grift Model (models.grift)
- Grift
Recursive Graph Neural Network (models.RecursiveGraphNeuralNetwork)
- RecursiveGraphNeuralNetwork

Built-In Metrics

Accuracy Metric (metrics.accuracy)
- AccuracyMetric
  - Results
PageRank Metric (metrics.pagerank)
- PageRankMetric

Built-In Selections

Example MET Selection (selections.example.met)
- MET
Analysis Regions Selection (selections.analysis.regions)
- Regions
MC16 Children Kinematics (selections.mc16.childrenkinematics)
- ChildrenKinematics
MC16 Decay Modes (selections.mc16.decaymodes)
- DecayModes
MC16 Missing ET / Neutrino Reconstruction (selections.mc16.met)
- MissingET
MC16 Parton Energy Fractions (selections.mc16.parton)
- Parton
MC16 Top + Reconstructed-Jet Matching (selections.mc16.topjets)
- TopJets
MC16 Top Kinematic Distributions (selections.mc16.topkinematics)
- TopKinematics
MC16 Top-Quark Matching (selections.mc16.topmatching)
- TopMatching
MC16 Top + Truth-Jet Matching (selections.mc16.toptruthjets)
- TopTruthJets
MC16 Z′ Selection (selections.mc16.zprime)
- ZPrime
MC20 Truth Matching (selections.mc20.matching)
- TopMatching (MC20)
MC20 Top Kinematic Distributions (selections.mc20.topkinematics)
- TopKinematics
MC20 Top-Quark Matching (selections.mc20.topmatching)
- TopMatching
MC20 Z′ Selection (selections.mc20.zprime)
- ZPrime (MC20)
Combinatorial Neutrino Reconstruction (selections.neutrino.combinatorial)
- NuNuCombinatorial
Neutrino Reconstruction Validation (selections.neutrino.validation)
- Validation
Top Efficiency (selections.performance.topefficiency)
- TopEfficiency

C++ User Templates

Particle Template
- Class: particle_template
Event Template
- Class: event_template
Graph Template
- Struct: graph_t
  - Public Getter Templates (call from model_template::forward)
  - Public Data Fields
- Class: graph_template
Selection Template
- Class: selection_template
Metric Template
- Struct: metric_t
  - Public Method
- Class: metric_template
Model Template
- Class: model_template

C++ Framework

Analysis Module
- Class: analysis
Container Module
- Struct: entry_t
- Class: container
  - Public Fields
  - Public Methods
Sample Tracer Module
- Class: sampletracer
  - Public Fields
  - Public Methods
Data Loader / Generator
- Class: dataloader
Optimizer Module
- Class: optimizer
  - Public Fields
  - Public Methods
I/O Module
- Class: io
Meta Module
- Class: meta
Tools Module
- Class: tools
Notification Module
- Class: notification
Plotting Module
- Class: plotting
ROC Curve Module
- Struct: roc_t
- Class: roc
  - Public Methods
  - Public Fields
Loss Functions Module
- Class: lossfx
Metrics Module
- Struct: analytics_t
- Class: metrics
  - Public Fields
  - Public Methods
Structs and Enumerations
- Enumerations
  - data_enum
    - d
    - v_d
    - vv_d
    - vvv_d
    - f
    - v_f
    - vv_f
    - vvv_f
    - l
    - v_l
    - vv_l
    - vvv_l
    - i
    - v_i
    - vv_i
    - vvv_i
    - ull
    - v_ull
    - vv_ull
    - vvv_ull
    - b
    - v_b
    - vv_b
    - vvv_b
    - ui
    - v_ui
    - vv_ui
    - vvv_ui
    - c
    - v_c
    - vv_c
    - vvv_c
    - undef
    - unset
  - opt_enum
    - adam
    - adagrad
    - adamw
    - lbfgs
    - rmsprop
    - sgd
    - invalid_optimizer
  - mlp_init
  - loss_enum
  - scheduler_enum
  - graph_enum
  - mode_enum
  - particle_enum
    - index
    - pdgid
    - pt
    - eta
    - phi
    - energy
    - px
    - pz
    - py
    - mass
    - charge
    - is_b
    - is_lep
    - is_nu
    - is_add
    - pmc
    - pmu
- Core Data Structs
  - bsc_t
    - bsc_t()
    - ~bsc_t()
    - flush_buffer()
    - as_string()
    - scan_buffer()
    - root_type_translate()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - element()
    - flush_buffer()
    - flush_buffer()
    - vvv_ull
    - vvv_ui
    - vvv_d
    - vvv_l
    - vvv_f
    - vvv_i
    - vvv_b
    - vvv_c
    - vv_ull
    - vv_ui
    - vv_d
    - vv_l
    - vv_f
    - vv_i
    - vv_b
    - vv_c
    - v_ull
    - v_ui
    - v_d
    - v_l
    - v_f
    - v_i
    - v_b
    - v_c
    - ull
    - ui
    - d
    - l
    - f
    - i
    - b
    - c
    - index
    - clear
    - type
  - data_t
    - data_t()
    - ~data_t()
    - initialize()
    - flush()
    - next()
    - leaf_name
    - branch_name
    - tree_name
    - leaf_type
    - path
    - fname
    - leaf
    - branch
    - tree
    - file
    - file_index
    - files_s
    - files_i
    - files_t
  - element_t
    - next()
    - set_meta()
    - boundary()
    - get()
    - tree
    - event_index
    - filename
    - handle
  - write_t
    - process()
    - write()
    - create()
    - close()
    - file
    - tree
    - mtx
    - data
  - writer
- Event, Particle, and Graph Payload Structs
- Settings and Configuration Structs
  - settings_t
  - model_settings_t
  - loss_opt
    - fx
    - mean
    - sum
    - none
    - swap
    - full
    - batch_mean
    - target
    - zero_inf
    - defaults
    - ignore
    - blank
    - margin
    - beta
    - eps
    - smoothing
    - delta
    - weight
  - optimizer_params_t
- Meta Structs
  - meta_t
  - weights_t
- Training Report Structs
  - model_report
    - print()
    - prx()
    - k
    - epoch
    - is_complete
    - waiting_plot
    - current_lr
    - loss_graph
    - loss_node
    - loss_edge
    - accuracy_graph
    - accuracy_node
    - accuracy_edge
    - run_name
    - mode
    - iters
    - num_evnt
    - progress
  - roc_t
    - cls
    - kfold
    - model
    - _auc
    - tpr_
    - fpr_
    - truth
    - scores
Type Casting Utilities

Neutrino Solutions (NuSol)

Neutrino Solution (NuSol) Module
- Entry Point
  - nusol_enum
  - nusol_t
    - met
    - phi
    - mt
    - mw
    - violation
    - limit
    - iterations
    - mode
    - targets
    - phys_pairs
  - nusol
- Ellipse Utilities
  - mtx
    - mtx()
    - mtx()
    - mtx()
    - mtx()
    - ~mtx()
    - trace()
    - det()
    - copy()
    - copy()
    - copy()
    - assign()
    - unique()
    - cat()
    - slice()
    - eigenvalues()
    - eigenvector()
    - T()
    - inv()
    - cof()
    - diag()
    - dot()
    - dot()
    - cross()
    - cross()
    - valid()
    - print()
    - operator=()
    - m_00()
    - m_01()
    - m_02()
    - m_10()
    - m_11()
    - m_12()
    - m_20()
    - m_21()
    - m_22()
    - _m
    - _b
    - dim_i
    - dim_j
    - tol
- Constrained Neutrino Solutions
- ODE Runge–Kutta Multi-Neutrino Solver
  - odeRK
  - ellipse_t
    - print()
    - A
    - B
    - C
    - vA
    - vB
    - vC
    - t
    - z
  - recon_t
    - is_valid
    - residual
    - t
    - z
    - phi

pyc — CUDA Extensions

pyc Interface
Physics Kernels
- Cartesian – Separate Inputs
  - pyc::physics::cartesian::separate
    - P2()
    - P()
    - Beta2()
    - Beta()
    - M2()
    - M()
    - Mt2()
    - Mt()
    - Theta()
    - DeltaR()
- Cartesian – Combined Input
  - pyc::physics::cartesian::combined
    - P2()
    - P()
    - Beta2()
    - Beta()
    - M2()
    - M()
    - Mt2()
    - Mt()
    - Theta()
    - DeltaR()
- Polar – Separate Inputs
  - pyc::physics::polar::separate
    - P2()
    - P()
    - Beta2()
    - Beta()
    - M2()
    - M()
    - Mt2()
    - Mt()
    - Theta()
    - DeltaR()
- Polar – Combined Input
  - pyc::physics::polar::combined
    - P2()
    - P()
    - Beta2()
    - Beta()
    - M2()
    - M()
    - Mt2()
    - Mt()
    - Theta()
    - DeltaR()
- Internal Kernel Namespace
  - physics_
    - P2()
    - P2()
    - P()
    - P()
    - Beta2()
    - Beta2()
    - Beta()
    - Beta()
    - M2()
    - M2()
    - M()
    - M()
    - Mt2()
    - Mt2()
    - Mt()
    - Mt()
    - Theta()
    - Theta()
    - DeltaR()
    - DeltaR()
Coordinate Transforms
- Separate Column Inputs
  - pyc::transform::separate
    - Pt()
    - Eta()
    - Phi()
    - PtEtaPhi()
    - PtEtaPhiE()
    - Px()
    - Py()
    - Pz()
    - PxPyPz()
    - PxPyPzE()
- Combined Stacked Input
  - pyc::transform::combined
    - Pt()
    - Eta()
    - Phi()
    - PtEtaPhi()
    - PtEtaPhiE()
    - Px()
    - Py()
    - Pz()
    - PxPyPz()
    - PxPyPzE()
- Internal Kernel Namespace
  - transform_
    - Px()
    - Py()
    - Pz()
    - PxPyPz()
    - PxPyPzE()
    - PxPyPz()
    - PxPyPzE()
    - Pt()
    - PtEta()
    - Phi()
    - Phi()
    - Eta()
    - Eta()
    - PtEtaPhi()
    - PtEtaPhiE()
    - PtEtaPhi()
    - PtEtaPhiE()
Graph Operations
- pyc::graph Functions
  - pyc::graph
- Internal Kernel Namespace
  - graph_
Tensor Operators
- pyc::operators Functions
  - pyc::operators
    - Dot()
    - CosTheta()
    - SinTheta()
    - Rx()
    - Ry()
    - Rz()
    - RT()
    - CoFactors()
    - Determinant()
    - Inverse()
    - Eigenvalue()
    - Cross()
- Internal Kernel Namespace
  - operators_
    - Dot()
    - Cross()
    - Determinant()
    - CosTheta()
    - SinTheta()
    - Pi_2()
    - Rx()
    - Ry()
    - Rz()
    - RT()
    - CoFactors()
    - Inverse()
    - Eigenvalue()
Neutrino Reconstruction (pyc)
- pyc::nusol Functions
- nusol_ Internal Namespace
  - pyc::nusol
  - nusol_
C Utilities (cutils)

About

Changelog
- Version 1.0

AnalysisG

Changelog

Changelog

Version 1.0

Initial public release of AnalysisG.
C++/CUDA core with Cython bindings.
Full Doxygen + Breathe + Sphinx documentation pipeline.
Read the Docs integration.

Previous

© Copyright 2024, AnalysisG Contributors.

Built with Sphinx using a theme provided by Read the Docs.