HcalLaserEventFilter2012 Class Reference

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

Inheritance diagram for HcalLaserEventFilter2012:

Public Member Functions
	HcalLaserEventFilter2012 (const edm::ParameterSet &)
	~HcalLaserEventFilter2012 () override
Public Member Functions inherited from edm::EDFilter
	EDFilter ()
SerialTaskQueue *	globalLuminosityBlocksQueue ()
SerialTaskQueue *	globalRunsQueue ()
ModuleDescription const &	moduleDescription () const
	~EDFilter () override
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
	~ProducerBase () noexcept(false) override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

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 &)
static bool	wantsGlobalLuminosityBlocks ()
static bool	wantsGlobalRuns ()
static bool	wantsStreamLuminosityBlocks ()
static bool	wantsStreamRuns ()

Public Attributes
friend	HcalLaserEventFiltProducer2012

Private Types
typedef std::vector< std::string >	strVec
typedef std::vector< std::string >::iterator	strVecI

Private Member Functions
void	addEventString (const std::string &eventString)
void	endJob () override
bool	filter (edm::Event &, const edm::EventSetup &) override
void	readEventListFile (const std::string &eventFileName)

Private Attributes
std::vector< std::string >	EventList_
bool	forceFilterTrue_
int	maxrun_
int	maxRunInFile
int	minrun_
int	minRunInFile
std::ofstream	outfile_
std::string	prefix_
bool	verbose_
bool	WriteBadToFile_

Additional Inherited Members
Public Types inherited from edm::EDFilter
typedef EDFilter	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >>
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 ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
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: [Remove known HCAL laser events in 2012 data]

Implementation: [Notes on implementation]

Definition at line 41 of file HcalLaserEventFilter2012.h.

Member Typedef Documentation

typedef std::vector< std::string > HcalLaserEventFilter2012::strVec

private

Definition at line 58 of file HcalLaserEventFilter2012.h.

typedef std::vector< std::string >::iterator HcalLaserEventFilter2012::strVecI

private

Definition at line 59 of file HcalLaserEventFilter2012.h.

Constructor & Destructor Documentation

HcalLaserEventFilter2012::HcalLaserEventFilter2012 ( const edm::ParameterSet &  ps )

explicit

Definition at line 25 of file HcalLaserEventFilter2012.cc.

References edm::FileInPath::fullPath(), edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), jetUpdater_cfi::sort, and AlCaHLTBitMon_QueryRunRegistry::string.

{
  verbose_ = ps.getUntrackedParameter<bool>("verbose",false);
  prefix_  = ps.getUntrackedParameter<std::string>("prefix","");
  minrun_  = ps.getUntrackedParameter<int>("minrun",-1);
  maxrun_  = ps.getUntrackedParameter<int>("maxrun",-1);
  WriteBadToFile_=ps.getUntrackedParameter<bool>("WriteBadToFile",false);
  if (WriteBadToFile_)
    outfile_.open("badHcalLaserList_eventfilter.txt");
  forceFilterTrue_=ps.getUntrackedParameter<bool>("forceFilterTrue",false);

  minRunInFile=999999; maxRunInFile=1;
  string eventFileName0=ps.getParameter<string>("eventFileName");
  string eventFileName = edm::FileInPath(eventFileName0).fullPath();

  if (verbose_) edm::LogInfo("HcalLaserEventFilter2012") << "HCAL laser event list from file "<<eventFileName;
  readEventListFile(eventFileName);
  std::sort(EventList_.begin(), EventList_.end());
  if (verbose_) edm::LogInfo("HcalLaserEventFilter2012")<<" A total of "<<EventList_.size()<<" listed HCAL laser events found in given run range";
  if (minrun_==-1 || minrun_<minRunInFile) minrun_=minRunInFile;
  if (maxrun_==-1 || maxrun_>maxRunInFile) maxrun_=maxRunInFile;
}

HcalLaserEventFilter2012::~HcalLaserEventFilter2012 ( )

override

Definition at line 152 of file HcalLaserEventFilter2012.cc.

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

}

Member Function Documentation

void HcalLaserEventFilter2012::addEventString ( const std::string &  eventString )

private

Some event numbers are less than 0? -v1:201278:2145:-2130281065 – due to events being dumped out as ints, not uints!

Some event numbers are less than 0? -v1:201278:2145:-2130281065

Definition at line 48 of file HcalLaserEventFilter2012.cc.

References runEdmFileComparison::found, eostools::ls(), and writedatasetfile::run.

{
  // Loop through list of bad events, and if run is in allowed range, add bad event to EventList
  int run=0;
  unsigned int ls=0;
  unsigned int event=0;
  // Check that event list object is in correct form
  size_t found = eventString.find(":");  // find first colon
  if (found!=std::string::npos)
    run=atoi((eventString.substr(0,found)).c_str());  // convert to run
  else
    {
      edm::LogError("HcalLaserEventFilter2012")<<"  Unable to parse Event list input '"<<eventString<<"' for run number!";
      return;
    }
  size_t found2 = eventString.find(":",found+1);  // find second colon
  if (found2!=std::string::npos)
    {
      ls=atoi((eventString.substr(found+1,(found2-found-1))).c_str());  // convert to ls
      event=atoi((eventString.substr(found2+1)).c_str()); // convert to event
      if (ls==0 || event==0) edm::LogWarning("HcalLaserEventFilter2012")<<"  Strange lumi, event numbers for input '"<<eventString<<"'";
    }
  else
    {
      edm::LogError("HcalLaserEventFilter2012")<<"Unable to parse Event list input '"<<eventString<<"' for run number!";
      return;
    }
  // If necessary, check that run is within allowed range
  if (minrun_>-1 && run<minrun_)
    {
      if (verbose_)  edm::LogInfo("HcalLaserEventFilter2012") <<"Skipping Event list input '"<<eventString<<"' because it is less than minimum run # "<<minrun_;
      return;
    }
  if (maxrun_>-1 && run>maxrun_)
    {
      if (verbose_) edm::LogInfo("HcalLaserEventFilter2012") <<"Skipping Event list input '"<<eventString<<"' because it is greater than maximum run # "<<maxrun_;
      return;
    }
  if (minRunInFile>run) minRunInFile=run;
  if (maxRunInFile<run) maxRunInFile=run;
  // Now add event to Event List
  EventList_.push_back(eventString);
}

void HcalLaserEventFilter2012::endJob ( void  )

overrideprivatevirtual

Reimplemented from edm::EDFilter.

Definition at line 198 of file HcalLaserEventFilter2012.cc.

                                 {
 if (WriteBadToFile_) outfile_.close();
}

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

static

Definition at line 204 of file HcalLaserEventFilter2012.cc.

References edm::ConfigurationDescriptions::addDefault(), DEFINE_FWK_MODULE, 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 HcalLaserEventFilter2012::filter ( edm::Event &  iEvent, const edm::EventSetup &  iSetup  )

overrideprivate

Definition at line 167 of file HcalLaserEventFilter2012.cc.

References gather_cfg::cout, edm::EventID::event(), edm::EventBase::id(), pfDeepBoostedJetPreprocessParams_cfi::lower_bound, edm::EventBase::luminosityBlock(), writedatasetfile::run, and edm::EventID::run().

Referenced by Vispa.Plugins.Browser.BrowserTabController.BrowserTabController::filter(), Vispa.Plugins.Browser.BrowserTabController.BrowserTabController::find(), Vispa.Plugins.Browser.BrowserTabController.BrowserTabController::setDataAccessor(), and Vispa.Plugins.Browser.BrowserTabController.BrowserTabController::switchCenterView().

{
  int run = iEvent.id().run();
  // if run is outside filter range, then always return true
  if (minrun_>-1 && run<minrun_) return true;
  if (maxrun_>-1 && run>maxrun_) return true;

  // Okay, now create a string object for this run:ls:event
  std::stringstream thisevent;
  thisevent<<run<<":"<<iEvent.luminosityBlock()<<":"<<iEvent.id().event();

  // Event not found in bad list; it is a good event
  strVecI it = std::lower_bound(EventList_.begin(), EventList_.end(), thisevent.str());
  if (it == EventList_.end() || thisevent.str() < *it) return true;
  // Otherwise, this is a bad event
  // if verbose, dump out event info
  // Dump out via cout, or via LogInfo?  For now, use cout
  if (verbose_) std::cout <<prefix_<<thisevent.str()<<std::endl;

  // To use if we decide on LogInfo:
  // if (verbose_) edm::LogInfo(prefix_)<<thisevent.str();
  
  // Write bad event to file 
  if (WriteBadToFile_)
    outfile_<<iEvent.id().run()<<":"<<iEvent.luminosityBlock()<<":"<<iEvent.id().event()<<std::endl;
  if (forceFilterTrue_) return true; // if special input boolean set, always return true, regardless of filter decision
  return false;
}

void HcalLaserEventFilter2012::readEventListFile ( const std::string &  eventFileName )

private

Definition at line 96 of file HcalLaserEventFilter2012.cc.

References edmScanValgrind::buffer, FrontierConditions_GlobalTag_cff::file, mps_fire::i, and LENGTH.

{
  gzFile  file = gzopen (eventFileName.c_str(), "r");
  if (! file) {
    edm::LogError("HcalLaserEventFilter2012")<<"  Unable to open event list file "<<eventFileName;
    return;
  }
  string b2;
  int err;                    
  int bytes_read;
  char buffer[LENGTH];
  unsigned int i;
  char * pch;

  while (true) {
    bytes_read = gzread (file, buffer, LENGTH - 1);
    buffer[bytes_read] = '\0';
    i=0;
    char* saveptr;
    pch = strtok_r (buffer,"\n",&saveptr);
    if (buffer[0] == '\n' ) {
      addEventString(b2);
      ++i;
    } else b2+=pch;
  
    while (pch != nullptr)
    {
      i+=strlen(pch)+1;
      if (i>b2.size()) b2= pch;
      if (i==(LENGTH-1)) {
     if ((buffer[LENGTH-2] == '\n' )|| (buffer[LENGTH-2] == '\0' )){
          addEventString(b2);
          b2="";
    }
      } else if (i<LENGTH) {
    addEventString(b2);
      } 
      pch = strtok_r (nullptr, "\n", &saveptr);
    }
    if (bytes_read < LENGTH - 1) {
      if (gzeof (file)) break;
        else {
          const char * error_string;
          error_string = gzerror (file, & err);
          if (err) {
        edm::LogError("HcalLaserEventFilter2012")<<"Error while reading gzipped file:  "<<error_string;
            return;
          }
        }
    }
  }
  gzclose (file);
  return;
}

Member Data Documentation

std::vector< std::string > HcalLaserEventFilter2012::EventList_

private

Definition at line 61 of file HcalLaserEventFilter2012.h.

bool HcalLaserEventFilter2012::forceFilterTrue_

private

Definition at line 72 of file HcalLaserEventFilter2012.h.

friend HcalLaserEventFilter2012::HcalLaserEventFiltProducer2012

Definition at line 48 of file HcalLaserEventFilter2012.h.

int HcalLaserEventFilter2012::maxrun_

private

Definition at line 68 of file HcalLaserEventFilter2012.h.

int HcalLaserEventFilter2012::maxRunInFile

private

Definition at line 69 of file HcalLaserEventFilter2012.h.

int HcalLaserEventFilter2012::minrun_

private

Definition at line 67 of file HcalLaserEventFilter2012.h.

int HcalLaserEventFilter2012::minRunInFile

private

Definition at line 69 of file HcalLaserEventFilter2012.h.

std::ofstream HcalLaserEventFilter2012::outfile_

private

Definition at line 73 of file HcalLaserEventFilter2012.h.

std::string HcalLaserEventFilter2012::prefix_

private

Definition at line 63 of file HcalLaserEventFilter2012.h.

bool HcalLaserEventFilter2012::verbose_

private

Definition at line 62 of file HcalLaserEventFilter2012.h.

bool HcalLaserEventFilter2012::WriteBadToFile_

private

Definition at line 71 of file HcalLaserEventFilter2012.h.