MultiUserHook Class Reference

#include <MultiUserHook.h>

Inheritance diagram for MultiUserHook:

Public Member Functions
void	addHook (Pythia8::UserHooks *hook)
double	biasedSelectionWeight () override
double	biasSelectionBy (const Pythia8::SigmaProcess *sigmaProcessPtr, const Pythia8::PhaseSpace *phaseSpacePtr, bool inEvent) override
bool	canBiasSelection () override
bool	canChangeFragPar () override
bool	canEnhanceEmission () override
bool	canEnhanceTrial () override
bool	canModifySigma () override
bool	canReconnectResonanceSystems () override
bool	canSetResonanceScale () override
bool	canVetoFSREmission () override
bool	canVetoISREmission () override
bool	canVetoMPIEmission () override
bool	canVetoMPIStep () override
bool	canVetoPartonLevel () override
bool	canVetoPartonLevelEarly () override
bool	canVetoProcessLevel () override
bool	canVetoPT () override
bool	canVetoResonanceDecays () override
bool	canVetoStep () override
bool	doChangeFragPar (Pythia8::StringFlav *flavPtr, Pythia8::StringZ *zPtr, Pythia8::StringPT *pTPtr, int idEnd, double m2Had, std::vector< int > iParton, const Pythia8::StringEnd *SE) override
bool	doReconnectResonanceSystems (int oldSizeEvt, Pythia8::Event &event) override
bool	doVetoFragmentation (Pythia8::Particle part, const Pythia8::StringEnd *SE) override
bool	doVetoFSREmission (int sizeOld, const Pythia8::Event &event, int iSys, bool inResonance=false) override
bool	doVetoISREmission (int sizeOld, const Pythia8::Event &event, int iSys) override
bool	doVetoMPIEmission (int sizeOld, const Pythia8::Event &event) override
bool	doVetoMPIStep (int nMPI, const Pythia8::Event &event) override
bool	doVetoPartonLevel (const Pythia8::Event &event) override
bool	doVetoPartonLevelEarly (const Pythia8::Event &event) override
bool	doVetoProcessLevel (Pythia8::Event &event) override
bool	doVetoPT (int iPos, const Pythia8::Event &event) override
bool	doVetoResonanceDecays (Pythia8::Event &event) override
bool	doVetoStep (int iPos, int nISR, int nFSR, const Pythia8::Event &event) override
double	enhanceFactor (std::string str) override
bool	initAfterBeams () override
double	multiplySigmaBy (const Pythia8::SigmaProcess *sigmaProcessPtr, const Pythia8::PhaseSpace *phaseSpacePtr, bool inEvent) override
	MultiUserHook ()
unsigned int	nHooks () const
int	numberVetoMPIStep () override
int	numberVetoStep () override
bool	retryPartonLevel () override
double	scaleResonance (int iRes, const Pythia8::Event &event) override
double	scaleVetoPT () override
double	vetoProbability (std::string str) override

Private Attributes
std::vector< Pythia8::UserHooks * >	hooks_

Detailed Description

Definition at line 6 of file MultiUserHook.h.

Constructor & Destructor Documentation

MultiUserHook::MultiUserHook ( )

inline

Definition at line 9 of file MultiUserHook.h.

{}

Member Function Documentation

void MultiUserHook::addHook ( Pythia8::UserHooks *  hook )

inline

Definition at line 12 of file MultiUserHook.h.

References hooks_.

{ hooks_.push_back(hook); }

double MultiUserHook::biasedSelectionWeight ( )

inlineoverride

Definition at line 129 of file MultiUserHook.h.

References DQMScaleToClient_cfi::factor, and hooks_.

                                          {
    double factor = 1.;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canBiasSelection())
        factor *= hook->biasedSelectionWeight();
    }
    return factor;
  };

double MultiUserHook::biasSelectionBy ( const Pythia8::SigmaProcess *  sigmaProcessPtr, const Pythia8::PhaseSpace *  phaseSpacePtr, bool  inEvent  )

inlineoverride

Definition at line 117 of file MultiUserHook.h.

References DQMScaleToClient_cfi::factor, and hooks_.

                                                {
    double factor = 1.;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canBiasSelection())
        factor *= hook->biasSelectionBy(sigmaProcessPtr, phaseSpacePtr, inEvent);
    }
    return factor;
  };

bool MultiUserHook::canBiasSelection ( )

inlineoverride

Definition at line 108 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                   {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canBiasSelection();
    }
    return test;
  }

bool MultiUserHook::canChangeFragPar ( )

inlineoverride

Definition at line 467 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                   {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canChangeFragPar();
    }
    return test;
  }

bool MultiUserHook::canEnhanceEmission ( )

inlineoverride

Definition at line 432 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                     {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canEnhanceEmission();
    }
    return test;
  }

bool MultiUserHook::canEnhanceTrial ( )

inlineoverride

Definition at line 442 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                  {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canEnhanceTrial();
    }
    return test;
  }

bool MultiUserHook::canModifySigma ( )

inlineoverride

Definition at line 87 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                 {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canModifySigma();
    }
    return test;
  }

bool MultiUserHook::canReconnectResonanceSystems ( )

inlineoverride

Definition at line 409 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                               {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canReconnectResonanceSystems();
    }
    return test;
  }

bool MultiUserHook::canSetResonanceScale ( )

inlineoverride

Definition at line 321 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                       {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canSetResonanceScale();
    }
    return test;
  }

bool MultiUserHook::canVetoFSREmission ( )

inlineoverride

Definition at line 364 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                     {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoFSREmission();
    }
    return test;
  }

bool MultiUserHook::canVetoISREmission ( )

inlineoverride

Definition at line 342 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                     {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoISREmission();
    }
    return test;
  }

bool MultiUserHook::canVetoMPIEmission ( )

inlineoverride

Definition at line 388 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                     {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoMPIEmission();
    }
    return test;
  }

bool MultiUserHook::canVetoMPIStep ( )

inlineoverride

Definition at line 241 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                 {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoMPIStep();
    }
    return test;
  }

bool MultiUserHook::canVetoPartonLevel ( )

inlineoverride

Definition at line 301 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                     {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoPartonLevel();
    }
    return test;
  }

bool MultiUserHook::canVetoPartonLevelEarly ( )

inlineoverride

Definition at line 270 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                          {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoPartonLevelEarly();
    }
    return test;
  }

bool MultiUserHook::canVetoProcessLevel ( )

inlineoverride

Definition at line 139 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                      {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoProcessLevel();
    }
    return test;
  }

bool MultiUserHook::canVetoPT ( )

inlineoverride

Definition at line 180 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                            {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoPT();
    }
    return test;
  }

bool MultiUserHook::canVetoResonanceDecays ( )

inlineoverride

Definition at line 159 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                         {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoResonanceDecays();
    }
    return test;
  }

bool MultiUserHook::canVetoStep ( )

inlineoverride

Definition at line 211 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                              {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->canVetoStep();
    }
    return test;
  }

bool MultiUserHook::doChangeFragPar ( Pythia8::StringFlav *  flavPtr, Pythia8::StringZ *  zPtr, Pythia8::StringPT *  pTPtr, int  idEnd, double  m2Had, std::vector< int >  iParton, const Pythia8::StringEnd *  SE  )

inlineoverride

Definition at line 477 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                            {
    bool test = true;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canChangeFragPar())
        test &= hook->doChangeFragPar(flavPtr, zPtr, pTPtr, idEnd, m2Had, iParton, SE);
    }
    return test;
  }

bool MultiUserHook::doReconnectResonanceSystems ( int  oldSizeEvt, Pythia8::Event &  event  )

inlineoverride

Definition at line 422 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                                                 {
    bool test = true;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canReconnectResonanceSystems())
        test &= hook->doReconnectResonanceSystems(oldSizeEvt, event);
    }
    return test;
  }

bool MultiUserHook::doVetoFragmentation ( Pythia8::Particle  part, const Pythia8::StringEnd *  SE  )

inlineoverride

Definition at line 493 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                                                      {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canChangeFragPar())
        test |= hook->doVetoFragmentation(part, SE);
    }
    return test;
  }

bool MultiUserHook::doVetoFSREmission ( int  sizeOld, const Pythia8::Event &  event, int  iSys, bool  inResonance = false  )

inlineoverride

Definition at line 378 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                                                                              {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoFSREmission())
        test |= hook->doVetoFSREmission(sizeOld, event, iSys, inResonance);
    }
    return test;
  }

bool MultiUserHook::doVetoISREmission ( int  sizeOld, const Pythia8::Event &  event, int  iSys  )

inlineoverride

Definition at line 354 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                                                    {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoISREmission())
        test |= hook->doVetoISREmission(sizeOld, event, iSys);
    }
    return test;
  }

bool MultiUserHook::doVetoMPIEmission ( int  sizeOld, const Pythia8::Event &  event  )

inlineoverride

Definition at line 399 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                                          {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoMPIEmission())
        test |= hook->doVetoMPIEmission(sizeOld, event);
    }
    return test;
  }

bool MultiUserHook::doVetoMPIStep ( int  nMPI, const Pythia8::Event &  event  )

inlineoverride

Definition at line 260 of file MultiUserHook.h.

References hooks_.

                                                                   {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoMPIStep())
        return hook->doVetoMPIStep(nMPI, event);
    }
    return false;
  }

bool MultiUserHook::doVetoPartonLevel ( const Pythia8::Event &  event )

inlineoverride

Definition at line 311 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                             {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoPartonLevel())
        test |= hook->doVetoPartonLevel(event);
    }
    return test;
  }

bool MultiUserHook::doVetoPartonLevelEarly ( const Pythia8::Event &  event )

inlineoverride

Definition at line 280 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                                  {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoPartonLevelEarly())
        test |= hook->doVetoPartonLevelEarly(event);
    }
    return test;
  }

bool MultiUserHook::doVetoProcessLevel ( Pythia8::Event &  event )

inlineoverride

Definition at line 149 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                        {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoProcessLevel())
        test |= hook->doVetoProcessLevel(event);
    }
    return test;
  }

bool MultiUserHook::doVetoPT ( int  iPos, const Pythia8::Event &  event  )

inlineoverride

Definition at line 201 of file MultiUserHook.h.

References hooks_.

                                                              {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoPT())
        return hook->doVetoPT(iPos, event);
    }
    return false;
  }

bool MultiUserHook::doVetoResonanceDecays ( Pythia8::Event &  event )

inlineoverride

Definition at line 169 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                                           {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoResonanceDecays())
        test |= hook->doVetoResonanceDecays(event);
    }
    return test;
  }

bool MultiUserHook::doVetoStep ( int  iPos, int  nISR, int  nFSR, const Pythia8::Event &  event  )

inlineoverride

Definition at line 231 of file MultiUserHook.h.

References hooks_.

                                                                                    {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoStep())
        return hook->doVetoStep(iPos, nISR, nFSR, event);
    }
    return false;
  }

double MultiUserHook::enhanceFactor ( std::string  str )

inlineoverride

Definition at line 450 of file MultiUserHook.h.

References hooks_.

                                               {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canEnhanceEmission() || hook->canEnhanceTrial())
        return hook->enhanceFactor(str);
    }
    return 1.;
  };

bool MultiUserHook::initAfterBeams ( )

inlineoverride

Definition at line 15 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                 {
    bool test = true;
    for (Pythia8::UserHooks *hook : hooks_) {
      hook->initPtr(infoPtr,
                    settingsPtr,
                    particleDataPtr,
                    rndmPtr,
                    beamAPtr,
                    beamBPtr,
                    beamPomAPtr,
                    beamPomBPtr,
                    coupSMPtr,
                    partonSystemsPtr,
                    sigmaTotPtr);
      test &= hook->initAfterBeams();
    }

    //Certain types of hooks can only be handled by one UserHook at a time.
    //Check for this and return an error if needed
    int nCanVetoPT = 0;
    int nCanVetoStep = 0;
    int nCanVetoMPIStep = 0;
    int nCanSetResonanceScale = 0;
    int nCanEnhance = 0;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoPT())
        ++nCanVetoPT;
      if (hook->canVetoStep())
        ++nCanVetoStep;
      if (hook->canVetoMPIStep())
        ++nCanVetoMPIStep;
      if (hook->canSetResonanceScale())
        ++nCanSetResonanceScale;
      if (hook->canEnhanceEmission() || hook->canEnhanceTrial())
        ++nCanEnhance;
    }

    if (nCanVetoPT > 1) {
      infoPtr->errorMsg(
          "Error in MultiUserHook::initAfterBeams "
          "multiple UserHooks with canVetoPT() not allowed");
      test = false;
    }
    if (nCanVetoStep > 1) {
      infoPtr->errorMsg(
          "Error in MultiUserHook::initAfterBeams "
          "multiple UserHooks with canVetoStep() not allowed");
      test = false;
    }
    if (nCanVetoMPIStep > 1) {
      infoPtr->errorMsg(
          "Error in MultiUserHook::initAfterBeams "
          "multiple UserHooks with canVetoMPIStep() not allowed");
      test = false;
    }
    if (nCanSetResonanceScale > 1) {
      infoPtr->errorMsg(
          "Error in MultiUserHook::initAfterBeams "
          "multiple UserHooks with canSetResonanceScale() not allowed");
      test = false;
    }
    if (nCanEnhance > 1) {
      infoPtr->errorMsg(
          "Error in MultiUserHook::initAfterBeams "
          "multiple UserHooks with canEnhanceEmission() or canEnhanceTrial() not allowed");
      test = false;
    }

    return test;
  }

double MultiUserHook::multiplySigmaBy ( const Pythia8::SigmaProcess *  sigmaProcessPtr, const Pythia8::PhaseSpace *  phaseSpacePtr, bool  inEvent  )

inlineoverride

Definition at line 96 of file MultiUserHook.h.

References DQMScaleToClient_cfi::factor, and hooks_.

                                                {
    double factor = 1.;
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canModifySigma())
        factor *= hook->multiplySigmaBy(sigmaProcessPtr, phaseSpacePtr, inEvent);
    }
    return factor;
  }

unsigned int MultiUserHook::nHooks ( ) const

inline

Definition at line 11 of file MultiUserHook.h.

References hooks_.

{ return hooks_.size(); }

int MultiUserHook::numberVetoMPIStep ( )

inlineoverride

Definition at line 250 of file MultiUserHook.h.

References hooks_.

                                   {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoMPIStep())
        return hook->numberVetoMPIStep();
    }
    return 1;
  };

int MultiUserHook::numberVetoStep ( )

inlineoverride

Definition at line 220 of file MultiUserHook.h.

References hooks_.

                                {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoStep())
        return hook->numberVetoStep();
    }
    return 1;
  };

bool MultiUserHook::retryPartonLevel ( )

inlineoverride

Definition at line 292 of file MultiUserHook.h.

References hooks_, and ctpps_dqm_sourceclient-live_cfg::test.

                                   {
    bool test = false;
    for (Pythia8::UserHooks *hook : hooks_) {
      test |= hook->retryPartonLevel();
    }
    return test;
  }

double MultiUserHook::scaleResonance ( int  iRes, const Pythia8::Event &  event  )

inlineoverride

Definition at line 333 of file MultiUserHook.h.

References hooks_.

                                                                      {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canSetResonanceScale())
        return hook->scaleResonance(iRes, event);
    }
    return 0.;
  };

double MultiUserHook::scaleVetoPT ( )

inlineoverride

Definition at line 189 of file MultiUserHook.h.

References hooks_.

                                {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canVetoPT())
        return hook->scaleVetoPT();
    }
    return 0.;
  };

double MultiUserHook::vetoProbability ( std::string  str )

inlineoverride

Definition at line 458 of file MultiUserHook.h.

References hooks_.

                                                 {
    for (Pythia8::UserHooks *hook : hooks_) {
      if (hook->canEnhanceEmission() || hook->canEnhanceTrial())
        return hook->vetoProbability(str);
    }
    return 0.;
  };

Member Data Documentation

std::vector<Pythia8::UserHooks *> MultiUserHook::hooks_

private

Definition at line 505 of file MultiUserHook.h.

Referenced by addHook(), biasedSelectionWeight(), biasSelectionBy(), canBiasSelection(), canChangeFragPar(), canEnhanceEmission(), canEnhanceTrial(), canModifySigma(), canReconnectResonanceSystems(), canSetResonanceScale(), canVetoFSREmission(), canVetoISREmission(), canVetoMPIEmission(), canVetoMPIStep(), canVetoPartonLevel(), canVetoPartonLevelEarly(), canVetoProcessLevel(), canVetoPT(), canVetoResonanceDecays(), canVetoStep(), doChangeFragPar(), doReconnectResonanceSystems(), doVetoFragmentation(), doVetoFSREmission(), doVetoISREmission(), doVetoMPIEmission(), doVetoMPIStep(), doVetoPartonLevel(), doVetoPartonLevelEarly(), doVetoProcessLevel(), doVetoPT(), doVetoResonanceDecays(), doVetoStep(), enhanceFactor(), initAfterBeams(), multiplySigmaBy(), nHooks(), numberVetoMPIStep(), numberVetoStep(), retryPartonLevel(), scaleResonance(), scaleVetoPT(), and vetoProbability().