logo

basf2 light-2212-foldex documentation
  • 1. What’s New
  • 2. Installation and Setup
    • 2.1. Setup of the Belle II Software
    • 2.2. Belle II Software Tools
    • 2.3. Local Installation
  • 3. Beginners’ tutorials
    • 3.1. Welcome!
      • 3.1.1. Collaborative Tools.
    • 3.2. Fundamentals
      • 3.2.1. Introduction
      • 3.2.2. Data Taking
      • 3.2.3. Simulation: The Monte Carlo
      • 3.2.4. Reconstruction
      • 3.2.5. Analysis
    • 3.3. Software Prerequisites
      • 3.3.1. Command Line Tutorial (Bash)
      • 3.3.2. SSH - Secure Shell
      • 3.3.3. Python
      • 3.3.4. Version Control with Git
    • 3.4. Working with Belle II software.
      • 3.4.1. The basics.
      • 3.4.2. First steering file
      • 3.4.3. The Rest of Event (ROE)
      • 3.4.4. Various additions
      • 3.4.5. Flavor tagging
      • 3.4.6. Vertex fitting
      • 3.4.7. Event display
      • 3.4.8. Generating Monte Carlo
      • 3.4.9. Full Event Interpretation
      • 3.4.10. Continuum Suppression (CS)
      • 3.4.11. B2BII
      • 3.4.12. Skimming
      • 3.4.13. A simple python module
    • 3.5. Offline analysis
      • 3.5.1. ROOT
      • 3.5.2. Pandas
      • 3.5.3. Fitting
      • 3.5.4. Reproducibility
      • 3.5.5. Topology analysis
    • 3.6. Data model and computing
      • 3.6.1. Analysis model
      • 3.6.2. The computing system
      • 3.6.3. Gbasf2
      • 3.6.4. Batch submission
      • 3.6.5. htcondor
    • 3.7. Join us
      • 3.7.1. We want YOU to contribute to this book!
      • 3.7.2. How to contribute
  • 4. Command Line Tools
    • 4.1. basf2 : The Main Belle2 Software Executable
    • 4.2. Tools for file handling
    • 4.3. Testing Tools
    • 4.4. Tools which will provide you help
    • 4.5. Tools to help with debugging and checking code quality
    • 4.6. b2conditionsdb : Conditions DB interface
    • 4.7. Tools for luminosity
  • 5. Belle II Python Interface
    • 5.1. Modules and Paths
    • 5.2. Logging
    • 5.3. Module Statistics
    • 5.4. Conditions Database
    • 5.5. Additional Functions
    • 5.6. Other Modules
      • 5.6.1. basf2.utils - Helper functions for printing basf2 objects
      • 5.6.2. basf2.pickle_path - Functions necessary to pickle and unpickle a Path
      • 5.6.3. B2Tools
      • 5.6.4. b2test_utils - Helper functions useful for test scripts
      • 5.6.5. conditions_db
      • 5.6.7. hep_ipython_tools
      • 5.6.8. iov_conditional - Functions to Execute Paths Depending on Experiment Phases
      • 5.6.9. pdg - access particle definitions
      • 5.6.10. rundb - Helper classes for retrieving information from the RunDB
      • 5.6.11. terminal_utils - Helper functions for input from/output to a terminal
  • 6. List of Core Modules
  • 7. Analysis
    • 7.1. Particles
      • 7.1.1. Standard Particles
      • 7.1.2. DecayString
      • 7.1.3. Cut strings and selections
    • 7.2. Modular analysis convenience functions
      • 7.2.1. ModularAnalysis
      • 7.2.2. Photon functions
    • 7.3. Variables
    • 7.4. Output for offline analysis
      • 7.4.1. Variable Manager Output
      • 7.4.2. (Advanced) user mDST files
    • 7.5. Vertex (and kinematic) fitting
      • 7.5.1. Tree Fitter
      • 7.5.2. Other vertex (and kinematic) fitters in basf2
      • 7.5.3. Vertex-fitting convenience functions
      • 7.5.4. Kinematic-fitting convenience functions
    • 7.6. Event based analysis
    • 7.7. Truth-matching
    • 7.8. Advanced Topics
      • 7.8.1. Rest Of Event
      • 7.8.2. How to Veto
      • 7.8.3. Flavor Tagger
      • 7.8.4. Deep Flavor Tagger
      • 7.8.5. Full event interpretation
      • 7.8.6. EventShape
      • 7.8.7. Continuum suppression
      • 7.8.8. Basf2 MVA interface
      • 7.8.9. PID Prior Probabilities
      • 7.8.10. ksSelector
      • 7.8.11. PID Calibration Weights
      • 7.8.12. Signal Embedding
    • 7.9. Full list of analysis modules
  • 8. B2BII
    • 8.1. Overview
    • 8.2. B2BII Analysis
    • 8.3. Converted data objects and other information
    • 8.4. Belle MDST samples
    • 8.5. FAQ
    • 8.6. b2bii functions
  • 9. Belle II File Format
  • 10. MVA package
  • 11. Skims
    • 11.1. Systematics skims
    • 11.2. Physics skims
    • 11.3. Standard skim lists
    • 11.4. Information for skim experts
  • 12. Software development
    • 12.1. How to write basf2 code (coding conventions)
    • 12.2. Updating the main globaltag
  • 13. How to document your code with Sphinx
    • 13.1. Documentation of Python Code
    • 13.2. Referencing Components
    • 13.3. Inserting Figures
    • 13.4. Documentation of Variables and Modules in C++
    • 13.5. Google Style Docstrings
    • 13.6. Add basf2 Modules Documentation to Sphinx
    • 13.7. Add basf2 Variables Documentation to Sphinx
    • 13.8. Additional Features
    • 13.9. Additional boxes for the online lessons
    • 13.10. How to test locally
    • 13.11. Previewing documentation changes in a pull request
Theme by the Executable Book Project
  • .rst

Other Modules

5.6. Other Modules#

There more tools available in the software framework which might not be of general interest to all users and are separated into different python modules:

  • 5.6.1. basf2.utils - Helper functions for printing basf2 objects
  • 5.6.2. basf2.pickle_path - Functions necessary to pickle and unpickle a Path
  • 5.6.3. B2Tools
  • 5.6.4. b2test_utils - Helper functions useful for test scripts
  • 5.6.5. conditions_db
  • 5.6.6. conditions_db.iov
  • 5.6.7. hep_ipython_tools
  • 5.6.8. iov_conditional - Functions to Execute Paths Depending on Experiment Phases
  • 5.6.9. pdg - access particle definitions
  • 5.6.10. rundb - Helper classes for retrieving information from the RunDB
  • 5.6.11. terminal_utils - Helper functions for input from/output to a terminal

previous

5.5. Additional Functions

next

5.6.1. basf2.utils - Helper functions for printing basf2 objects

By Belle II Software Group
© Copyright Belle II Collaboration.