#include <UserCode/HcalLaserEventFilter/src/HcalLaserEventFilter.cc>

Inheritance diagram for HcalLaserEventFilter:

Public Member Functions
	HcalLaserEventFilter (const edm::ParameterSet &)

	~HcalLaserEventFilter ()

Public Member Functions inherited from edm::EDFilter
	EDFilter ()

ModuleDescription const &	moduleDescription () const

virtual	~EDFilter ()

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	ProducerBase ()

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

virtual	~ProducerBase ()

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

	EDConsumerBase ()

ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::EDFilter
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Private Member Functions
virtual void	beginJob () override

virtual void	endJob () override

virtual bool	filter (edm::Event &, const edm::EventSetup &) override

std::vector< int >	GetCMSSWVersion (std::string const &)

bool	IsGreaterThanMinCMSSWVersion (std::vector< int > const &)

Private Attributes
const bool	debug_

int	errorcount

bool	forceUseHcalNoiseSummary_

bool	forceUseRecHitCollection_

const edm::InputTag	hbheInputLabel_

edm::EDGetTokenT < HBHERecHitCollection >	hbheToken_

const edm::InputTag	hcalNoiseSummaryLabel_

edm::EDGetTokenT < HcalNoiseSummary >	hcalNoiseSummaryToken_

int	maxerrormessage_

const unsigned int	minOccupiedHBHE_

std::vector< int >	minVersion_

const bool	reverseFilter_

std::vector< std::pair < edm::RunNumber_t, edm::EventNumber_t > >	RunEventData_

const bool	taggingMode_

bool	useHcalNoiseSummary_

const bool	vetoByHBHEOccupancy_

const bool	vetoByRunEventNumber_

Additional Inherited Members
Public Types inherited from edm::EDFilter
typedef EDFilter	ModuleType

Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)

ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...

template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()

void	consumesMany (const TypeToGet &id)

template<BranchType B>
void	consumesMany (const TypeToGet &id)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Description: Filter for removing Hcal laser events

Implementation: Filter allows users to remove specific (run,event) pairs that have been identified as noise It also allows users to remove events in which the number of HBHE rechits exceeds a given threshold (5000 by default).

Definition at line 49 of file HcalLaserEventFilter.cc.

Constructor & Destructor Documentation

HcalLaserEventFilter::HcalLaserEventFilter ( const edm::ParameterSet & iConfig )

explicit

Definition at line 111 of file HcalLaserEventFilter.cc.

References errorcount, edm::ParameterSet::getUntrackedParameter(), i, DTTTrigCorrFirst::run, and RunEventData_.

   : vetoByRunEventNumber_ (iConfig.getUntrackedParameter<bool>("vetoByRunEventNumber",true))
   , vetoByHBHEOccupancy_  (iConfig.getUntrackedParameter<bool>("vetoByHBHEOccupancy",false))
   , minOccupiedHBHE_            (iConfig.getUntrackedParameter<unsigned int>("minOccupiedHBHE",5000))
   , debug_                      (iConfig.getUntrackedParameter<bool>("debug",false))
   , reverseFilter_              (iConfig.getUntrackedParameter<bool>("reverseFilter",false))
   , hbheInputLabel_             (iConfig.getUntrackedParameter<edm::InputTag>("hbheInputLabel",edm::InputTag("hbhereco")))
   , hbheToken_             (mayConsume<HBHERecHitCollection>(hbheInputLabel_))
 
   , hcalNoiseSummaryLabel_      (iConfig.getUntrackedParameter<edm::InputTag>("hcalNoiseSummaryLabel",edm::InputTag("hcalnoise")))
   , hcalNoiseSummaryToken_      (mayConsume<HcalNoiseSummary>(hcalNoiseSummaryLabel_))
   , taggingMode_                (iConfig.getParameter<bool>("taggingMode"))
   , maxerrormessage_            (iConfig.getUntrackedParameter<int>("maxerrormessage",1))
   , forceUseRecHitCollection_   (iConfig.getUntrackedParameter<bool>("forceUseRecHitCollection",false))
   , forceUseHcalNoiseSummary_   (iConfig.getUntrackedParameter<bool>("forceUseHcalNoiseSummary",false))
 
 {
   std::vector<unsigned int> dummy; // dummy empty vector
   dummy.clear();
 
   std::vector<unsigned int> temprunevt   = iConfig.getUntrackedParameter<std::vector<unsigned int> >("BadRunEventNumbers",dummy);
 
   // Make (run,evt) pairs for storing bad events
   // Make this a map for better search performance?
   for (unsigned int i=0;i+1<temprunevt.size();i+=2)
     {
       edm::RunNumber_t run=temprunevt[i];
       edm::EventNumber_t evt=temprunevt[i+1];
       RunEventData_.push_back(std::make_pair(run,evt));
     }
   errorcount=0;
   produces<bool>();
 }

HcalLaserEventFilter::~HcalLaserEventFilter ( )

Definition at line 148 of file HcalLaserEventFilter.cc.

 {
 
    // do anything here that needs to be done at desctruction time
    // (e.g. close files, deallocate resources etc.)
 
 }

Member Function Documentation

void HcalLaserEventFilter::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::EDFilter.

Definition at line 258 of file HcalLaserEventFilter.cc.

References GetCMSSWVersion(), edm::getReleaseVersion(), IsGreaterThanMinCMSSWVersion(), minVersion_, AlCaHLTBitMon_QueryRunRegistry::string, and useHcalNoiseSummary_.

 {
   // Specify the minimum release that has the rechit counts in the HcalNoiseSummary object.
   // If current release >= that release, then HcalNoiseSummary will be used.  Otherwise, Rechit collection will be used.
   std::string minRelease="\"CMSSW_5_2_0\"";
 
   minVersion_=GetCMSSWVersion(minRelease);
   std::vector <int> currentVersion=GetCMSSWVersion(edm::getReleaseVersion());
 
   if (IsGreaterThanMinCMSSWVersion(currentVersion)) // current Version is >= minVersion_
     useHcalNoiseSummary_=true;
   else
     useHcalNoiseSummary_=false;
 }

void HcalLaserEventFilter::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::EDFilter.

Definition at line 275 of file HcalLaserEventFilter.cc.

275 {

276 }

void HcalLaserEventFilter::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 280 of file HcalLaserEventFilter.cc.

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

                                                                                  {
   //The following says we do not know what parameters are allowed so do no validation
   // Please change this to state exactly what you do use, even if it is no parameters
   edm::ParameterSetDescription desc;
   desc.setUnknown();
   descriptions.addDefault(desc);
 }

bool HcalLaserEventFilter::filter	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overrideprivatevirtual

Implements edm::EDFilter.

Definition at line 163 of file HcalLaserEventFilter.cc.

References gather_cfg::cout, debug_, errorcount, edm::EventID::event(), forceUseHcalNoiseSummary_, forceUseRecHitCollection_, edm::Event::getByToken(), hbheInputLabel_, hbheToken_, hcalNoiseSummaryLabel_, hcalNoiseSummaryToken_, i, edm::EventBase::id(), maxerrormessage_, minOccupiedHBHE_, edm::Event::put(), reverseFilter_, edm::EventID::run(), RunEventData_, taggingMode_, useHcalNoiseSummary_, vetoByHBHEOccupancy_, and vetoByRunEventNumber_.

 {
    using namespace edm;
 
    bool filterDecision=true;
 
    if (debug_) std::cout <<"<HcalLaserEventFilter> Run = "<<iEvent.id().run()<<" Event = "<<iEvent.id().event()<<std::endl;
 
    // Veto events by run/event numbers
    if (vetoByRunEventNumber_)
      {
        for (unsigned int i=0;i<RunEventData_.size();++i)
      {
        if (iEvent.id().run()==RunEventData_[i].first &&
            iEvent.id().event()==RunEventData_[i].second)
          {
            if (debug_) std::cout<<"\t<HcalLaserEventFilter> Filtering bad event;  Run "<<iEvent.id().run()<<" Event = "<<iEvent.id().event()<<std::endl;
            filterDecision=false;
            break;
          }
      }
      } // if (vetoByRunEventNumber_)
 
    //Veto events by HBHE rechit collection size
    if (vetoByHBHEOccupancy_)
      {
        // The decision on whether or not to use the noise summary is made based on the CMSSW version.
        // As of CMSSW_5_2_0, the HcalNoiseSummary contains the total number of HBHE hits, as well as number of hits > 1.5 GeV and some other info.
        // The boolean 'forceUseRecHitCollection_' can be used to override this automatic behavior, and to use the RecHit collection itself, regardless of CMSSW version.
 
 
        //
        //  Apply Filtering based on RecHit information in HBHERecHitcollection
        //
 
 
        if (useHcalNoiseSummary_==false || forceUseRecHitCollection_==true)
      {
        edm::Handle<HBHERecHitCollection> hbheRecHits;
        if (iEvent.getByToken(hbheToken_,hbheRecHits))
          {
            if (debug_) std::cout <<"Rechit size = "<<hbheRecHits->size()<<"  threshold = "<<minOccupiedHBHE_<<std::endl;
            if (hbheRecHits->size()>=minOccupiedHBHE_)
          {
            if (debug_) std::cout <<"<HcalLaserEventFilter>  Filtering because of large HBHE rechit size; "<<hbheRecHits->size()<<" rechits is greater than or equal to the allowed maximum of "<<minOccupiedHBHE_<<std::endl;
            filterDecision=false;
          }
          }
        else
          {
            if (debug_ && errorcount<maxerrormessage_)
          std::cout <<"<HcalLaserEventFilter::Error> No valid HBHERecHitCollection with label '"<<hbheInputLabel_<<"' found"<<std::endl;
            ++errorcount;
          }
      }
 
        //
        //  Apply Filtering based on RecHit information in HcalNoiseSummary object
        //
        else if (useHcalNoiseSummary_==true || forceUseHcalNoiseSummary_==true)
      {
        Handle<HcalNoiseSummary> hSummary;
        if (iEvent.getByToken(hcalNoiseSummaryToken_,hSummary)) // get by label, usually with label 'hcalnoise'
          {
            if (debug_)  std::cout << " RECHIT SIZE (from HcalNoiseSummary) = "<<hSummary->GetRecHitCount()<<"  threshold = "<<minOccupiedHBHE_<<std::endl;
            if (hSummary->GetRecHitCount() >= (int)minOccupiedHBHE_)
          {
            if (debug_) std::cout <<"<HcalLaserEventFilter>  Filtering because of large HBHE rechit size in HcalNoiseSummary; "<<hSummary->GetRecHitCount()<<" rechits is greater than or equal to the allowed maximum of "<<minOccupiedHBHE_<<std::endl;
            filterDecision=false;
          }
          }
        else
          {
            if (debug_ && errorcount<maxerrormessage_)
          std::cout <<"<HcalLaserEventFilter::Error> No valid HcalNoiseSummary with label '"<<hcalNoiseSummaryLabel_<<"' found"<<std::endl;
            ++errorcount;
          }
      }
      }// if (vetoByHBHEOccupancy_)
 
    // Reverse decision, if specified by user
    if (reverseFilter_)
      filterDecision=!filterDecision;
 
    iEvent.put( std::auto_ptr<bool>(new bool(filterDecision)) );
 
    return taggingMode_ || filterDecision;
 }

std::vector< int > HcalLaserEventFilter::GetCMSSWVersion ( std::string const & instring )

private

Definition at line 288 of file HcalLaserEventFilter.cc.

References prof2calltree::prefix, AlCaHLTBitMon_QueryRunRegistry::string, lumiQTWidget::t, and groupFilesInBlocks::temp.

Referenced by beginJob().

 {
   std::vector <int> temp;
 
 
   std::string prefix;
   std::string v1, v2, v3;
 
   std::istringstream oss(instring);
   getline(oss, prefix,'_');
   getline(oss, v1,'_');
   getline(oss, v2,'_');
   getline(oss, v3,'_');
 
   std::stringstream buffer(v1);
   int t;
   buffer>>t;
   temp.push_back(t);
   buffer.str();
   buffer<<v2;
   buffer>>t;
   temp.push_back(t);
   buffer.str();
   buffer<<v3;
   buffer>>t;
   temp.push_back(t);
 
   //std::cout <<"PREFIX = "<<prefix<<" "<<temp[0]<<" "<<temp[1]<<" "<<temp[2]<<std::endl;
   //( ex:  PREFIX = "CMSSW 5 5 5  )
   return temp;
 }

bool HcalLaserEventFilter::IsGreaterThanMinCMSSWVersion ( std::vector< int > const & currentVersion )

private

Definition at line 320 of file HcalLaserEventFilter.cc.

References minVersion_.

Referenced by beginJob().

 {
   // Returns false if current version is less than min version
   // Otherwise, returns true
   // Assumes CMSSW versioning X_Y_Z
 
 
 
   // Compare X
   if (currentVersion[0]<minVersion_[0]) return false;
   if (currentVersion[0]>minVersion_[0]) return true;
   // If neither is true, first value of CMSSW versions are the same
 
   // Compare Y
   if (currentVersion[1]<minVersion_[1]) return false;
   if (currentVersion[1]>minVersion_[1]) return true;
 
   // Compare Z
   if (currentVersion[2]<minVersion_[2]) return false;
   if (currentVersion[2]>minVersion_[2]) return true;
 
   return true; // versions are identical
 }

Member Data Documentation

const bool HcalLaserEventFilter::debug_

private

Definition at line 75 of file HcalLaserEventFilter.cc.

Referenced by filter().

int HcalLaserEventFilter::errorcount

private

Definition at line 90 of file HcalLaserEventFilter.cc.

Referenced by filter(), and HcalLaserEventFilter().

bool HcalLaserEventFilter::forceUseHcalNoiseSummary_

private

Definition at line 96 of file HcalLaserEventFilter.cc.

Referenced by filter().

bool HcalLaserEventFilter::forceUseRecHitCollection_

private

Definition at line 95 of file HcalLaserEventFilter.cc.

Referenced by filter().

const edm::InputTag HcalLaserEventFilter::hbheInputLabel_

private

Definition at line 82 of file HcalLaserEventFilter.cc.

Referenced by filter().

edm::EDGetTokenT<HBHERecHitCollection> HcalLaserEventFilter::hbheToken_

private

Definition at line 83 of file HcalLaserEventFilter.cc.

Referenced by filter().

const edm::InputTag HcalLaserEventFilter::hcalNoiseSummaryLabel_

private

Definition at line 84 of file HcalLaserEventFilter.cc.

Referenced by filter().

edm::EDGetTokenT<HcalNoiseSummary> HcalLaserEventFilter::hcalNoiseSummaryToken_

private

Definition at line 85 of file HcalLaserEventFilter.cc.

Referenced by filter().

int HcalLaserEventFilter::maxerrormessage_

private

Definition at line 91 of file HcalLaserEventFilter.cc.

Referenced by filter().

const unsigned int HcalLaserEventFilter::minOccupiedHBHE_

private

Definition at line 72 of file HcalLaserEventFilter.cc.

Referenced by filter().

std::vector<int> HcalLaserEventFilter::minVersion_

private

Definition at line 97 of file HcalLaserEventFilter.cc.

Referenced by beginJob(), and IsGreaterThanMinCMSSWVersion().

const bool HcalLaserEventFilter::reverseFilter_

private

Definition at line 79 of file HcalLaserEventFilter.cc.

Referenced by filter().

std::vector<std::pair<edm::RunNumber_t,edm::EventNumber_t> > HcalLaserEventFilter::RunEventData_

private

Definition at line 68 of file HcalLaserEventFilter.cc.

Referenced by filter(), and HcalLaserEventFilter().

const bool HcalLaserEventFilter::taggingMode_

private

Definition at line 87 of file HcalLaserEventFilter.cc.

Referenced by filter().

bool HcalLaserEventFilter::useHcalNoiseSummary_

private

Definition at line 94 of file HcalLaserEventFilter.cc.

Referenced by beginJob(), and filter().

const bool HcalLaserEventFilter::vetoByHBHEOccupancy_

private

Definition at line 71 of file HcalLaserEventFilter.cc.

Referenced by filter().

const bool HcalLaserEventFilter::vetoByRunEventNumber_

private

Definition at line 67 of file HcalLaserEventFilter.cc.

Referenced by filter().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation