multiplicityTable.py

Go to the documentation of this file.

#!/usr/bin/env python
# PYTHON_ARGCOMPLETE_OK
# -*- coding: utf-8 -*-
 
# Copyright 2019-2020 CERN and copyright holders of ALICE O2.
# See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
# All rights not expressly granted are reserved.
#
# This software is distributed under the terms of the GNU General Public
# License v3 (GPL Version 3), copied verbatim in the file "COPYING".
#
# In applying this license CERN does not waive the privileges and immunities
# granted to it by virtue of its status as an Intergovernmental Organization
# or submit itself to any jurisdiction.
 
# Orginal Task: https://github.com/AliceO2Group/O2Physics/blob/master/Common/TableProducer/multiplicityTable.cxx
 
import argparse
 
from argcomplete.completers import ChoicesCompleter
 
 
class MultiplicityTable(object):
    
    """
    Class for Interface -> multiplicityTable.cxx Task -> Configurable, Process Functions
 
    Args:
        object (parser_args() object): multiplicityTable.cxx Interface
    """
    
    def __init__(self, parserMultiplicityTable = argparse.ArgumentParser(add_help = False)):
        super(MultiplicityTable, self).__init__()
        self.parserMultiplicityTable = parserMultiplicityTable
    
    def addArguments(self):
        """
        This function allows to add arguments for parser_args() function
        """
        
        # Predefined Selections
        booleanSelections = ["true", "false"]
        
        # Interface
        groupMultiplicityTable = self.parserMultiplicityTable.add_argument_group(title = "Data processor options: multiplicity-table")
        groupMultiplicityTable.add_argument(
            "--isVertexZeq", help = "if true: do vertex Z eq mult table", action = "store", type = str.lower, choices = (booleanSelections),
            ).completer = ChoicesCompleter(booleanSelections)
    
    def parseArgs(self):
        """
        This function allows to save the obtained arguments to the parser_args() function
 
        Returns:
            Namespace: returns parse_args()
        """
        
        return self.parserMultiplicityTable.parse_args()