Welcome to SAGA’s documentation

SAGA is a dual Python and C++ project for performing Spin Asymmetry Generic Analyses. It uses ROOT’s RDataFrame structure to read your data from ROOT TTrees and ROOT’s RooFit libraries to perform invariant mass signal and background fits and the asymmetry fits. The project provides background correction via sideband subtraction or sPlots and has many other useful functionalities for running your spin asymmetry analysis.

Note

This project is under active development.

Contents

• Spin Asymmetry Generic Analysis (SAGA)
  • Install from source
    • Prerequisites
    • C++ Libraries
    • Python3 Modules
  • Containerized Installation
    • Docker
    • Apptainer/Singularity
    • Environment
  • Documentation
    • Building the Documentation
  • Getting Started
  • Running an Analysis
    • Design Philosophy
    • Examining Kinematics
    • Binning
    • Bin Migration
    • Invariant Mass Signal + Background Fits
      • Background Correction
        • Sideband Subtraction
        • sPlots
    • Fitting Asymmetries
      • The Helicity Balance Method
    • Injecting Asymmetries
    • Scaling MC for Future Experiments
• C++ API
  • saga
    • saga::analysis
      • RNode
      • getSubRooArgSet()
      • getSubFormula()
      • getGenAsymPdf()
      • fitAsym()
      • getKinBinnedAsym()
    • saga::bins
      • findBinLims()
      • findNestedBinLims()
      • getBinLims()
      • setNestedBinCuts()
      • getBinCuts()
      • getBinCutsMap()
      • getBinSchemesVars()
      • getBinCutsMapBatch()
      • getBinMigration()
      • getBinKinematics()
      • saveTH1ToCSV()
      • getBinKinematicsTH1Ds()
      • getBinKinematicsTH2Ds()
    • saga::data
      • RNode
      • createDataset()
      • mapDataFromCSV()
      • initializeTRandom()
      • injectAsym()
      • bootstrapPoisson()
      • bootstrapClassical()
      • get_weighted_count()
      • get_weighted_mean()
      • get_weighted_stddev()
      • defineAngularDiffVars()
    • saga::hbanalysis
      • RNode
      • fitHB()
      • getKinBinnedHB()
    • saga::log
      • saga::log::Logger
    • saga::resolution
      • RNode
      • fitResolution()
      • getKinBinnedResolutions()
    • saga::signal
      • RNode
      • getGenMassPdf()
      • fitMass()
      • applySPlot()
      • getBinnedBGFractionsDataset()
      • setBinnedBGFractions()
    • saga::util
      • getYamlArg()
      • replaceAll()
      • addLimitCuts()
• Python API
  • Module list
    • saga.orchestrate
      • create_jobs()
      • submit_jobs()
    • saga.aggregate
      • add_cut_array()
      • apply_bin_mig()
      • compute_systematics()
      • get_aggregate_graph()
      • get_bin_mig_mat()
      • get_binscheme_cuts_and_ids()
      • get_config_list()
      • get_config_out_path()
      • get_config_str()
      • get_cut_array()
      • get_graph_array()
      • get_graph_data()
      • get_nested_scheme_shape()
      • get_out_dirs_list()
      • get_out_file_name()
      • get_projection_ids()
      • get_scheme_vars()
      • get_subset()
      • offset_graph_x()
      • reshape_nested_grid()
      • set_nested_bin_cuts()
    • saga.data
      • load_csv()
      • load_th1()
      • load_yaml()
      • save_bin_mig_mat_to_csv()
      • save_graph_systematics_to_csv()
      • save_graph_to_csv()
      • save_txt()
    • saga.rescale
      • rescale_csv_data()
      • rescale_graph_data()
    • saga.plot
      • get_bin_centers()
      • get_bin_kinematics_title()
      • get_lims_coords()
      • plot_bin_ids()
      • plot_hists()
      • plot_injected_asyms()
      • plot_label()
      • plot_lines()
      • plot_results()
      • plot_results_array()
      • plot_systematics()
      • plot_th2()
      • plot_vlines()
      • plot_watermark()
      • set_default_plt_settings()