observable_base.py

################################################################################
#
#  Copyright (C) 2012-2022 Jack Araz, Eric Conte & Benjamin Fuks
#  The MadAnalysis development team, email: <ma5team@iphc.cnrs.fr>
#
#  This file is part of MadAnalysis 5.
#  Official website: <https://github.com/MadAnalysis/madanalysis5>
#
#  MadAnalysis 5 is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  MadAnalysis 5 is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with MadAnalysis 5. If not, see <http://www.gnu.org/licenses/>
#
################################################################################


from __future__ import absolute_import
from madanalysis.enumeration.ma5_running_type import MA5RunningType


class ObservableBase:
    def __init__(
        self,
        name,
        args,
        combination,
        plot_auto,
        plot_nbins,
        plot_xmin,
        plot_xmax,
        plot_unitX_tlatex,
        plot_unitX_latex,
        code_parton,
        code_hadron,
        code_reco,
        cut_event,
        cut_candidate,
        tlatex,
        latex,
    ):
        self.name = name
        self.args = args
        self.plot_auto = plot_auto
        self.plot_nbins = plot_nbins
        self.plot_xmin = plot_xmin
        self.plot_xmax = plot_xmax
        self.plot_unitX_tlatex = plot_unitX_tlatex
        self.plot_unitX_latex = plot_unitX_latex
        self.code_parton = code_parton
        self.code_hadron = code_hadron
        self.code_reco = code_reco
        self.cut_event = cut_event
        self.cut_candidate = cut_candidate
        self.combination = combination
        self.tlatex = tlatex
        self.latex = latex

    def code(self, level):
        if level == MA5RunningType.PARTON:
            return self.code_parton
        elif level == MA5RunningType.HADRON:
            return self.code_hadron
        elif level == MA5RunningType.RECO:
            return self.code_reco
        else:
            return None

    @staticmethod
    def Clone(
        obs,
        name=None,
        args=None,
        combination=None,
        plot_auto=None,
        plot_nbins=None,
        plot_xmin=None,
        plot_xmax=None,
        plot_unitX_tlatex=None,
        plot_unitX_latex=None,
        code_parton=None,
        code_hadron=None,
        code_reco=None,
        cut_event=None,
        cut_candidate=None,
        tlatex=None,
        latex=None,
    ):

        # create clone of obs
        newobs = ObservableBase(
            obs.name,
            obs.args,
            obs.combination,
            obs.plot_auto,
            obs.plot_nbins,
            obs.plot_xmin,
            obs.plot_xmax,
            obs.plot_unitX_tlatex,
            obs.plot_unitX_latex,
            obs.code_parton,
            obs.code_hadron,
            obs.code_reco,
            obs.cut_event,
            obs.cut_candidate,
            obs.tlatex,
            obs.latex,
        )

        # replace
        if name is not None:
            newobs.name = name
        if args is not None:
            newobs.args = args
        if combination is not None:
            newobs.combination = combination
        if plot_auto is not None:
            newobs.plot_auto = plot_auto
        if plot_nbins is not None:
            newobs.plot_nbins = plot_nbins
        if plot_xmin is not None:
            newobs.plot_xmin = plot_xmin
        if plot_xmax is not None:
            newobs.plot_xmax = plot_xmax
        if plot_unitX_tlatex is not None:
            newobs.plot_unitX_tlatex = plot_unitX_tlatex
        if plot_unitX_latex is not None:
            newobs.plot_unitX_tlatex = plot_unitX_latex
        if code_parton is not None:
            newobs.code_parton = code_parton
        if code_hadron is not None:
            newobs.code_hadron = code_hadron
        if code_reco is not None:
            newobs.code_reco = code_reco
        if cut_event is not None:
            newobs.cut_event = cut_event
        if cut_candidate is not None:
            newobs.cut_candidate = cut_candidate
        if tlatex is not None:
            newobs.tlatex = tlatex
        if latex is not None:
            newobs.latex = latex

        # return the clone
        return newobs