#include <MillePedeFileExtractor.h>

Inheritance diagram for MillePedeFileExtractor:

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

	~MillePedeFileExtractor () override

Public Member Functions inherited from edm::one::EDAnalyzer< edm::one::WatchLuminosityBlocks >
	EDAnalyzer ()=default

	EDAnalyzer (const EDAnalyzer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

const EDAnalyzer &	operator= (const EDAnalyzer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

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

	EDAnalyzerBase ()

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () const

	~EDAnalyzerBase () 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

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (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::array< std::vector< ModuleDescription const > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, 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

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

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::one::EDAnalyzerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	analyze (const edm::Event &, const edm::EventSetup &) override

void	beginLuminosityBlock (const edm::LuminosityBlock &, const edm::EventSetup &) override

void	endLuminosityBlock (const edm::LuminosityBlock &, const edm::EventSetup &) override

bool	enoughBinaries ()

bool	hasBinaryNumberLimit ()

Static Private Member Functions
static void	writeGzipped (const FileBlob &, const std::string &)

Private Attributes
edm::EDGetTokenT< FileBlobCollection >	fileBlobToken_

const int	maxNumberOfBinaries_

int	nBinaries_ {0}

const std::string	outputDir_

const std::string	outputFileName_

Additional Inherited Members
Public Types inherited from edm::one::EDAnalyzerBase
typedef EDAnalyzerBase	ModuleType

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)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

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)

void	resetItemsToGetFrom (BranchType iType)

Detailed Description

Definition at line 31 of file MillePedeFileExtractor.h.

Constructor & Destructor Documentation

◆ MillePedeFileExtractor()

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

explicit

Definition at line 16 of file MillePedeFileExtractor.cc.

References MillePedeFileExtractor_cfg::fileBlobInputTag, fileBlobToken_, edm::ParameterSet::getParameter(), hasBinaryNumberLimit(), and maxNumberOfBinaries_.

     : outputDir_(iConfig.getParameter<std::string>("fileDir")),
       outputFileName_(iConfig.getParameter<std::string>("outputBinaryFile")),
       maxNumberOfBinaries_(iConfig.getParameter<int>("maxNumberOfBinaries")) {
   auto fileBlobInputTag = iConfig.getParameter<edm::InputTag>("fileBlobInputTag");
   fileBlobToken_ = consumes<FileBlobCollection, edm::BranchType::InLumi>(fileBlobInputTag);
   if (hasBinaryNumberLimit()) {
     edm::LogInfo("MillePedeFileActions") << "Limiting the number of extracted binary files to " << maxNumberOfBinaries_;
   }
 }

◆ ~MillePedeFileExtractor()

MillePedeFileExtractor::~MillePedeFileExtractor ( )

override

Definition at line 27 of file MillePedeFileExtractor.cc.

27 {}

Member Function Documentation

◆ analyze()

void MillePedeFileExtractor::analyze	(	const edm::Event &	,
		const edm::EventSetup &
	)

inlineoverrideprivatevirtual

Implements edm::one::EDAnalyzerBase.

Definition at line 40 of file MillePedeFileExtractor.h.

40 {}

◆ beginLuminosityBlock()

void MillePedeFileExtractor::beginLuminosityBlock	(	const edm::LuminosityBlock &	,
		const edm::EventSetup &
	)

inlineoverrideprivate

Definition at line 38 of file MillePedeFileExtractor.h.

38 {}

◆ endLuminosityBlock()

void MillePedeFileExtractor::endLuminosityBlock	(	const edm::LuminosityBlock &	iLumi,
		const edm::EventSetup &
	)

overrideprivate

Definition at line 29 of file MillePedeFileExtractor.cc.

References mps_check::command, enoughBinaries(), fileBlobToken_, edm::LuminosityBlock::getByToken(), edm::HandleBase::isValid(), nBinaries_, outputDir_, outputFileName_, FileBlobCollection::size(), AlCaHLTBitMon_QueryRunRegistry::string, and writeGzipped().

                                                                                                      {
   if (enoughBinaries())
     return;
 
   // Create output directory if not available
   if (!outputDir_.empty()) {
     std::string command = "mkdir -p " + outputDir_;
     int shellReturn = gSystem->Exec(command.c_str());
     edm::LogInfo("MillePedeFileActions") << "@SUB=MillePedeFileExtractor::endLuminosityBlock"
                                          << "Command returns " << shellReturn;
   }
 
   // Getting our hands on the vector of FileBlobs
   edm::Handle<FileBlobCollection> fileBlobCollection;
   iLumi.getByToken(fileBlobToken_, fileBlobCollection);
   if (fileBlobCollection.isValid()) {
     // Logging the amount of FileBlobs in the vector
     edm::LogInfo("MillePedeFileActions") << "Root file contains " << fileBlobCollection->size() << " FileBlob(s).";
     // Loop over the FileBlobs in the vector, and write them to files:
     for (const auto& blob : *fileBlobCollection) {
       if (enoughBinaries())
         break;
       // We format the filename with a number, starting from 0 to the size of
       // our vector.
       // For this to work, the outputBinaryFile config parameter must contain a
       // formatting directive for a number, like %04d.
       char theNumberedOutputFileName[200];
       sprintf(theNumberedOutputFileName, outputFileName_.c_str(), nBinaries_);
 
       // Log the filename to which we will write...
       edm::LogInfo("MillePedeFileActions")
           << "Writing FileBlob file to file " << outputDir_ + theNumberedOutputFileName << ".";
 
       // ...and perform the writing operation.
       writeGzipped(blob, outputDir_ + theNumberedOutputFileName);
 
       ++nBinaries_;
     }
   } else {
     edm::LogError("MillePedeFileActions") << "Error: The root file does not contain any vector of FileBlob.";
   }
 }

◆ enoughBinaries()

bool MillePedeFileExtractor::enoughBinaries ( )

inlineprivate

Definition at line 42 of file MillePedeFileExtractor.h.

References hasBinaryNumberLimit(), maxNumberOfBinaries_, and nBinaries_.

Referenced by endLuminosityBlock().

42 { return (nBinaries_ >= maxNumberOfBinaries_) && hasBinaryNumberLimit(); }

MillePedeFileExtractor::maxNumberOfBinaries_

const int maxNumberOfBinaries_

Definition: MillePedeFileExtractor.h:52

MillePedeFileExtractor::nBinaries_

int nBinaries_

Definition: MillePedeFileExtractor.h:53

MillePedeFileExtractor::hasBinaryNumberLimit

bool hasBinaryNumberLimit()

Definition: MillePedeFileExtractor.h:43

◆ fillDescriptions()

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

static

Definition at line 92 of file MillePedeFileExtractor.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, HLT_2022v12_cff::InputTag, edm::ConfigurationDescriptions::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                         {
   edm::ParameterSetDescription desc;
 
   desc.add<std::string>("fileDir", "")
       ->setComment(
           "Keep the fileDir empty if you want to write to the current "
           "directory.");
 
   desc.add<std::string>("outputBinaryFile", "milleBinary%04d.dat")
       ->setComment(
           "Base filename of the files that will be created. This must "
           "contain "
           "a placeholder for an index number in the standard C formatting "
           "style, like %04d.");
 
   desc.add<edm::InputTag>("fileBlobInputTag", edm::InputTag("millePedeFileConverter", ""))
       ->setComment(
           "Name of the module that should have generated the blob in the "
           "root file. Make sure you overwrite this, if you have changed "
           "this is the configuration of the MillePedeFileConverter.");
 
   desc.add<int>("maxNumberOfBinaries", 1000)
       ->setComment(
           "Number of binaries to be extracted from the input files. "
           "Use a negative value to apply no limit.");
 
   descriptions.add("millePedeFileExtractor", desc);
   descriptions.setComment(
       "This is the generic cfi file for the "
       "MillePedeFileExtractor");
 }

◆ hasBinaryNumberLimit()

bool MillePedeFileExtractor::hasBinaryNumberLimit ( )

inlineprivate

Definition at line 43 of file MillePedeFileExtractor.h.

References maxNumberOfBinaries_.

Referenced by enoughBinaries(), and MillePedeFileExtractor().

43 { return maxNumberOfBinaries_ > -1; }

MillePedeFileExtractor::maxNumberOfBinaries_

const int maxNumberOfBinaries_

Definition: MillePedeFileExtractor.h:52

◆ writeGzipped()

void MillePedeFileExtractor::writeGzipped	(	const FileBlob &	blob,
		const std::string &	fileName
	)

staticprivate

Definition at line 72 of file MillePedeFileExtractor.cc.

References MillePedeFileConverter_cfg::fileName, personalPlayback::fp, FileBlob::getUncompressedBlob(), and spu::zerr().

Referenced by endLuminosityBlock().

                                                                                          {
   // - use zlib directly to avoid boost dependencies for this simple task
   // - zlib and gzip compression differ -> get uncompressed blob first
   auto uncompressedBlob = blob.getUncompressedBlob();
   gzFile fp = gzopen(fileName.c_str(), "wb");
   if (fp == nullptr) {
     edm::LogError("MillePedeFileActions") << "Problem while opening gzipped file '" << fileName << "'.";
   }
   auto nBytes = gzwrite(fp, &uncompressedBlob->front(), uncompressedBlob->size());
   if (nBytes == 0 || nBytes != static_cast<decltype(nBytes)>(uncompressedBlob->size())) {
     edm::LogError("MillePedeFileActions") << "Problem while writing FileBlob to gzipped file '" << fileName << "'.";
   }
   auto zerr = gzclose(fp);
   if (zerr != 0) {
     edm::LogError("MillePedeFileActions") << "Problem while closing gzipped file '" << fileName << "'.";
   }
 }

Member Data Documentation

◆ fileBlobToken_

edm::EDGetTokenT<FileBlobCollection> MillePedeFileExtractor::fileBlobToken_

private

Definition at line 50 of file MillePedeFileExtractor.h.

Referenced by endLuminosityBlock(), and MillePedeFileExtractor().

◆ maxNumberOfBinaries_

const int MillePedeFileExtractor::maxNumberOfBinaries_

private

Definition at line 52 of file MillePedeFileExtractor.h.

Referenced by enoughBinaries(), hasBinaryNumberLimit(), and MillePedeFileExtractor().

◆ nBinaries_

int MillePedeFileExtractor::nBinaries_ {0}

private

Definition at line 53 of file MillePedeFileExtractor.h.

Referenced by endLuminosityBlock(), and enoughBinaries().

◆ outputDir_

const std::string MillePedeFileExtractor::outputDir_

private

Definition at line 47 of file MillePedeFileExtractor.h.

Referenced by endLuminosityBlock(), and batchmanager.BatchManager::PrepareJob().

◆ outputFileName_

const std::string MillePedeFileExtractor::outputFileName_

private

Definition at line 48 of file MillePedeFileExtractor.h.

Referenced by endLuminosityBlock().

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MillePedeFileExtractor()

◆ ~MillePedeFileExtractor()

Member Function Documentation

◆ analyze()

◆ beginLuminosityBlock()

◆ endLuminosityBlock()

◆ enoughBinaries()

◆ fillDescriptions()

◆ hasBinaryNumberLimit()

◆ writeGzipped()

Member Data Documentation

◆ fileBlobToken_

◆ maxNumberOfBinaries_

◆ nBinaries_

◆ outputDir_

◆ outputFileName_