FunTuple.functions

Functions

FunTuple_Particles(*args, **kwargs)

Wrapper function for FunTupleBase_Particles.

FunTuple_MCParticles(*args, **kwargs)

Wrapper function for FunTupleBase_MCParticles.

FunTuple_Composites(*args, **kwargs)

Wrapper function for FunTupleBase_Composites.

FunTuple_ChargedBasics(*args, **kwargs)

Wrapper function for FunTupleBase_Composites.

FunTuple_Event(name, tuple_name[, variables, ...])

Wrapper function for FunTupleEventBase.

Module Contents

FunTuple_Particles(*args, **kwargs)[source]

Wrapper function for FunTupleBase_Particles.

Parameters:

  • name (string) – Name of Algorithm

  • tuple_name (string) – Name of the TTree.

  • fields (dict) – Dictionary of {field (branch) name : decay descriptor}. The field name is used in naming the variable in the ntuple and decay descriptor in finding the candidates.

  • variables (dict) – Dictionary of {variable name: Functor code}. The variable name is used in naming the variable in nTuple (for a given field) and functor code used to retrieve ThOr functors.

  • event_variables (FunctorCollection) – FunctorCollection of {variable name: Functor code} for event quantities to be added to every candidate.

  • inputs (PyConf DataHandle) – Input location of LHCb::Particles to run over.

  • run_full_counter_mode (bool) – A boolean to set counters and monitor each of the fields.

  • use_loki_decay_finder (bool) – A boolean to use the LoKi DecayFinder to find the candidates instead of the new run-3 DecayFinder.

  • store_run_event_numbers (bool) – A boolean to store the runnumber and evtnumber in the ntuple. Default is True.

  • **kwargs – extra arguments like OutputLevel (inherited from Gaudi Algorithms) or thor_preamble (which is list of extra header files to be included when instantiating ThOr functors, usage need to be known)

Returns:

FunTuple PyConf algorithm corresponding to LHCb::Particles as input

FunTuple_MCParticles(*args, **kwargs)[source]

Wrapper function for FunTupleBase_MCParticles.

Parameters:

  • name (string) – Name of Algorithm

  • tuple_name (string) – Name of the TTree.

  • fields (dict) – Dictionary of {field (branch) name : decay descriptor}. The field name is used in naming the variable in the ntuple and decay descriptor in finding the candidates.

  • variables (dict) – Dictionary of {variable name: Functor code}. The variable name is used in naming the variable in nTuple (for a given field) and functor code used to retrieve ThOr functors.

  • event_variables (FunctorCollection) – FunctorCollection of {variable name: Functor code} for event quantities to be added to every candidate.

  • inputs (PyConf DataHandle) – Input location of LHCb::MCParticles to run over.

  • run_full_counter_mode (bool) – A boolean to set counters and monitor each of the fields.

  • use_loki_decay_finder (bool) – A boolean to use the LoKi DecayFinder to find the candidates instead of the new run-3 DecayFinder.

  • **kwargs – extra arguments like OutputLevel (inherited from Gaudi Algorithms) or thor_preamble (which is list of extra header files to be included when instantiating ThOr functors, usage need to be known)

Returns:

FunTuple PyConf algorithm corresponding to LHCb::MCParticles as input

FunTuple_Composites(*args, **kwargs)[source]

Wrapper function for FunTupleBase_Composites.

Parameters:

  • name (string) – Name of Algorithm

  • tuple_name (string) – Name of the TTree.

  • fields (dict) – Dictionary of {field (branch) name : decay descriptor}. The field name is used in naming the variable in the ntuple and decay descriptor in finding the candidates.

  • variables (dict) – Dictionary of {variable name: Functor code}. The variable name is used in naming the variable in nTuple (for a given field) and functor code used to retrieve ThOr functors.

  • event_variables (FunctorCollection) – FunctorCollection of {variable name: Functor code} for event quantities to be added to every candidate.

  • inputs (PyConf DataHandle) – Input location of LHCb::Event::Composites to run over.

  • run_full_counter_mode (bool) – A boolean to set counters and monitor each of the fields.

  • store_run_event_numbers (bool) – A boolean to store the runnumber and evtnumber in the ntuple. Default is True.

  • **kwargs – extra arguments like OutputLevel (inherited from Gaudi Algorithms) or thor_preamble (which is list of extra header files to be included when instantiating ThOr functors, usage need to be known)

Returns:

FunTuple PyConf algorithm corresponding to LHCb::Event::Composites as input

FunTuple_ChargedBasics(*args, **kwargs)[source]

Wrapper function for FunTupleBase_Composites.

Parameters:

  • tuple_name (string) – Name of the TTree.

  • fields (dict) – Dictionary of {field (branch) name : decay descriptor}. The field name is used in naming the variable in the ntuple and decay descriptor in finding the candidates.

  • variables (dict) – Dictionary of {variable name: Functor code}. The variable name is used in naming the variable in nTuple (for a given field) and functor code used to retrieve ThOr functors.

  • event_variables (FunctorCollection) – FunctorCollection of {variable name: Functor code} for event quantities to be added to every candidate.

  • inputs (PyConf DataHandle) – Input location of LHCb::Event::Composites to run over.

  • run_full_counter_mode (bool) – A boolean to set counters and monitor each of the fields.

  • store_run_event_numbers (bool) – A boolean to store the runnumber and evtnumber in the ntuple. Default is True.

  • **kwargs – extra arguments like OutputLevel (inherited from Gaudi Algorithms) or thor_preamble (which is list of extra header files to be included when instantiating ThOr functors, usage need to be known)

Returns:

FunTuple PyConf algorithm corresponding to LHCb::Event::Composites as input

FunTuple_Event(name, tuple_name, variables=None, store_run_event_numbers=True, **kwargs)[source]

Wrapper function for FunTupleEventBase.

Parameters:

  • name (string) – Name of Algorithm

  • tuple_name (string) – Name of the TTree.

  • variables (dict, optional) – Dictionary of {variable name: Event-level functor code}. The variable name is used in naming the variable in the nTuple and event-level functor code used to retrieve ThOr functors. Defaults to None.

  • store_run_event_numbers (bool, optional) – A boolean to store the run and event numbers in the ntuple. Defaults to True.

  • **kwargs – extra arguments like OutputLevel (inherited from Gaudi Algorithms).

Returns:

FunTupleEvent PyConf algorithm.