APVModeFilter.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    Alignment/CommonAlignment
// Class:      APVModeFilter
//
//
// Original Author:  Gregor Mittag
//         Created:  Thu, 03 Dec 2015 16:51:33 GMT
//
//


// system include files
#include <bitset>
#include <array>

// user include files
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Utilities/interface/Exception.h"
#include "CondFormats/SiStripObjects/interface/SiStripLatency.h"
#include "CondFormats/DataRecord/interface/SiStripCondDataRecords.h"

//
// class declaration
//

class APVModeFilter : public edm::stream::EDFilter<> {
public:
  explicit APVModeFilter(const edm::ParameterSet&);
  ~APVModeFilter() = default;

  static void fillDescriptions(edm::ConfigurationDescriptions&);

private:
  virtual bool filter(edm::Event&, const edm::EventSetup&) override;
  virtual void beginRun(const edm::Run&, const edm::EventSetup&) override;

  using BitMask = std::bitset<16>; 

  BitMask convertMode(const std::string& mode) const;

  BitMask convertMode(const uint16_t& mode) const;


  // ----------member data ---------------------------

  static constexpr std::array<size_t, 2> bits_ = {{1, 3}};
  static constexpr BitMask deco_ = BitMask(0);  
  static constexpr BitMask peak_ = BitMask(10); 
  static constexpr BitMask multi_ = BitMask(8); 

  const BitMask mode_;          
  BitMask modeCurrentRun_;      
};


//
// static data member definitions
//
constexpr std::array<size_t, 2> APVModeFilter::bits_;
constexpr APVModeFilter::BitMask APVModeFilter::deco_;
constexpr APVModeFilter::BitMask APVModeFilter::peak_;
constexpr APVModeFilter::BitMask APVModeFilter::multi_;


//
// constructors and destructor
//
APVModeFilter::APVModeFilter(const edm::ParameterSet& iConfig) :
  mode_(convertMode(iConfig.getUntrackedParameter<std::string>("apvMode"))) {
}


//
// member functions
//

// ------------ method called on each new Event  ------------
bool
APVModeFilter::filter(edm::Event&, const edm::EventSetup&) {
  return mode_ == modeCurrentRun_;
}

// ------------ method called when starting to processes a run  ------------
void
APVModeFilter::beginRun(const edm::Run&, const edm::EventSetup& iSetup) {
  edm::ESHandle<SiStripLatency> siStripLatency;
  iSetup.get<SiStripLatencyRcd>().get(siStripLatency);
  auto product = siStripLatency.product();
  modeCurrentRun_ = convertMode(product->singleMode());
}

APVModeFilter::BitMask
APVModeFilter::convertMode(const std::string& mode) const {
  if (mode == "deco") {
    return deco_;
  } else if (mode == "peak") {
    return peak_;
  } else if (mode == "multi") {
    return multi_;
  } else {
    throw cms::Exception("BadConfig")
      << "Your choice for the APV mode ('" << mode
      << "') is invalid.\nValid APV modes: deco, peak, multi" << std::endl;
  }
}

APVModeFilter::BitMask
APVModeFilter::convertMode(const uint16_t& mode) const {
  BitMask input(mode);
  BitMask result;
  for (const auto& bit: bits_) result.set(bit, input[bit]);
  return result;
}

// ------------ method fills 'descriptions' with the allowed parameters for the module  ------------
void
APVModeFilter::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;
  desc.setComment("Filters events with the APV mode 'apvMode' (deco/peak/multi).");
  desc.addUntracked<std::string>("apvMode", "deco");
  descriptions.add("apvModeFilter", desc);
}

//define this as a plug-in
DEFINE_FWK_MODULE(APVModeFilter);