TFileService Class Reference

#include <TFileService.h>

Public Member Functions
void	afterBeginJob ()
	Hook for writing info into JR. More...
bool	cd () const
TFile &	file () const
	return opened TFile More...
std::string	fullPath () const
	return the full path of the stored histograms More...
TDirectory *	getBareDirectory (const std::string &subdir="") const
template<typename T >
T *	getObject (const std::string &objname, const std::string &subdir="")
template<typename T , typename... Args>
T *	make (const Args &...args) const
	make new ROOT object More...
TFileDirectory	mkdir (const std::string &dir, const std::string &descr="")
	create a new subdirectory More...
TFileDirectory &	tFileDirectory ()
	TFileService (const edm::ParameterSet &, edm::ActivityRegistry &)
	constructor More...
	~TFileService ()
	destructor More...

Static Public Attributes
static const std::string	kSharedResource = "TFileService"

Private Member Functions
void	postModuleEvent (edm::StreamContext const &, edm::ModuleCallingContext const &)
void	postModuleGlobal (edm::GlobalContext const &, edm::ModuleCallingContext const &)
void	preModuleEvent (edm::StreamContext const &, edm::ModuleCallingContext const &)
void	preModuleGlobal (edm::GlobalContext const &, edm::ModuleCallingContext const &)
void	setDirectoryName (const edm::ModuleDescription &desc)

Private Attributes
bool	closeFileFast_
TFile *	file_
	pointer to opened TFile More...
std::string	fileName_
bool	fileNameRecorded_

Static Private Attributes
static thread_local TFileDirectory	tFileDirectory_

Detailed Description

Definition at line 30 of file TFileService.h.

Constructor & Destructor Documentation

TFileService::TFileService	(	const edm::ParameterSet &	cfg,
		edm::ActivityRegistry &	r
	)

constructor

Definition at line 17 of file TFileService.cc.

References afterBeginJob(), file_, TFileDirectory::file_, fileName_, postModuleEvent(), postModuleGlobal(), preModuleEvent(), preModuleGlobal(), setDirectoryName(), tFileDirectory_, edm::ActivityRegistry::watchPostBeginJob(), edm::ActivityRegistry::watchPostModuleEvent(), edm::ActivityRegistry::watchPostModuleGlobalBeginLumi(), edm::ActivityRegistry::watchPostModuleGlobalBeginRun(), edm::ActivityRegistry::watchPostModuleGlobalEndLumi(), edm::ActivityRegistry::watchPostModuleGlobalEndRun(), edm::ActivityRegistry::watchPreModuleBeginJob(), edm::ActivityRegistry::watchPreModuleConstruction(), edm::ActivityRegistry::watchPreModuleEndJob(), edm::ActivityRegistry::watchPreModuleEvent(), edm::ActivityRegistry::watchPreModuleGlobalBeginLumi(), edm::ActivityRegistry::watchPreModuleGlobalBeginRun(), edm::ActivityRegistry::watchPreModuleGlobalEndLumi(), and edm::ActivityRegistry::watchPreModuleGlobalEndRun().

                                                                               :
  file_(nullptr),
  fileName_(cfg.getParameter<std::string>("fileName")),
  fileNameRecorded_(false),
  closeFileFast_(cfg.getUntrackedParameter<bool>("closeFileFast", false)) 
{
  tFileDirectory_ = TFileDirectory("",
                                  "",
                                  TFile::Open(fileName_.c_str(), "RECREATE"),
                                  "");
  file_ = tFileDirectory_.file_;

  // activities to monitor in order to set the proper directory
  r.watchPreModuleConstruction(this, & TFileService::setDirectoryName);
  r.watchPreModuleBeginJob(this, & TFileService::setDirectoryName);
  r.watchPreModuleEndJob(this, & TFileService::setDirectoryName);
  r.watchPreModuleEvent(this, & TFileService::preModuleEvent);
  r.watchPostModuleEvent(this, & TFileService::postModuleEvent);

  r.watchPreModuleGlobalBeginRun(this, &TFileService::preModuleGlobal);
  r.watchPostModuleGlobalBeginRun(this, &TFileService::postModuleGlobal);
  r.watchPreModuleGlobalEndRun(this, &TFileService::preModuleGlobal);
  r.watchPostModuleGlobalEndRun(this, &TFileService::postModuleGlobal);

  r.watchPreModuleGlobalBeginLumi(this, &TFileService::preModuleGlobal);
  r.watchPostModuleGlobalBeginLumi(this, &TFileService::postModuleGlobal);
  r.watchPreModuleGlobalEndLumi(this, &TFileService::preModuleGlobal);
  r.watchPostModuleGlobalEndLumi(this, &TFileService::postModuleGlobal);

  // delay writing into JobReport after BeginJob
  r.watchPostBeginJob(this, &TFileService::afterBeginJob);
}

TFileService::~TFileService

(

)

destructor

Definition at line 50 of file TFileService.cc.

References closeFileFast_, and file_.

                            {
  file_->Write();
  if(closeFileFast_) gROOT->GetListOfFiles()->Remove(file_); 
  file_->Close();
  delete file_;
}

Member Function Documentation

void TFileService::afterBeginJob

(

)

Hook for writing info into JR.

Definition at line 87 of file TFileService.cc.

References fileName_, fileNameRecorded_, newFWLiteAna::fullName, edm::JobReport::reportAnalysisFile(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by TFileService().

                                 {

  if(!fileName_.empty())  {
    if(!fileNameRecorded_) {
      std::string fullName;
      fullName.reserve(1024);
      fullName = getcwd(&fullName[0],1024);
      fullName += "/" + fileName_;

      std::map<std::string, std::string> fileData;
      fileData.insert(std::make_pair("Source","TFileService"));

      edm::Service<edm::JobReport> reportSvc;
      reportSvc->reportAnalysisFile(fullName,fileData);
      fileNameRecorded_ = true;
    }
  }
}

bool TFileService::cd ( ) const

inline

Definition at line 49 of file TFileService.h.

References TFileDirectory::cd(), and tFileDirectory_.

Referenced by dqm_interfaces.DQMcommunicator::get_root_objects_list_recursive(), dqm_interfaces.DQMcommunicator::get_root_objects_names_list_recursive(), dqm_interfaces.DQMcommunicator::get_root_objects_recursive(), and dqm_interfaces.DirWalkerFile::walk().

{ return tFileDirectory_.cd(); }

TFile& TFileService::file ( ) const

inline

return opened TFile

Definition at line 37 of file TFileService.h.

References file_.

Referenced by BTagPerformaceRootProducerFromSQLITE::analyze(), HcalForwardLibWriter::endJob(), HcalForwardLibWriter::HcalForwardLibWriter(), MuonAlignmentFromReference::MuonAlignmentFromReference(), VariableNTupler::registerleaves(), AdHocNTupler::registerleaves(), and StringBasedNTupler::registerleaves().

{ return * file_; }

std::string TFileService::fullPath ( ) const

inline

return the full path of the stored histograms

Definition at line 74 of file TFileService.h.

References TFileDirectory::fullPath(), and tFileDirectory_.

{ return tFileDirectory_.fullPath(); }

TDirectory* TFileService::getBareDirectory ( const std::string &  subdir = "" ) const

inline

Definition at line 52 of file TFileService.h.

References TFileDirectory::getBareDirectory(), and tFileDirectory_.

Referenced by FFTJetImageRecorder::analyze(), and FFTJetPileupAnalyzer::analyze().

                                                                    {
    return tFileDirectory_.getBareDirectory(subdir);
  }

template<typename T >

T* TFileService::getObject ( const std::string &  objname, const std::string &  subdir = ""  )

inline

Definition at line 57 of file TFileService.h.

References TFileDirectory::getObject(), and tFileDirectory_.

                                                                     {
    return tFileDirectory_.getObject<T>(objname, subdir);
  }

template<typename T , typename... Args>

T* TFileService::make ( const Args &...  args ) const

inline

make new ROOT object

Definition at line 64 of file TFileService.h.

References TFileDirectory::make(), and tFileDirectory_.

Referenced by AlCaHOCalibProducer::AlCaHOCalibProducer(), SiStripGainFromCalibTree::algoEndJob(), AlignmentMonitorMuonSystemMap1D::AlignmentMonitorMuonSystemMap1D(), AlignmentMuonHIPTrajectorySelector::AlignmentMuonHIPTrajectorySelector(), AnaL1CaloCleaner::AnaL1CaloCleaner(), MuonAlignmentAnalyzer::analyze(), EcalMipGraphs::analyze(), EcalDisplaysByEvent::analyze(), AnaMuonCaloCleaner::AnaMuonCaloCleaner(), APVShotsAnalyzer::APVShotsAnalyzer(), tnp::BaseTreeFiller::BaseTreeFiller(), HypothesisAnalyzer::beginJob(), PatTauAnalyzer::beginJob(), PatZjetsElectronAnalyzer::beginJob(), PatZjetsJetAnalyzer::beginJob(), PatTriggerTagAndProbe::beginJob(), PatTriggerAnalyzer::beginJob(), PatBJetTagAnalyzer::beginJob(), PatMCMatchingExtended::beginJob(), PatMCMatching::beginJob(), myRawAna::beginJob(), PatTopSelectionAnalyzer::beginJob(), PatBasicAnalyzer::beginJob(), PatBTagAnalyzer::beginJob(), PatTrackAnalyzer::beginJob(), PatVertexAnalyzer::beginJob(), MCPhotonAnalyzer::beginJob(), PhotonsWithConversionsAnalyzer::beginJob(), ShallowTree::beginJob(), JetCorrectorDemo::beginJob(), FactorizedJetCorrectorDemo::beginJob(), ExampleMuonAnalyzer::beginJob(), PatBJetTrackAnalyzer::beginJob(), EmbeddingKineReweightNtupleProducer::beginJob(), WMuNuSelector::beginJob(), PatBJetVertexAnalyzer::beginJob(), ResolutionCreator::beginJob(), StudyHLT::beginJob(), MuonAlignmentAnalyzer::beginJob(), myJetAna::beginJob(), SiPixelDQMRocLevelAnalyzer::beginJob(), ContainmentCorrectionAnalyzer::beginJob(), HitEff::beginJob(), FFTJetImageRecorder::beginJob(), FFTJetPileupAnalyzer::beginJob(), HcalIsoTrkAnalyzer::beginJob(), CosmicSplitterValidation::beginJob(), IsoTrackCalib::beginJob(), IsoTrig::beginJob(), PrimaryVertexValidation::beginJob(), IsoTrackCalibration::beginJob(), ErsatzMEt::beginJob(), IsolatedTracksHcalScale::beginJob(), HcalRaddamMuon::beginJob(), HcalHBHEMuonAnalyzer::beginJob(), StudyHLT::beginRun(), HLTOfflineReproducibility::beginRun(), IsoTrackCalib::beginRun(), MaterialBudgetCastorHistos::book(), MaterialBudgetHcalHistos::book(), MaterialBudgetForward::book(), MaterialBudget::book(), IsolatedParticlesGeneratedJets::BookHistograms(), IsolatedGenParticles::BookHistograms(), IsolatedTracksNxN::BookHistograms(), MuonAlignmentFromReference::bookNtuple(), SVTagInfoValidationAnalyzer::bookRecoToSim(), SVTagInfoValidationAnalyzer::bookSimToReco(), IsolatedTracksCone::BuildTree(), calcTopMass::calcTopMass(), CalibratableTest::CalibratableTest(), CMSDAS11DijetAnalyzer::CMSDAS11DijetAnalyzer(), CMSDAS11DijetTestAnalyzer::CMSDAS11DijetTestAnalyzer(), CSCPairResidualsConstraint::configure(), CSCOverlapsAlignmentAlgorithm::CSCOverlapsAlignmentAlgorithm(), CSCOverlapsBeamSplashCut::CSCOverlapsBeamSplashCut(), DreamSD::DreamSD(), DuplicateRecHits::DuplicateRecHits(), EcalDisplaysByEvent::EcalDisplaysByEvent(), EcalMipGraphs::EcalMipGraphs(), ElectronStudy::ElectronStudy(), JetCorrectorDemo::endJob(), FactorizedJetCorrectorDemo::endJob(), IsoTrig::endJob(), IsoTrackCalib::endJob(), TrackerOfflineValidation::endJob(), TkLasBeamFitter::endRunProduce(), EopTreeWriter::EopTreeWriter(), G4StepStatistics::G4StepStatistics(), gamma_radiative_analyzer::gamma_radiative_analyzer(), HcalTB02Histo::HcalTB02Histo(), HcalTB04Histo::HcalTB04Histo(), HcalTB06Histo::HcalTB06Histo(), HcalTestHistoManager::HcalTestHistoManager(), HLTBitAnalyzer::HLTBitAnalyzer(), HLTCSCOverlapFilter::HLTCSCOverlapFilter(), HOCalibAnalyzer::HOCalibAnalyzer(), HSCPValidator::HSCPValidator(), HcalForwardAnalysis::init(), EcalMipGraphs::initHists(), EcalDisplaysByEvent::initHists(), HltComparator::initialise(), L1RCTRelValAnalyzer::L1RCTRelValAnalyzer(), L1RCTTestAnalyzer::L1RCTTestAnalyzer(), LHEAnalyzer::LHEAnalyzer(), SiStripHitEffFromCalibTree::makeHotColdMaps(), SiStripHitEffFromCalibTree::makeSummary(), MCVerticesAnalyzer::MCVerticesAnalyzer(), MCvsRecoVerticesAnalyzer::MCvsRecoVerticesAnalyzer(), MultiplicityCorrelatorHistogramMaker::MultiplicityCorrelatorHistogramMaker(), MuTriggerAnalyzer::MuTriggerAnalyzer(), OverlapProblemTPAnalyzer::OverlapProblemTPAnalyzer(), OverlapProblemTSOSAnalyzer::OverlapProblemTSOSAnalyzer(), PatJetAnalyzer::PatJetAnalyzer(), PatZToMuMuAnalyzer::PatZToMuMuAnalyzer(), CSCAlignmentCorrections::plot(), VariableNTupler::registerleaves(), AdHocNTupler::registerleaves(), StringBasedNTupler::registerleaves(), SeedMultiplicityAnalyzer::SeedMultiplicityAnalyzer(), EcalMipGraphs::selectDigi(), EcalDisplaysByEvent::selectDigi(), PatBTagCommonHistos::Set(), SiPixelQualityHistory::SiPixelQualityHistory(), SiStripBaselineAnalyzer::SiStripBaselineAnalyzer(), SiStripQualityHistory::SiStripQualityHistory(), SiStripGainFromCalibTree::storeOnTree(), SVTagInfoValidationAnalyzer::SVTagInfoValidationAnalyzer(), testAnalyzer::testAnalyzer(), TopElecAnalyzer::TopElecAnalyzer(), TopGenEventAnalyzer::TopGenEventAnalyzer(), TopJetAnalyzer::TopJetAnalyzer(), TopMuonAnalyzer::TopMuonAnalyzer(), TopTauAnalyzer::TopTauAnalyzer(), TrackCount::TrackCount(), MuonMillepedeAlgorithm::updateInfo(), ZMassHistogrammer::ZMassHistogrammer(), ZMuMu_efficiencyAnalyzer::ZMuMu_efficiencyAnalyzer(), ZMuMu_MCanalyzer::ZMuMu_MCanalyzer(), ZMuMu_Radiative_analyzer::ZMuMu_Radiative_analyzer(), ZMuMu_vtxAnalyzer::ZMuMu_vtxAnalyzer(), ZMuMuAnalyzer::ZMuMuAnalyzer(), ZMuMuAnalyzer_cynematics::ZMuMuAnalyzer_cynematics(), ZMuMuIsolationAnalyzer::ZMuMuIsolationAnalyzer(), ZMuMuPerformances::ZMuMuPerformances(), and ZMuMuSaMassHistogram::ZMuMuSaMassHistogram().

                                      {
    return tFileDirectory_.make<T>(args ...);
  }

TFileDirectory TFileService::mkdir ( const std::string &  dir, const std::string &  descr = ""  )

inline

create a new subdirectory

Definition at line 69 of file TFileService.h.

References TFileDirectory::mkdir(), and tFileDirectory_.

Referenced by AlignmentMonitorBase::AlignmentMonitorBase(), CentralityTableProducer::analyze(), SiStripBaselineAnalyzer::analyze(), GenMuonRadCorrAnalyzer::beginJob(), L1GctValidation::beginJob(), l1t::L1TGlobalAnalyzer::beginJob(), l1t::L1TStage2CaloAnalyzer::beginJob(), PrimaryVertexValidation::beginJob(), HLTOfflineReproducibility::beginRun(), BigEventsDebugger< T >::BigEventsDebugger(), BjetAnalysis::BjetAnalysis(), DigiInvestigatorHistogramMaker::book(), DigiVtxPosCorrHistogramMaker::book(), BeamSpotHistogramMaker::book(), DigiPileupCorrHistogramMaker::book(), DigiVertexCorrHistogramMaker::book(), DigiBXCorrHistogramMaker< T >::book(), VertexHistogramMaker::book(), DigiLumiCorrHistogramMaker::book(), BSvsPVHistogramMaker::book(), L1GtDataEmulAnalyzer::bookHistograms(), IsolatedGenParticles::BookHistograms(), IsolatedTracksNxN::BookHistograms(), CosmicGenFilterHelix::createHistsEnd(), CosmicGenFilterHelix::createHistsStart(), TrackerOfflineValidation::DirectoryWrapper::DirectoryWrapper(), PatBTagAnalyzer::endJob(), EWKSystUnc::EWKSystUnc(), MuonAlignmentFromReference::fitAndAlign(), GctErrorAnalyzer::GctErrorAnalyzer(), GlbMuQualityCutsAnalysis::GlbMuQualityCutsAnalysis(), HCalSD::HCalSD(), HFGflash::HFGflash(), HFShowerParam::HFShowerParam(), WMuNuValidator::init_histograms(), MultiplicityTimeCorrelations::MultiplicityTimeCorrelations(), batchmanager.BatchManager::PrepareJob(), TrackerDpgAnalysis::TrackerDpgAnalysis(), TrackerGeometryCompare::TrackerGeometryCompare(), TSOSHistogramMaker::TSOSHistogramMaker(), ZHistogrammer::ZHistogrammer(), ZLONLOHistogrammer::ZLONLOHistogrammer(), ZMCHistogrammer::ZMCHistogrammer(), ZMuMu_efficiencyAnalyzer::ZMuMu_efficiencyAnalyzer(), ZMuMuAnalyzer_cynematics::ZMuMuAnalyzer_cynematics(), ZMuMuEfficiency::ZMuMuEfficiency(), ZMuPtScaleAnalyzer::ZMuPtScaleAnalyzer(), and zPdfUnc::zPdfUnc().

                                                                              {
    return tFileDirectory_.mkdir(dir, descr);
  }

void TFileService::postModuleEvent ( edm::StreamContext const &  , edm::ModuleCallingContext const &  mcc  )

private

Definition at line 67 of file TFileService.cc.

References edm::ModuleCallingContext::moduleDescription(), edm::ModuleCallingContext::previousModuleOnThread(), and setDirectoryName().

Referenced by TFileService().

                                                                                              {
  edm::ModuleCallingContext const* previous_mcc = mcc.previousModuleOnThread();
  if(previous_mcc) {
    setDirectoryName(*previous_mcc->moduleDescription());
  }
}

void TFileService::postModuleGlobal ( edm::GlobalContext const &  , edm::ModuleCallingContext const &  mcc  )

private

Definition at line 80 of file TFileService.cc.

References edm::ModuleCallingContext::moduleDescription(), edm::ModuleCallingContext::previousModuleOnThread(), and setDirectoryName().

Referenced by TFileService().

                                                                                          {
  edm::ModuleCallingContext const* previous_mcc = mcc.previousModuleOnThread();
  if(previous_mcc) {
    setDirectoryName(*previous_mcc->moduleDescription());
  }
}

void TFileService::preModuleEvent ( edm::StreamContext const &  , edm::ModuleCallingContext const &  mcc  )

private

Definition at line 63 of file TFileService.cc.

References edm::ModuleCallingContext::moduleDescription(), and setDirectoryName().

Referenced by TFileService().

                                                                                             {
  setDirectoryName(*mcc.moduleDescription());
}

void TFileService::preModuleGlobal ( edm::GlobalContext const &  , edm::ModuleCallingContext const &  mcc  )

private

Definition at line 75 of file TFileService.cc.

References edm::ModuleCallingContext::moduleDescription(), and setDirectoryName().

Referenced by TFileService().

                                                                                         {
  setDirectoryName(*mcc.moduleDescription());
}

void TFileService::setDirectoryName ( const edm::ModuleDescription &  desc )

private

Definition at line 57 of file TFileService.cc.

References TFileDirectory::descr_, TFileDirectory::dir_, file_, TFileDirectory::file_, edm::ModuleDescription::moduleLabel(), edm::ModuleDescription::moduleName(), and tFileDirectory_.

Referenced by postModuleEvent(), postModuleGlobal(), preModuleEvent(), preModuleGlobal(), and TFileService().

                                                                     {
  tFileDirectory_.file_ = file_;
  tFileDirectory_.dir_ = desc.moduleLabel();
  tFileDirectory_.descr_ = (tFileDirectory_.dir_ + " (" + desc.moduleName() + ") folder").c_str();
}

TFileDirectory& TFileService::tFileDirectory ( )

inline

Definition at line 42 of file TFileService.h.

References tFileDirectory_.

Referenced by edm::AnalyzerWrapper< T >::AnalyzerWrapper(), GenMuonRadCorrAnalyzer::beginJob(), DigiInvestigatorHistogramMaker::beginRun(), BeamSpotHistogramMaker::beginRun(), VertexHistogramMaker::beginRun(), BSvsPVHistogramMaker::beginRun(), RunHistogramManager::beginRun(), BeamSpotHistogramMaker::book(), VertexHistogramMaker::book(), BSvsPVHistogramMaker::book(), TrackerOfflineValidation::DirectoryWrapper::DirectoryWrapper(), and HistoAnalyzer< C >::HistoAnalyzer().

{ return tFileDirectory_; }

Member Data Documentation

bool TFileService::closeFileFast_

private

Definition at line 84 of file TFileService.h.

Referenced by ~TFileService().

TFile* TFileService::file_

private

pointer to opened TFile

Definition at line 81 of file TFileService.h.

Referenced by file(), setDirectoryName(), TFileService(), and ~TFileService().

std::string TFileService::fileName_

private

Definition at line 82 of file TFileService.h.

Referenced by afterBeginJob(), and TFileService().

bool TFileService::fileNameRecorded_

private

Definition at line 83 of file TFileService.h.

Referenced by afterBeginJob().

const std::string TFileService::kSharedResource = "TFileService"

static

Definition at line 76 of file TFileService.h.

thread_local TFileDirectory TFileService::tFileDirectory_

staticprivate

Definition at line 79 of file TFileService.h.

Referenced by cd(), fullPath(), getBareDirectory(), getObject(), make(), mkdir(), setDirectoryName(), tFileDirectory(), and TFileService().