TauDiscriminationProducerBase< TauType, TauDiscriminator > Class Template Reference

#include <TauDiscriminationProducerBase.h>

Inheritance diagram for TauDiscriminationProducerBase< TauType, TauDiscriminator >:

Classes
struct	TauDiscInfo

Public Types
typedef std::vector< TauType >	TauCollection
typedef edm::Ref< TauCollection >	TauRef
typedef edm::RefProd< TauCollection >	TauRefProd
Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T... >	CacheTypes
typedef CacheTypes::GlobalCache	GlobalCache
typedef AbilityChecker< T... >	HasAbility
typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache
typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext
typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache
typedef CacheTypes::RunCache	RunCache
typedef RunContextT< RunCache, GlobalCache >	RunContext
typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Member Functions
virtual void	beginEvent (const edm::Event &, const edm::EventSetup &)
virtual double	discriminate (const TauRef &tau) const =0
virtual void	endEvent (edm::Event &)
void	produce (edm::Event &, const edm::EventSetup &) override
	TauDiscriminationProducerBase (const edm::ParameterSet &iConfig)
	TauDiscriminationProducerBase ()
	~TauDiscriminationProducerBase () override
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndRuns () const final

Static Public Member Functions
static void	fillProducerDescriptions (edm::ParameterSetDescription &desc)

Protected Attributes
std::string	moduleLabel_
double	prediscriminantFailValue_
edm::EDGetTokenT< TauCollection >	Tau_token
size_t	tauIndex_
edm::InputTag	TauProducer_

Private Attributes
uint8_t	andPrediscriminants_
std::vector< TauDiscInfo >	prediscriminants_

Detailed Description

template<class TauType, class TauDiscriminator>
class TauDiscriminationProducerBase< TauType, TauDiscriminator >

Definition at line 51 of file TauDiscriminationProducerBase.h.

Member Typedef Documentation

template<class TauType , class TauDiscriminator >

typedef std::vector<TauType> TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauCollection

Definition at line 54 of file TauDiscriminationProducerBase.h.

template<class TauType , class TauDiscriminator >

typedef edm::Ref<TauCollection> TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauRef

Definition at line 55 of file TauDiscriminationProducerBase.h.

template<class TauType , class TauDiscriminator >

typedef edm::RefProd<TauCollection> TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauRefProd

Definition at line 56 of file TauDiscriminationProducerBase.h.

Constructor & Destructor Documentation

template<class TauType , class TauDiscriminator >

TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscriminationProducerBase ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 16 of file TauDiscriminationProducerBase.cc.

References TauDiscriminationProducerBase< TauType, TauDiscriminator >::andPrediscriminants_, TkAlMuonSelectors_cfi::cut, Exception, edm::ParameterSet::getParameter(), label, TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscInfo::label, TauDiscriminationProducerBase< TauType, TauDiscriminator >::prediscriminantFailValue_, TauDiscriminationProducerBase< TauType, TauDiscriminator >::prediscriminants_, AlCaHLTBitMon_QueryRunRegistry::string, TauDiscriminationProducerBase< TauType, TauDiscriminator >::Tau_token, TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauProducer_, and HcalDetIdTransform::transform().

    : moduleLabel_(iConfig.getParameter<std::string>("@module_label")) {
  // tau collection to discriminate
  TauProducer_ = iConfig.getParameter<edm::InputTag>(getProducerString<TauType>());
  Tau_token = consumes<TauCollection>(TauProducer_);

  // prediscriminant operator
  // require the tau to pass the following prediscriminants
  const edm::ParameterSet& prediscriminantConfig = iConfig.getParameter<edm::ParameterSet>("Prediscriminants");

  // determine boolean operator used on the prediscriminants
  std::string pdBoolOperator = prediscriminantConfig.getParameter<std::string>("BooleanOperator");
  // convert string to lowercase
  transform(pdBoolOperator.begin(), pdBoolOperator.end(), pdBoolOperator.begin(), ::tolower);

  if (pdBoolOperator == "and") {
    andPrediscriminants_ = 0x1;  //use chars instead of bools so we can do a bitwise trick later
  } else if (pdBoolOperator == "or") {
    andPrediscriminants_ = 0x0;
  } else {
    throw cms::Exception("TauDiscriminationProducerBase")
        << "PrediscriminantBooleanOperator defined incorrectly, options are: AND,OR";
  }

  // get the list of prediscriminants
  std::vector<std::string> prediscriminantsNames = prediscriminantConfig.getParameterNamesForType<edm::ParameterSet>();

  for (std::vector<std::string>::const_iterator iDisc = prediscriminantsNames.begin();
       iDisc != prediscriminantsNames.end();
       ++iDisc) {
    const edm::ParameterSet& iPredisc = prediscriminantConfig.getParameter<edm::ParameterSet>(*iDisc);
    const edm::InputTag& label = iPredisc.getParameter<edm::InputTag>("Producer");
    double cut = iPredisc.getParameter<double>("cut");

    TauDiscInfo thisDiscriminator;
    thisDiscriminator.label = label;
    thisDiscriminator.cut = cut;
    thisDiscriminator.disc_token = consumes<TauDiscriminator>(label);
    prediscriminants_.push_back(thisDiscriminator);
  }

  prediscriminantFailValue_ = 0.;

  // register product
  produces<TauDiscriminator>();
}

template<class TauType , class TauDiscriminator >

TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscriminationProducerBase

(

)

Definition at line 9 of file TauDiscriminationProducerBase.cc.

References Exception.

                                                                                        {
  throw cms::Exception("TauDiscriminationProducerBase") << " -- default ctor called; derived classes must call "
                                                        << "TauDiscriminationProducerBase(const ParameterSet&)";
}

template<class TauType , class TauDiscriminator >

TauDiscriminationProducerBase< TauType, TauDiscriminator >::~TauDiscriminationProducerBase ( )

inlineoverride

Definition at line 65 of file TauDiscriminationProducerBase.h.

References TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce().

{}

Member Function Documentation

template<class TauType , class TauDiscriminator >

virtual void TauDiscriminationProducerBase< TauType, TauDiscriminator >::beginEvent ( const edm::Event &  , const edm::EventSetup &    )

inlinevirtual

Reimplemented in PFRecoTauDiscriminationByIsolation, reco::tau::PATTauDiscriminationByMVAIsolationRun2, reco::tau::PFRecoTauDiscriminationByMVAIsolationRun2, PFRecoTauDiscriminationByIsolationMVA2, PFRecoTauDiscriminationAgainstElectron2, PFRecoTauDiscriminationAgainstElectronDeadECAL, PFTauDecayModeCutMultiplexer, PFRecoTauDiscriminationAgainstElectronMVA6, PATTauDiscriminantCutMultiplexer, RecoTauDiscriminantCutMultiplexer, PATTauDiscriminationAgainstElectronMVA6, and PFRecoTauDiscriminationByNProngs.

Definition at line 70 of file TauDiscriminationProducerBase.h.

References TauDiscriminationProducerBase< TauType, TauDiscriminator >::discriminate(), and metsig::tau.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce().

{}

template<class TauType , class TauDiscriminator >

virtual double TauDiscriminationProducerBase< TauType, TauDiscriminator >::discriminate ( const TauRef &  tau ) const

pure virtual

Implemented in reco::tau::PATTauDiscriminationByMVAIsolationRun2, PATTauDiscriminantCutMultiplexer, and PATTauDiscriminationAgainstElectronMVA6.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::beginEvent(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce().

template<class TauType , class TauDiscriminator >

virtual void TauDiscriminationProducerBase< TauType, TauDiscriminator >::endEvent ( edm::Event &  )

inlinevirtual

Reimplemented in reco::tau::PATTauDiscriminationByMVAIsolationRun2, reco::tau::PFRecoTauDiscriminationByMVAIsolationRun2, PFRecoTauDiscriminationByIsolationMVA2, PFRecoTauDiscriminationAgainstElectronMVA6, and PATTauDiscriminationAgainstElectronMVA6.

Definition at line 76 of file TauDiscriminationProducerBase.h.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce().

{}

template<class TauType , class TauDiscriminator >

void TauDiscriminationProducerBase< TauType, TauDiscriminator >::fillProducerDescriptions ( edm::ParameterSetDescription &  desc )

static

Definition at line 148 of file TauDiscriminationProducerBase.cc.

References edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addOptional(), HLT_2018_cff::InputTag, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscInfo::fill(), RecoTauDiscriminantCutMultiplexer::fillDescriptions(), PATTauDiscriminantCutMultiplexer::fillDescriptions(), PFTauDecayModeCutMultiplexer::fillDescriptions(), and reco::tau::PFRecoTauDiscriminationByMVAIsolationRun2::fillDescriptions().

                                      {
  // helper function, it fills the description of the Producers parameter
  desc.add<edm::InputTag>(getProducerString<TauType>(), edm::InputTag("fixme"));
  {
    edm::ParameterSetDescription pset_prediscriminants;
    pset_prediscriminants.add<std::string>("BooleanOperator", "AND");
    // optional producers // will it pass if I don't specify them?

    {
      edm::ParameterSetDescription producer_params;
      producer_params.add<double>("cut", 0.);
      producer_params.add<edm::InputTag>("Producer", edm::InputTag("fixme"));

      pset_prediscriminants.addOptional<edm::ParameterSetDescription>("leadTrack", producer_params);
      pset_prediscriminants.addOptional<edm::ParameterSetDescription>("decayMode", producer_params);
    }

    desc.add<edm::ParameterSetDescription>("Prediscriminants", pset_prediscriminants);
  }
}

template<class TauType , class TauDiscriminator >

void TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce ( edm::Event &  event, const edm::EventSetup &  eventSetup  )

override

Definition at line 64 of file TauDiscriminationProducerBase.cc.

References TauDiscriminationProducerBase< TauType, TauDiscriminator >::andPrediscriminants_, TauDiscriminationProducerBase< TauType, TauDiscriminator >::beginEvent(), TauDiscriminationProducerBase< TauType, TauDiscriminator >::discriminate(), TauDiscriminationProducerBase< TauType, TauDiscriminator >::endEvent(), Exception, edm::HandleBase::id(), eostools::move(), convertSQLitetoXML_cfg::output, TauDiscriminationProducerBase< TauType, TauDiscriminator >::prediscriminantFailValue_, TauDiscriminationProducerBase< TauType, TauDiscriminator >::prediscriminants_, mps_fire::result, TauDiscriminationProducerBase< TauType, TauDiscriminator >::Tau_token, TauDiscriminationProducerBase< TauType, TauDiscriminator >::tauIndex_, TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauProducer_, and Tau3MuMonitor_cff::taus.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::~TauDiscriminationProducerBase().

                                                                                                        {
  tauIndex_ = 0;
  // setup function - does nothing in base, but can be overridden to retrieve PV or other stuff
  beginEvent(event, eventSetup);

  // retrieve the tau collection to discriminate
  edm::Handle<TauCollection> taus;
  event.getByToken(Tau_token, taus);

  edm::ProductID tauProductID = taus.id();

  // output product
  auto output = std::make_unique<TauDiscriminator>(TauRefProd(taus));

  size_t nTaus = taus->size();

  // load prediscriminators
  size_t nPrediscriminants = prediscriminants_.size();
  for (size_t iDisc = 0; iDisc < nPrediscriminants; ++iDisc) {
    prediscriminants_[iDisc].fill(event);

    // Check to make sure the product is correct for the discriminator.
    // If not, throw a more informative exception.
    edm::ProductID discKeyId = prediscriminants_[iDisc].handle->keyProduct().id();
    if (tauProductID != discKeyId) {
      throw cms::Exception("MisconfiguredPrediscriminant")
          << "The tau collection with input tag " << TauProducer_ << " has product ID: " << tauProductID
          << " but the pre-discriminator with input tag " << prediscriminants_[iDisc].label
          << " is keyed with product ID: " << discKeyId << std::endl;
    }
  }

  // loop over taus
  for (size_t iTau = 0; iTau < nTaus; ++iTau) {
    // get reference to tau
    TauRef tauRef(taus, iTau);

    bool passesPrediscriminants = (andPrediscriminants_ ? 1 : 0);
    // check tau passes prediscriminants
    for (size_t iDisc = 0; iDisc < nPrediscriminants; ++iDisc) {
      // current discriminant result for this tau
      double discResult = (*prediscriminants_[iDisc].handle)[tauRef];
      uint8_t thisPasses = (discResult > prediscriminants_[iDisc].cut) ? 1 : 0;

      // if we are using the AND option, as soon as one fails,
      // the result is FAIL and we can quit looping.
      // if we are using the OR option as soon as one passes,
      // the result is pass and we can quit looping

      // truth table
      //        |   result (thisPasses)
      //        |     F     |     T
      //-----------------------------------
      // AND(T) | res=fails |  continue
      //        |  break    |
      //-----------------------------------
      // OR (F) |  continue | res=passes
      //        |           |  break

      if (thisPasses ^ andPrediscriminants_)  //XOR
      {
        passesPrediscriminants = (andPrediscriminants_ ? 0 : 1);  //NOR
        break;
      }
    }

    double result = prediscriminantFailValue_;
    if (passesPrediscriminants) {
      // this tau passes the prereqs, call our implemented discrimination function
      result = discriminate(tauRef);
      ++tauIndex_;
    }

    // store the result of this tau into our new discriminator
    output->setValue(iTau, result);
  }
  event.put(std::move(output));

  // function to put additional information into the event - does nothing in base, but can be overridden in derived classes
  endEvent(event);
}

Member Data Documentation

template<class TauType , class TauDiscriminator >

uint8_t TauDiscriminationProducerBase< TauType, TauDiscriminator >::andPrediscriminants_

private

Definition at line 107 of file TauDiscriminationProducerBase.h.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscriminationProducerBase().

template<class TauType , class TauDiscriminator >

std::string TauDiscriminationProducerBase< TauType, TauDiscriminator >::moduleLabel_

protected

Definition at line 98 of file TauDiscriminationProducerBase.h.

Referenced by Modules.SwitchProducer::insertInto(), Mixins._TypedParameterizable::insertInto(), Modules.ESSource::nameInProcessDesc_(), and Modules.ESProducer::nameInProcessDesc_().

template<class TauType , class TauDiscriminator >

double TauDiscriminationProducerBase< TauType, TauDiscriminator >::prediscriminantFailValue_

protected

Definition at line 94 of file TauDiscriminationProducerBase.h.

Referenced by RecoTauDiscriminantCutMultiplexer::discriminate(), PATTauDiscriminantCutMultiplexer::discriminate(), PFTauDiscriminatorLogicalAndProducer::PFTauDiscriminatorLogicalAndProducer(), TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscriminationProducerBase().

template<class TauType , class TauDiscriminator >

std::vector<TauDiscInfo> TauDiscriminationProducerBase< TauType, TauDiscriminator >::prediscriminants_

private

Definition at line 105 of file TauDiscriminationProducerBase.h.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscriminationProducerBase().

template<class TauType , class TauDiscriminator >

edm::EDGetTokenT<TauCollection> TauDiscriminationProducerBase< TauType, TauDiscriminator >::Tau_token

protected

Definition at line 99 of file TauDiscriminationProducerBase.h.

Referenced by reco::tau::PFRecoTauDiscriminationByMVAIsolationRun2::beginEvent(), TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscriminationProducerBase().

template<class TauType , class TauDiscriminator >

size_t TauDiscriminationProducerBase< TauType, TauDiscriminator >::tauIndex_

protected

Definition at line 102 of file TauDiscriminationProducerBase.h.

Referenced by reco::tau::PFRecoTauDiscriminationByMVAIsolationRun2::discriminate(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce().

template<class TauType , class TauDiscriminator >

edm::InputTag TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauProducer_

protected

Definition at line 96 of file TauDiscriminationProducerBase.h.

Referenced by TauDiscriminationProducerBase< TauType, TauDiscriminator >::produce(), and TauDiscriminationProducerBase< TauType, TauDiscriminator >::TauDiscriminationProducerBase().