Inheritance diagram for NanoAODRNTupleOutputModule:

Classes
class	CommonEventFields

Public Member Functions
	NanoAODRNTupleOutputModule (edm::ParameterSet const &pset)

	~NanoAODRNTupleOutputModule () override

Public Member Functions inherited from edm::one::OutputModule<>
SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

const OutputModule &	operator= (const OutputModule &)=delete

	OutputModule (edm::ParameterSet const &iPSet)

	OutputModule (const OutputModule &)=delete

bool	wantsGlobalLuminosityBlocks () const noexcept final

bool	wantsGlobalRuns () const noexcept final

bool	wantsInputProcessBlocks () const noexcept final

bool	wantsProcessBlocks () const noexcept final

Public Member Functions inherited from edm::one::OutputModuleBase
OutputModuleBase &	operator= (OutputModuleBase const &)=delete

	OutputModuleBase (ParameterSet const &pset)

	OutputModuleBase (OutputModuleBase const &)=delete

SharedResourcesAcquirer &	sharedResourcesAcquirer ()

SubProcessParentageHelper const *	subProcessParentageHelper () const

bool	wantsStreamLuminosityBlocks () const noexcept

bool	wantsStreamRuns () const noexcept

Public Member Functions inherited from edm::core::OutputModuleCore
BranchIDLists const *	branchIDLists () const

void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

std::array< bool, NumBranchTypes > const &	hasNewlyDroppedBranch () const

SelectedProductsForBranchType const &	keptProducts () const

int	maxEvents () const

const ModuleDescription &	moduleDescription () const

OutputModuleCore &	operator= (OutputModuleCore const &)=delete

	OutputModuleCore (ParameterSet const &pset)

	OutputModuleCore (OutputModuleCore const &)=delete

OutputProcessBlockHelper const &	outputProcessBlockHelper () const

std::string const &	processName () const

int	remainingEvents () const

bool	selected (BranchDescription const &desc) const

void	selectProducts (ProductRegistry const &preg, ThinnedAssociationsHelper const &, ProcessBlockHelperBase const &)

ThinnedAssociationsHelper const *	thinnedAssociationsHelper () const

bool	wantAllEvents () const

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

ESResolverIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESResolverIndex > 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

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

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)

virtual	~EDConsumerBase () noexcept(false)

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

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

static void	fillDescription (ParameterSetDescription &desc, std::vector< std::string > const &iDefaultOutputCommands=ProductSelectorRules::defaultSelectionStrings())

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &)

Private Member Functions
void	initializeNTuple (edm::EventForOutput const &e)

bool	isFileOpen () const override

void	openFile (edm::FileBlock const &) override

void	reallyCloseFile () override

void	write (edm::EventForOutput const &e) override

void	writeLuminosityBlock (edm::LuminosityBlockForOutput const &) override

void	writeProvenance ()

void	writeRun (edm::RunForOutput const &) override

Private Attributes
class NanoAODRNTupleOutputModule::CommonEventFields	m_commonFields

std::string	m_compressionAlgorithm

int	m_compressionLevel

EventStringOutputFields	m_evstrings

std::unique_ptr< TFile >	m_file

std::string	m_fileName

edm::JobReport::Token	m_jrToken

std::string	m_logicalFileName

LumiNTuple	m_lumi

std::vector< std::pair< std::string, edm::EDGetToken > >	m_nanoMetadata

std::unique_ptr< RNTupleWriter >	m_ntuple

edm::ProcessHistoryRegistry	m_processHistoryRegistry

RunNTuple	m_run

TableCollectionSet	m_tables

std::vector< TriggerOutputFields >	m_triggers

bool	m_writeProvenance

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

Public Types inherited from edm::core::OutputModuleCore
typedef OutputModuleCore	ModuleType

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Protected Member Functions inherited from edm::one::OutputModuleBase
void	configure (OutputModuleDescription const &desc)

void	doBeginJob ()

bool	doEvent (EventTransitionInfo const &, ActivityRegistry , ModuleCallingContext const )

void	doPreallocate (PreallocationConfiguration const &)

Protected Member Functions inherited from edm::core::OutputModuleCore
void	configure (OutputModuleDescription const &desc)

ModuleDescription const &	description () const

void	doAccessInputProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

void	doBeginJob_ ()

bool	doBeginLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

void	doBeginProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

bool	doBeginRun (RunTransitionInfo const &, ModuleCallingContext const *)

void	doEndJob ()

bool	doEndLuminosityBlock (LumiTransitionInfo const &, ModuleCallingContext const *)

void	doEndProcessBlock (ProcessBlockPrincipal const &, ModuleCallingContext const *)

bool	doEndRun (RunTransitionInfo const &, ModuleCallingContext const *)

bool	doEvent_ (EventTransitionInfo const &, ActivityRegistry , ModuleCallingContext const )

void	doPreallocate_ (PreallocationConfiguration const &)

std::map< BranchID::value_type, BranchID::value_type > const &	droppedBranchIDToKeptBranchID ()

virtual void	preallocLumis (unsigned int)

ParameterSetID	selectorConfig () const

void	setEventSelectionInfo (std::map< std::string, std::vector< std::pair< std::string, int >>> const &outputModulePathPositions, bool anyProductProduced)

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 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)

Protected Attributes inherited from edm::core::OutputModuleCore
std::atomic< int >	remainingEvents_

Detailed Description

Definition at line 49 of file NanoAODRNTupleOutputModule.cc.

Constructor & Destructor Documentation

◆ NanoAODRNTupleOutputModule()

NanoAODRNTupleOutputModule::NanoAODRNTupleOutputModule ( edm::ParameterSet const & pset )

Definition at line 106 of file NanoAODRNTupleOutputModule.cc.

     : edm::one::OutputModuleBase::OutputModuleBase(pset),
       edm::one::OutputModule<>(pset),
       m_fileName(pset.getUntrackedParameter<std::string>("fileName")),
       m_logicalFileName(pset.getUntrackedParameter<std::string>("logicalFileName")),
       m_compressionAlgorithm(pset.getUntrackedParameter<std::string>("compressionAlgorithm")),
       m_compressionLevel(pset.getUntrackedParameter<int>("compressionLevel")),
       m_writeProvenance(pset.getUntrackedParameter<bool>("saveProvenance", true)),
       m_processHistoryRegistry() {}

◆ ~NanoAODRNTupleOutputModule()

NanoAODRNTupleOutputModule::~NanoAODRNTupleOutputModule ( )

override

Definition at line 116 of file NanoAODRNTupleOutputModule.cc.

116 {}

Member Function Documentation

◆ fillDescriptions()

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

static

Definition at line 262 of file NanoAODRNTupleOutputModule.cc.

References edm::ConfigurationDescriptions::addDefault(), EgammaPostProcessor_cfi::dataSet, submitPVResolutionJobs::desc, edm::core::OutputModuleCore::fillDescription(), runTheMatrix::keep, edm::ParameterSetDescription::setAllowAnything(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                             {
   edm::ParameterSetDescription desc;
 
   desc.addUntracked<std::string>("fileName");
   desc.addUntracked<std::string>("logicalFileName", "");
   desc.addUntracked<int>("compressionLevel", 9)->setComment("ROOT compression level of output file.");
   desc.addUntracked<std::string>("compressionAlgorithm", "ZLIB")
       ->setComment(
           "Algorithm used to "
           "compress data in the ROOT output file, allowed values are ZLIB and LZMA");
   desc.addUntracked<bool>("saveProvenance", true)
       ->setComment("Save process provenance information, e.g. for edmProvDump");
   const std::vector<std::string> keep = {"drop *",
                                          "keep nanoaodFlatTable_*Table_*_*",
                                          "keep edmTriggerResults_*_*_*",
                                          "keep String_*_genModel_*",
                                          "keep nanoaodMergeableCounterTable_*Table_*_*",
                                          "keep nanoaodUniqueString_nanoMetadata_*_*"};
   edm::one::OutputModule<>::fillDescription(desc, keep);
 
   //Used by Workflow management for their own meta data
   edm::ParameterSetDescription dataSet;
   dataSet.setAllowAnything();
   desc.addUntracked<edm::ParameterSetDescription>("dataset", dataSet)
       ->setComment("PSet is only used by Data Operations and not by this module.");
 
   edm::ParameterSetDescription branchSet;
   branchSet.setAllowAnything();
   desc.add<edm::ParameterSetDescription>("branches", branchSet);
 
   descriptions.addDefault(desc);
 }

◆ initializeNTuple()

void NanoAODRNTupleOutputModule::initializeNTuple ( edm::EventForOutput const & e )

private

Definition at line 187 of file NanoAODRNTupleOutputModule.cc.

References TableCollectionSet::add(), EventStringOutputFields::createFields(), NanoAODRNTupleOutputModule::CommonEventFields::createFields(), TableCollectionSet::createFields(), Exception, patZpeak::handle, iEvent, edm::InEvent, runTheMatrix::keep, edm::core::OutputModuleCore::keptProducts(), m_commonFields, m_evstrings, m_file, m_ntuple, m_tables, m_triggers, MakeRNTupleWriter, ReggeGribovPartonMC_EposLHC_2760GeV_PbPb_cfi::model, eostools::move(), AlcaSiPixelAliHarvester0T_cff::options, EventStringOutputFields::registerToken(), and unpackBuffers-CaloStage2::token.

Referenced by write().

                                                                                  {
   // set up RNTuple schema
   auto model = RNTupleModel::Create();
   m_commonFields.createFields(*model);
 
   const auto& keeps = keptProducts();
   for (const auto& keep : keeps[edm::InEvent]) {
     if (keep.first->className() == "nanoaod::FlatTable") {
       edm::Handle<nanoaod::FlatTable> handle;
       const auto& token = keep.second;
       iEvent.getByToken(token, handle);
       m_tables.add(token, *handle);
     } else if (keep.first->className() == "edm::TriggerResults") {
       m_triggers.emplace_back(TriggerOutputFields(keep.first->processName(), keep.second));
     } else if (keep.first->className() == "std::basic_string<char,std::char_traits<char> >" &&
                keep.first->productInstanceName() == "genModel") {
       m_evstrings.registerToken(keep.second);
     } else {
       throw cms::Exception("Configuration", "NanoAODOutputModule cannot handle class " + keep.first->className());
     }
   }
   m_tables.createFields(iEvent, *model);
   for (auto& trigger : m_triggers) {
     trigger.createFields(iEvent, *model);
   }
   m_evstrings.createFields(*model);
   // TODO use Append
   RNTupleWriteOptions options;
   options.SetCompression(m_file->GetCompressionSettings());
   m_ntuple = MakeRNTupleWriter(std::move(model), std::make_unique<RPageSinkFile>("Events", *m_file, options));
 }

◆ isFileOpen()

bool NanoAODRNTupleOutputModule::isFileOpen ( ) const

overrideprivatevirtual

Reimplemented from edm::core::OutputModuleCore.

Definition at line 145 of file NanoAODRNTupleOutputModule.cc.

References m_ntuple.

145 { return nullptr != m_ntuple.get(); }

NanoAODRNTupleOutputModule::m_ntuple

std::unique_ptr< RNTupleWriter > m_ntuple

Definition: NanoAODRNTupleOutputModule.cc:76

◆ openFile()

void NanoAODRNTupleOutputModule::openFile ( edm::FileBlock const & )

overrideprivatevirtual

Reimplemented from edm::core::OutputModuleCore.

Definition at line 147 of file NanoAODRNTupleOutputModule.cc.

References edm::createGlobalIdentifier(), edm::core::OutputModuleCore::description(), cms::Digest::digest(), Exception, edm::InRun, runTheMatrix::keep, edm::core::OutputModuleCore::keptProducts(), m_compressionAlgorithm, m_compressionLevel, m_file, m_fileName, m_jrToken, m_logicalFileName, m_nanoMetadata, m_run, HerwigMaxPtPartonFilter_cfi::moduleLabel, RunNTuple::registerToken(), AlCaHLTBitMon_QueryRunRegistry::string, and cms::MD5Result::toString().

                                                              {
   m_file = std::make_unique<TFile>(m_fileName.c_str(), "RECREATE", "", m_compressionLevel);
   edm::Service<edm::JobReport> jr;
   cms::Digest branchHash;
   m_jrToken = jr->outputFileOpened(m_fileName,
                                    m_logicalFileName,
                                    std::string(),
                                    // TODO check if needed
                                    //m_fakeName ? "PoolOutputModule" : "NanoAODOutputModule",
                                    "NanoAODRNTupleOutputModule",
                                    description().moduleLabel(),
                                    edm::createGlobalIdentifier(),
                                    std::string(),
                                    branchHash.digest().toString(),
                                    std::vector<std::string>());
 
   if (m_compressionAlgorithm == "ZLIB") {
     m_file->SetCompressionAlgorithm(ROOT::kZLIB);
   } else if (m_compressionAlgorithm == "LZMA") {
     m_file->SetCompressionAlgorithm(ROOT::kLZMA);
   } else {
     throw cms::Exception("Configuration")
         << "NanoAODOutputModule configured with unknown compression algorithm '" << m_compressionAlgorithm << "'\n"
         << "Allowed compression algorithms are ZLIB and LZMA\n";
   }
 
   const auto& keeps = keptProducts();
   for (const auto& keep : keeps[edm::InRun]) {
     if (keep.first->className() == "nanoaod::MergeableCounterTable") {
       m_run.registerToken(keep.second);
     } else if (keep.first->className() == "nanoaod::UniqueString" && keep.first->moduleLabel() == "nanoMetadata") {
       m_nanoMetadata.emplace_back(keep.first->productInstanceName(), keep.second);
     } else {
       throw cms::Exception(
           "Configuration",
           "NanoAODRNTupleOutputModule cannot handle class " + keep.first->className() + " in Run branch");
     }
   }
 }

◆ reallyCloseFile()

void NanoAODRNTupleOutputModule::reallyCloseFile ( )

overrideprivatevirtual

Reimplemented from edm::core::OutputModuleCore.

Definition at line 237 of file NanoAODRNTupleOutputModule.cc.

References LumiNTuple::finalizeWrite(), RunNTuple::finalizeWrite(), m_file, m_jrToken, m_lumi, m_ntuple, m_run, m_writeProvenance, edm::JobReport::outputFileClosed(), and writeProvenance().

                                                  {
   if (m_writeProvenance) {
     writeProvenance();
   }
   // write ntuple to disk by calling the RNTupleWriter destructor
   m_ntuple.reset();
   m_lumi.finalizeWrite();
   m_run.finalizeWrite();
   m_file->Write();
   m_file->Close();
 
   edm::Service<edm::JobReport> jr;
   jr->outputFileClosed(m_jrToken);
 }

◆ write()

void NanoAODRNTupleOutputModule::write ( edm::EventForOutput const & e )

overrideprivatevirtual

Implements edm::core::OutputModuleCore.

Definition at line 219 of file NanoAODRNTupleOutputModule.cc.

References edm::JobReport::eventWrittenToFile(), EventStringOutputFields::fill(), NanoAODRNTupleOutputModule::CommonEventFields::fill(), TableCollectionSet::fill(), iEvent, initializeNTuple(), m_commonFields, m_evstrings, m_jrToken, m_ntuple, m_processHistoryRegistry, m_tables, m_triggers, and edm::ProcessHistoryRegistry::registerProcessHistory().

                                                                       {
   if (!m_ntuple) {
     initializeNTuple(iEvent);
   }
 
   edm::Service<edm::JobReport> jr;
   jr->eventWrittenToFile(m_jrToken, iEvent.id().run(), iEvent.id().event());
 
   m_commonFields.fill(iEvent.id());
   m_tables.fill(iEvent);
   for (auto& trigger : m_triggers) {
     trigger.fill(iEvent);
   }
   m_evstrings.fill(iEvent);
   m_ntuple->Fill();
   m_processHistoryRegistry.registerProcessHistory(iEvent.processHistory());
 }

◆ writeLuminosityBlock()

void NanoAODRNTupleOutputModule::writeLuminosityBlock ( edm::LuminosityBlockForOutput const & iLumi )

overrideprivatevirtual

Implements edm::core::OutputModuleCore.

Definition at line 118 of file NanoAODRNTupleOutputModule.cc.

References LumiNTuple::fill(), edm::LuminosityBlockForOutput::id(), m_file, m_jrToken, m_lumi, m_processHistoryRegistry, edm::OccurrenceForOutput::processHistory(), edm::ProcessHistoryRegistry::registerProcessHistory(), edm::JobReport::reportLumiSection(), edm::LuminosityBlockID::run(), and edm::LuminosityBlockID::value().

                                                                                               {
   edm::Service<edm::JobReport> jr;
   jr->reportLumiSection(m_jrToken, iLumi.id().run(), iLumi.id().value());
   m_lumi.fill(iLumi.id(), *m_file);
   m_processHistoryRegistry.registerProcessHistory(iLumi.processHistory());
 }

◆ writeProvenance()

void NanoAODRNTupleOutputModule::writeProvenance ( )

private

Definition at line 252 of file NanoAODRNTupleOutputModule.cc.

References PSetNTuple::fill(), MetadataNTuple::fill(), PSetNTuple::finalizeWrite(), MetadataNTuple::finalizeWrite(), edm::pset::Registry::instance(), m_file, and m_processHistoryRegistry.

Referenced by reallyCloseFile().

                                                  {
   PSetNTuple pntuple;
   pntuple.fill(edm::pset::Registry::instance(), *m_file);
   pntuple.finalizeWrite();
 
   MetadataNTuple mdntuple;
   mdntuple.fill(m_processHistoryRegistry, *m_file);
   mdntuple.finalizeWrite();
 }

◆ writeRun()

void NanoAODRNTupleOutputModule::writeRun ( edm::RunForOutput const & iRun )

overrideprivatevirtual

Implements edm::core::OutputModuleCore.

Definition at line 125 of file NanoAODRNTupleOutputModule.cc.

References Exception, RunNTuple::fill(), edm::OccurrenceForOutput::getByToken(), edm::RunForOutput::id(), m_file, m_jrToken, m_nanoMetadata, m_processHistoryRegistry, m_run, AlCaHLTBitMon_ParallelJobs::p, edm::OccurrenceForOutput::processHistory(), edm::ProcessHistoryRegistry::registerProcessHistory(), edm::JobReport::reportRunNumber(), edm::RunID::run(), and nanoaod::UniqueString::str().

                                                                      {
   edm::Service<edm::JobReport> jr;
   jr->reportRunNumber(m_jrToken, iRun.id().run());
 
   m_run.fill(iRun, *m_file);
 
   edm::Handle<nanoaod::UniqueString> hstring;
   for (const auto& p : m_nanoMetadata) {
     iRun.getByToken(p.second, hstring);
     TObjString* tos = dynamic_cast<TObjString*>(m_file->Get(p.first.c_str()));
     if (tos && hstring->str() != tos->GetString()) {
       throw cms::Exception("LogicError", "Inconsistent nanoMetadata " + p.first + " (" + hstring->str() + ")");
     } else {
       auto ostr = std::make_unique<TObjString>(hstring->str().c_str());
       m_file->WriteTObject(ostr.release(), p.first.c_str());
     }
   }
   m_processHistoryRegistry.registerProcessHistory(iRun.processHistory());
 }