ROEVariables.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <analysis/VariableManager/Manager.h>
 
#include <analysis/dataobjects/RestOfEvent.h>
 
#include <Math/Vector4D.h>
 
#include <string>
#include <vector>
#include <set>
 
namespace Belle2 {
  class MCParticle;
  class Particle;
 
  namespace Variable {

    bool isInRestOfEvent(const Particle* particle);
    bool isCloneOfSignalSide(const Particle* particle);

    bool hasAncestorFromSignalSide(const Particle* particle);

    double printROE(const Particle* particle);

    bool hasCorrectROECombination(const Particle* particle);

    int nRemainingTracksInROE(const Particle* particle, const std::string& maskName = RestOfEvent::c_defaultMaskName);

    Manager::FunctionPtr nROE_RemainingTracksWithMask(const std::vector<std::string>& arguments);

    Manager::FunctionPtr useROERecoilFrame(const std::vector<std::string>& arguments);

    int nROE_RemainingTracks(const Particle* particle);

    int nROE_KLMClusters(const Particle* particle);

    double ROE_MC_E(const Particle* particle);

    double ROE_MC_M(const Particle* particle);

    double ROE_MC_P(const Particle* particle);

    double ROE_MC_Px(const Particle* particle);

    double ROE_MC_Py(const Particle* particle);

    double ROE_MC_Pz(const Particle* particle);

    double ROE_MC_Pt(const Particle* particle);

    double ROE_MC_PTheta(const Particle* particle);

    Manager::FunctionPtr ROE_MC_MissingFlags(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_Tracks(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_ECLClusters(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_NeutralECLClusters(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_ChargedParticles(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_Photons(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_NeutralHadrons(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_Composites(const std::vector<std::string>& arguments);

    Manager::FunctionPtr nROE_ParticlesInList(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_Charge(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_ExtraEnergy(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_NeutralExtraEnergy(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_E(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_M(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_P(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_Px(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_Py(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_Pz(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_Pt(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_PTheta(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_DeltaE(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_Mbc(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_DeltaE(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_Mbc(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissM2(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissPTheta(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissP(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissPx(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissPy(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissPz(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissE(const std::vector<std::string>& arguments);

    Manager::FunctionPtr ROE_xiZ(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_cosThetaEll(const std::vector<std::string>& arguments);

    Manager::FunctionPtr passesROEMask(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_MissM2OverMissE(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_q2lnuSimple(const std::vector<std::string>& arguments);

    Manager::FunctionPtr WE_q2lnu(const std::vector<std::string>& arguments);

    Manager::FunctionPtr pi0Prob(const std::vector<std::string>& arguments);

    Manager::FunctionPtr etaProb(const std::vector<std::string>& arguments);
 
 
    // ------------------------------------------------------------------------------
    // Below are some functions for ease of usage, they are not a part of variables
    // ------------------------------------------------------------------------------

    ROOT::Math::PxPyPzEVector transformVector(const ROOT::Math::PxPyPzEVector& vec, bool enforceCMSFrame);

    ROOT::Math::PxPyPzEVector missing4Vector(const Particle* particle, const std::string& maskName, const std::string& opt);

    void checkMCParticleMissingFlags(const MCParticle* mcp, std::set<const MCParticle*> ROE_MCObjects, int& missingFlags);

    bool isInThisRestOfEvent(const Particle* particle, const RestOfEvent* roe,
                             const std::string& maskName = RestOfEvent::c_defaultMaskName);

    Manager::FunctionPtr bssMassDifference(const std::vector<std::string>& arguments);
    const RestOfEvent* getRelatedROEObject(const Particle* particle, bool returnHostOnly = false);
  }
} // Belle2 namespace