The collection container manages the time binning of a particular scale-factor map. More...

#include <EffiCollection.h>

Collaboration diagram for CP::CollectionContainer:

Public Member Functions
	CollectionContainer (const MuonEfficiencyScaleFactors &ref_tool, EffiCollection::CollectionType FileType)
	Nominal constructor... Only needs to know about it's type and the file to load.
	CollectionContainer (const MuonEfficiencyScaleFactors &ref_tool, CollectionContainer *Nominal, const std::string &syst_name, unsigned int syst_bit_map)
EfficiencyScaleFactor *	retrieve (unsigned int RunNumer)
	Retrieve the scale-factor map belonging to that particular run of data-taking.
bool	isBinInMap (unsigned int bin) const
	Checks if the global bin number belongs to this map.
bool	CheckConsistency ()
	Consistency check of all scale-factor maps managed by the container instance.
std::string	sysname () const
	Returns MUON_EFF_<sysname()>
bool	SetSystematicBin (unsigned int Bin)
	Activate this bin to run in the uncorrelated systematic mode.
void	SetGlobalOffSet (unsigned int OffSet)
	Sets the global offset to align the order in the map into a global numbering scheme.
unsigned int	nBins () const
	Number of bins of the map itself.
unsigned int	nOverFlowBins () const
	Number of overflow bins in the map.
bool	isOverFlowBin (int b) const
	Check whether the bin is overflow or not.
unsigned int	globalOffSet () const
	Global offset of the bin numbers.
std::string	GetBinName (unsigned int Bin) const
	Name of the i-th bin.
int	FindBinSF (const xAOD::Muon &mu) const
	Returns the global bin number corresponding to the muon kinematics.
EffiCollection::CollectionType	type () const
	File type of the map.
bool	isNominal () const
bool	isUpVariation () const
bool	separateBinSyst () const
void	addSubtoolsTo (columnar::ColumnarTool<> &parentTool)

Private Member Functions
std::map< std::string, std::pair< unsigned int, unsigned int > >	findPeriods (const MuonEfficiencyScaleFactors &ref_tool) const
std::string	fileName (const MuonEfficiencyScaleFactors &ref_tool) const
bool	LoadPeriod (unsigned int RunNumber)

Private Attributes
std::vector< std::shared_ptr< EfficiencyScaleFactor > >	m_SF
EfficiencyScaleFactor *	m_currentSF
EffiCollection::CollectionType	m_FileType
unsigned int	m_binOffSet
	Offset to translate between the bin-numbers in the bin numbers of each file against the global bin-number.

Detailed Description

The collection container manages the time binning of a particular scale-factor map.

For a given runNumber, it pipes the right map to the upstream tools.

Definition at line 140 of file EffiCollection.h.

Constructor & Destructor Documentation

◆ CollectionContainer() [1/2]

CP::CollectionContainer::CollectionContainer	(	const MuonEfficiencyScaleFactors &	ref_tool,
		EffiCollection::CollectionType	FileType )

Nominal constructor... Only needs to know about it's type and the file to load.

Definition at line 354 of file EffiCollection.cxx.

                                                                                                                             :
                m_SF(),
                m_currentSF(nullptr),
                m_FileType(FileType),
                m_binOffSet(0){
        
            std::map<std::string, std::pair<unsigned int, unsigned int>> map = findPeriods(ref_tool);
            for (auto& period : map) {
             m_SF.push_back(std::make_shared<EfficiencyScaleFactor>(ref_tool, fileName(ref_tool), period.first));
             m_SF.back()->setFirstLastRun(period.second.first, period.second.second);
         }
    }

◆ CollectionContainer() [2/2]

CP::CollectionContainer::CollectionContainer	(	const MuonEfficiencyScaleFactors &	ref_tool,
		CollectionContainer *	Nominal,
		const std::string &	syst_name,
		unsigned int	syst_bit_map )

Definition at line 366 of file EffiCollection.cxx.

                                                                                                                                                                           :
                m_SF(),
                m_currentSF(nullptr),
                m_FileType(Nominal->type()),
                m_binOffSet(0) {
            std::map<std::string, std::pair<unsigned int, unsigned int>> map = findPeriods(ref_tool);
            for (auto& period : map) {
                std::vector< std::shared_ptr<EfficiencyScaleFactor>>::const_iterator itr = std::find_if( Nominal->m_SF.begin(), 
                                                                                                      Nominal->m_SF.end(), 
                                                                                                      [&period](const std::shared_ptr<EfficiencyScaleFactor>& a){
                                                                                                            return a->coversRunNumber(period.second.first);
                                                                                                    });
                m_SF.push_back(std::make_shared<EfficiencyScaleFactor>(*itr, ref_tool, fileName(ref_tool), period.first, syst_name, syst_bit_map));
                m_SF.back()->setFirstLastRun(period.second.first, period.second.second);
         }
    }

Member Function Documentation

◆ addSubtoolsTo()

void CP::CollectionContainer::addSubtoolsTo ( columnar::ColumnarTool<> & parentTool )

Definition at line 512 of file EffiCollection.cxx.

                                                                              {
        for (auto& SF : m_SF)
            parentTool.addSubtool(*SF);
    }

◆ CheckConsistency()

bool CP::CollectionContainer::CheckConsistency ( )

Consistency check of all scale-factor maps managed by the container instance.

Check that there are no overlapping run numbers in the periods

Definition at line 419 of file EffiCollection.cxx.

                                                {
        if (m_SF.empty()) {
            Error("CollectionContainer", "Could not retrieve any SFs from the input file");
            return false;
        }
        for (std::vector< std::shared_ptr<EfficiencyScaleFactor>>::const_iterator first_sf = m_SF.begin() ; first_sf != m_SF.end(); ++first_sf)  {
            if (!(*first_sf)->CheckConsistency()) return false;
            for (std::vector< std::shared_ptr<EfficiencyScaleFactor>>::const_iterator second_sf = m_SF.begin(); second_sf != first_sf; ++second_sf) {
                if ( (*first_sf)->coversRunNumber( (*second_sf)->firstRun()) || (*first_sf)->coversRunNumber((*second_sf)->lastRun()) || 
                     (*second_sf)->coversRunNumber( (*first_sf)->firstRun()) || (*second_sf)->coversRunNumber((*first_sf)->lastRun())){
                    Error("CollectionContainer", "Overlapping periods observed in file type %s. As run %i is in period %i - %i. Please check your SF file!",  
                           EffiCollection::FileTypeName(m_FileType).c_str(), (*first_sf)->firstRun(), (*second_sf)->firstRun(), (*second_sf)->lastRun());
                    return false;
                }
            }
        }
        
        std::sort(m_SF.begin(), m_SF.end(), [](const std::shared_ptr<EfficiencyScaleFactor>& a, const std::shared_ptr<EfficiencyScaleFactor>& b){
            return a->firstRun() < b->firstRun();});
        return true;
    }

◆ fileName()

std::string CP::CollectionContainer::fileName ( const MuonEfficiencyScaleFactors & ref_tool ) const

private

Definition at line 411 of file EffiCollection.cxx.

                                                                                           {
        if (type() == EffiCollection::CollectionType::Central) return ref_tool.filename_Central();
        if (type() == EffiCollection::CollectionType::Calo) return ref_tool.filename_Calo();
        if (type() == EffiCollection::CollectionType::CentralLowPt) return ref_tool.filename_LowPt();
        if (type() == EffiCollection::CollectionType::CaloLowPt) return ref_tool.filename_LowPtCalo();
        return ref_tool.filename_HighEta();
    }

◆ FindBinSF()

int CP::CollectionContainer::FindBinSF ( const xAOD::Muon & mu ) const

Returns the global bin number corresponding to the muon kinematics.

In case of failures -1 is returned

Definition at line 485 of file EffiCollection.cxx.

                                                               {
        if (m_SF.empty() ) return -1;
        int bin =  (*m_SF.begin())->FindBinSF(mu);
        return bin > 0 ? m_binOffSet + bin : bin;
    }

◆ findPeriods()

std::map< std::string, std::pair< unsigned int, unsigned int > > CP::CollectionContainer::findPeriods ( const MuonEfficiencyScaleFactors & ref_tool ) const

private

Definition at line 382 of file EffiCollection.cxx.

                                                                                                                                           {
        
        std::string file_name = fileName(ref_tool);
        std::map<std::string, std::pair<unsigned int, unsigned int>> map;
      
        std::unique_ptr<TFile> fin (TFile::Open(file_name.c_str()));
        if (!fin || !fin->IsOpen()) {
            Error("CollectionContainer","Unable to open file %s", file_name.c_str());
            return map;
        }
        TTree* intree = 0;
        fin->GetObject("LumiData", intree);
        
        // if no Lumi tree is found, we assume that the SF are not binned in time
        if (!intree) {
            map["All"] = std::pair<unsigned int,unsigned int>(1, 999999);
        } else {
            std::string *period = 0;
            unsigned int firstRun = 0;
            unsigned int lastRun = 0;
            intree->SetBranchAddress("Period", &period);
            intree->SetBranchAddress("FirstRun", &firstRun);
            intree->SetBranchAddress("LastRun", &lastRun);
            for (int t = 0; intree->GetEntry(t); t++) {
                map[*period] = std::pair<unsigned int, unsigned int>(firstRun, lastRun);
            }
        }
        return map;
    }

◆ GetBinName()

std::string CP::CollectionContainer::GetBinName ( unsigned int Bin ) const

Name of the i-th bin.

Definition at line 482 of file EffiCollection.cxx.

                                                                    {
        return (*m_SF.begin())->GetBinName(Bin- m_binOffSet);
    }

◆ globalOffSet()

unsigned int CP::CollectionContainer::globalOffSet ( ) const

Global offset of the bin numbers.

Definition at line 493 of file EffiCollection.cxx.

                                                        {
        return m_binOffSet;
    }

◆ isBinInMap()

bool CP::CollectionContainer::isBinInMap ( unsigned int bin ) const

Checks if the global bin number belongs to this map.

Definition at line 476 of file EffiCollection.cxx.

                                                              {
        return  m_binOffSet <= bin && bin < m_binOffSet + nBins();
    }

◆ isNominal()

bool CP::CollectionContainer::isNominal ( ) const

Definition at line 496 of file EffiCollection.cxx.

                                              {
        if (m_SF.empty()) return false;
        return (*m_SF.begin())->sysname(false).empty();
    }

◆ isOverFlowBin()

bool CP::CollectionContainer::isOverFlowBin ( int b ) const

Check whether the bin is overflow or not.

Definition at line 473 of file EffiCollection.cxx.

                                                       {
          return m_SF.empty() ? true : (*m_SF.begin())->isOverFlowBin(b-m_binOffSet);
    }

◆ isUpVariation()

bool CP::CollectionContainer::isUpVariation ( ) const

Definition at line 500 of file EffiCollection.cxx.

                                                  {
        if (m_SF.empty()) return false;
        return (*m_SF.begin())->IsUpVariation();        
    }

◆ LoadPeriod()

bool CP::CollectionContainer::LoadPeriod ( unsigned int RunNumber )

private

Definition at line 441 of file EffiCollection.cxx.

                                                               {
        if (!m_currentSF || !m_currentSF->coversRunNumber(RunNumber)) {
            for (auto& period : m_SF) {
                if (period->coversRunNumber(RunNumber)) {
                    m_currentSF = period.get();
                    return true;
                }
            }
        } else return true;
        Warning("CollectionContainer", "Could not find any SF period in %s matching the run number %u", EffiCollection::FileTypeName(type()).c_str(), RunNumber);
        return false;
    }

◆ nBins()

unsigned int CP::CollectionContainer::nBins ( ) const

Number of bins of the map itself.

Definition at line 467 of file EffiCollection.cxx.

                                                  {
        return m_SF.empty() ? 0 : (*m_SF.begin())->nBins();
    }

◆ nOverFlowBins()

unsigned int CP::CollectionContainer::nOverFlowBins ( ) const

Number of overflow bins in the map.

Definition at line 470 of file EffiCollection.cxx.

                                                          {
          return m_SF.empty() ? 0 : (*m_SF.begin())->nOverFlowBins();
    }

◆ retrieve()

EfficiencyScaleFactor * CP::CollectionContainer::retrieve ( unsigned int RunNumer )

Retrieve the scale-factor map belonging to that particular run of data-taking.

Definition at line 453 of file EffiCollection.cxx.

                                                                               {
        if (!LoadPeriod(RunNumber)) {
            return (*m_SF.begin()).get();
        }
        return m_currentSF;
    }

◆ separateBinSyst()

bool CP::CollectionContainer::separateBinSyst ( ) const

Definition at line 504 of file EffiCollection.cxx.

                                                    {
        if (m_SF.empty()) return false;
        return (*m_SF.begin())->separateBinSyst();
    }

◆ SetGlobalOffSet()

void CP::CollectionContainer::SetGlobalOffSet ( unsigned int OffSet )

Sets the global offset to align the order in the map into a global numbering scheme.

Definition at line 490 of file EffiCollection.cxx.

                                                                {
        m_binOffSet = OffSet;
    }

◆ SetSystematicBin()

bool CP::CollectionContainer::SetSystematicBin ( unsigned int Bin )

Activate this bin to run in the uncorrelated systematic mode.

Definition at line 459 of file EffiCollection.cxx.

                                                               {
        for ( std::shared_ptr<EfficiencyScaleFactor>& Period : m_SF) {
            if (!Period->SetSystematicBin(Bin- m_binOffSet)) {
                return false;
            }
        }
        return true;
    }

◆ sysname()

std::string CP::CollectionContainer::sysname ( ) const

Returns MUON_EFF_<sysname()>

Definition at line 508 of file EffiCollection.cxx.

                                                {
        if (m_SF.empty()) return "UNKNOWN SYST";
        return (*m_SF.begin())->sysname(false);
    }

◆ type()

EffiCollection::CollectionType CP::CollectionContainer::type ( ) const

File type of the map.

Definition at line 479 of file EffiCollection.cxx.

                                                                 {
        return m_FileType;
    }

Member Data Documentation

◆ m_binOffSet

unsigned int CP::CollectionContainer::m_binOffSet

private

Offset to translate between the bin-numbers in the bin numbers of each file against the global bin-number.

Definition at line 201 of file EffiCollection.h.

◆ m_currentSF

EfficiencyScaleFactor* CP::CollectionContainer::m_currentSF

private

Definition at line 196 of file EffiCollection.h.

◆ m_FileType

EffiCollection::CollectionType CP::CollectionContainer::m_FileType

private

Definition at line 198 of file EffiCollection.h.

◆ m_SF

std::vector<std::shared_ptr<EfficiencyScaleFactor> > CP::CollectionContainer::m_SF

private

Definition at line 195 of file EffiCollection.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CollectionContainer() [1/2]

◆ CollectionContainer() [2/2]

Member Function Documentation

◆ addSubtoolsTo()

◆ CheckConsistency()

◆ fileName()

◆ FindBinSF()

◆ findPeriods()

◆ GetBinName()

◆ globalOffSet()

◆ isBinInMap()

◆ isNominal()

◆ isOverFlowBin()

◆ isUpVariation()

◆ LoadPeriod()

◆ nBins()

◆ nOverFlowBins()

◆ retrieve()

◆ separateBinSyst()

◆ SetGlobalOffSet()

◆ SetSystematicBin()

◆ sysname()

◆ type()

Member Data Documentation

◆ m_binOffSet

◆ m_currentSF

◆ m_FileType

◆ m_SF