Base class for CP tools providing systematic variations. More...

#include <SystematicsTool.h>

Inheritance diagram for CP::SystematicsTool:

Collaboration diagram for CP::SystematicsTool:

Public Member Functions
	SystematicsTool ()
	effects: standard constructor guarantee: strong failures: out of memory I More...

virtual bool	isAffectedBySystematic (const SystematicVariation &systematic) const
	returns: whether this tool is affected by the given systematic guarantee: no-fail More...

virtual SystematicSet	affectingSystematics () const
	returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II More...

virtual SystematicSet	recommendedSystematics () const
	returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II More...

const SystematicSet &	appliedSystematics () const
	returns: the list of systematics that have been applied to this tool. More...

std::string	appliedSystematicsString () const
	returns: a string representation of appliedSystematics() guarantee: strong failures: out of memory II rationale: this is meant to be used when printing out the applied systematics for debugging purposes (or when embedding them in a string). More...

virtual StatusCode	applySystematicVariation (const SystematicSet &systConfig)
	effects: configure this tool for the given list of systematic variations. More...

void	testInvariant () const
	effects: test the invariance of this object guarantee: no-fail More...

virtual void	print () const =0
	Print the state of the tool. More...

Protected Member Functions
StatusCode	addAffectingSystematic (const SystematicVariation &systematic, bool recommended)
	effects: add a systematic to the list of registered systematics. More...

StatusCode	addRecommendedSystematic (const SystematicVariation &systematic)
	effects: add a systematic to the list of recommended systematics failures: unsupported systematic More...

void	addAffectingSystematics (const SystematicSet &systematics)
	effects: add a SystematicSet to the registered systematics. More...

StatusCode	addRecommendedSystematics (const SystematicSet &systematics)
	effects: add a SystematicSet to the recommended systematics. More...

virtual StatusCode	sysApplySystematicVariation (const SystematicSet &systConfig)=0
	effects: configure this tool for the given list of systematic variations. More...

Protected Attributes
SystematicSet	m_affectingSystematics
	description: members directly corresponding to accessors More...

SystematicSet	m_recommendedSystematics

Private Attributes
SystematicSet *	m_appliedSystematics
	description: pointer to currenty applied systematics More...

std::unordered_map< SystematicSet, SystematicSet >	m_systFilterMap
	map of cached systematics filtering More...

Detailed Description

Base class for CP tools providing systematic variations.

This module provides a base class for systematics aware CP tools. The interface provided in this module is intended for the general user. The module is considered to be in the pre-alpha stage.

CP tools are not required to use this base class to implement the systematics interface. They can just implement their own version of the interface. Though they should probably take a quick glance of what this class does, particularly they shouldn't forget to register all their systematics with the global list.

The main difference between implementing the interface yourself and using this base class is that with this class you register all the systematics with the base class. The tool then only needs to override sysApplySystematicVariation (instead of applySystematicVariation), which gets passed only the systematics filtered for the affecting systematics (which get also stored in the base class).

Author: Nils Krumnack nils..nosp@m.erik.nosp@m..krum.nosp@m.nack.nosp@m.@cern.nosp@m..ch; Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 638687

Date: 2015-01-10 21:31:47 +0100 (Sat, 10 Jan 2015)

Definition at line 48 of file SystematicsTool.h.

Constructor & Destructor Documentation

◆ SystematicsTool()

CP::SystematicsTool::SystematicsTool ( )

effects: standard constructor guarantee: strong failures: out of memory I

Definition at line 25 of file SystematicsTool.cxx.

        : m_appliedSystematics(0) {
  
       RCU_NEW_INVARIANT( this );
    }

Member Function Documentation

◆ addAffectingSystematic()

StatusCode CP::SystematicsTool::addAffectingSystematic	(	const SystematicVariation &	systematic,
		bool	recommended
	)

protected

effects: add a systematic to the list of registered systematics.

It will optionally also add this sytematic to the recommended set. side effects: this will add the systematic to the global list of systematics, if not already there guarantee: strong failures: out of memory II

Definition at line 111 of file SystematicsTool.cxx.

                                                                                      {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       reg.registerSystematic( systematic );
       m_affectingSystematics.insert( systematic );
       if( recommended ) {
          if( addRecommendedSystematic(systematic) != StatusCode::SUCCESS ) {
             return StatusCode::FAILURE;
          }
       }
       return StatusCode::SUCCESS;
    }

◆ addAffectingSystematics()

void CP::SystematicsTool::addAffectingSystematics ( const SystematicSet & systematics )

protected

effects: add a SystematicSet to the registered systematics.

Definition at line 141 of file SystematicsTool.cxx.

                                                                {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       m_affectingSystematics.insert( systematics );
       reg.registerSystematics( systematics );
    }

◆ addRecommendedSystematic()

StatusCode CP::SystematicsTool::addRecommendedSystematic ( const SystematicVariation & systematic )

protected

effects: add a systematic to the list of recommended systematics failures: unsupported systematic

Definition at line 127 of file SystematicsTool.cxx.

                                                                      {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       m_recommendedSystematics.insert( systematic );
       if( reg.addSystematicToRecommended( systematic ) !=
           StatusCode::SUCCESS ) {
          return StatusCode::FAILURE;
       }
       return StatusCode::SUCCESS;
    }

◆ addRecommendedSystematics()

StatusCode CP::SystematicsTool::addRecommendedSystematics ( const SystematicSet & systematics )

protected

effects: add a SystematicSet to the recommended systematics.

Definition at line 151 of file SystematicsTool.cxx.

                                                                  {
  
       RCU_READ_INVARIANT( this );
  
       SystematicRegistry& reg = SystematicRegistry::getInstance();
       m_recommendedSystematics.insert( systematics );
       if( reg.addSystematicsToRecommended( systematics ) !=
           StatusCode::SUCCESS ) {
          return StatusCode::FAILURE;
       }
       return StatusCode::SUCCESS;
    }

◆ affectingSystematics()

SystematicSet CP::SystematicsTool::affectingSystematics ( ) const

virtual

returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II

Implements CP::IReentrantSystematicsTool.

Reimplemented in CP::JetJvtEfficiency, CP::JetQGTagger, and met::METSystematicsTool.

Definition at line 40 of file SystematicsTool.cxx.

                                                {
  
       RCU_READ_INVARIANT( this );
       return m_affectingSystematics;
    }

◆ appliedSystematics()

const SystematicSet & CP::SystematicsTool::appliedSystematics ( ) const

returns: the list of systematics that have been applied to this tool.

this is not including systematics that were applied, but do not affect this tool guarantee: no-fail

Definition at line 54 of file SystematicsTool.cxx.

                                              {
  
       RCU_READ_INVARIANT( this );
       if(m_appliedSystematics == 0){
          std::cerr << "SystematicsTool::appliedSystematics WARNING: "
                    << "no systematic configuration has been applied yet. "
                    << "Returning NULL" << std::endl;
          static const SystematicSet dummy;
          return dummy;
       }
       return *m_appliedSystematics;
    }

◆ appliedSystematicsString()

std::string CP::SystematicsTool::appliedSystematicsString ( ) const

returns: a string representation of appliedSystematics() guarantee: strong failures: out of memory II rationale: this is meant to be used when printing out the applied systematics for debugging purposes (or when embedding them in a string).

Definition at line 67 of file SystematicsTool.cxx.

                                                               {
  
       RCU_READ_INVARIANT( this );
       return m_appliedSystematics->name();
    }

◆ applySystematicVariation()

StatusCode CP::SystematicsTool::applySystematicVariation ( const SystematicSet & systConfig )

virtual

effects: configure this tool for the given list of systematic variations.

any requested systematics that are not affecting this tool will be silently ignored (unless they cause other errors). guarantee: basic failures: out of memory II failures: systematic unknown failures: requesting multiple variations on the same systematic (e.g. up & down) failures: requesting an unsupported variation on an otherwise supported systematic (e.g. a 2 sigma variation and the tool only supports 1 sigma variations) failures: unsupported combination of supported systematic failures: other tool specific errors

Implements CP::ISystematicsTool.

Reimplemented in CP::JetQGTagger, CP::JetJvtEfficiency, and met::METSystematicsTool.

Definition at line 73 of file SystematicsTool.cxx.

                                                                {
  
       RCU_CHANGE_INVARIANT( this );
  
       // First, try to find this input set in the map
       auto itr = m_systFilterMap.find(systConfig);
  
       // This is a new input set, so we need to filter it
       if(itr == m_systFilterMap.end()){
  
          // Filter input systematics with the affecting systematics
          SystematicSet myAppliedSystematics;
          if( SystematicSet::
              filterForAffectingSystematics( systConfig,
                                             m_affectingSystematics,
                                             myAppliedSystematics ) !=
              StatusCode::SUCCESS ) {
             return StatusCode::FAILURE;
          }
  
          // Insert the new filtered set onto our filter map
          itr = m_systFilterMap.insert
            (std::make_pair(systConfig, myAppliedSystematics)).first;
  
       }
  
       // Apply the filtered systematics
       if( sysApplySystematicVariation( itr->second ) !=
           StatusCode::SUCCESS ) {
          return StatusCode::FAILURE;
       }
  
       // Store the filtered systematics
       m_appliedSystematics = &itr->second;
       return StatusCode::SUCCESS;
    }

◆ isAffectedBySystematic()

bool CP::SystematicsTool::isAffectedBySystematic ( const SystematicVariation & systematic ) const

virtual

returns: whether this tool is affected by the given systematic guarantee: no-fail

Implements CP::ISystematicsTool.

Reimplemented in CP::JetQGTagger, CP::JetJvtEfficiency, and met::METSystematicsTool.

Definition at line 31 of file SystematicsTool.cxx.

                                                                          {
  
       RCU_READ_INVARIANT( this );
       return ( m_affectingSystematics.find( systematic ) !=
                m_affectingSystematics.end() );
    }

◆ print()

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

Implemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, asg::AsgTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

◆ recommendedSystematics()

SystematicSet CP::SystematicsTool::recommendedSystematics ( ) const

virtual

returns: the list of all systematics this tool can be affected by guarantee: strong failures: out of memory II

Implements CP::IReentrantSystematicsTool.

Reimplemented in CP::JetJvtEfficiency, CP::JetQGTagger, and met::METSystematicsTool.

Definition at line 47 of file SystematicsTool.cxx.

                                                  {
  
       RCU_READ_INVARIANT( this );
       return m_recommendedSystematics;
    }

◆ sysApplySystematicVariation()

virtual StatusCode CP::SystematicsTool::sysApplySystematicVariation ( const SystematicSet & systConfig )

protectedpure virtual

effects: configure this tool for the given list of systematic variations.

systConfig is guaranteed to contain only supported systematics. guarantee: basic failures: out of memory II failures: unsupported combination of supported systematics failures: other tool specific errors

Implemented in CP::JetQGTagger, CP::FJvtEfficiencyTool, CP::JvtEfficiencyTool, CP::NNJvtEfficiencyTool, CP::JetJvtEfficiency, and met::METSystematicsTool.

◆ testInvariant()

void CP::SystematicsTool::testInvariant ( ) const

effects: test the invariance of this object guarantee: no-fail

Definition at line 165 of file SystematicsTool.cxx.

                                              {
  
      //RCU_INVARIANT( this != 0 );
    }

Member Data Documentation

◆ m_affectingSystematics

SystematicSet CP::SystematicsTool::m_affectingSystematics

protected

description: members directly corresponding to accessors

Definition at line 146 of file SystematicsTool.h.

◆ m_appliedSystematics

SystematicSet* CP::SystematicsTool::m_appliedSystematics

private

description: pointer to currenty applied systematics

Definition at line 151 of file SystematicsTool.h.

◆ m_recommendedSystematics

SystematicSet CP::SystematicsTool::m_recommendedSystematics

protected

Definition at line 147 of file SystematicsTool.h.

◆ m_systFilterMap

std::unordered_map<SystematicSet, SystematicSet> CP::SystematicsTool::m_systFilterMap

private

map of cached systematics filtering

Definition at line 154 of file SystematicsTool.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SystematicsTool()

Member Function Documentation

◆ addAffectingSystematic()

◆ addAffectingSystematics()

◆ addRecommendedSystematic()

◆ addRecommendedSystematics()

◆ affectingSystematics()

◆ appliedSystematics()

◆ appliedSystematicsString()

◆ applySystematicVariation()

◆ isAffectedBySystematic()

◆ print()

◆ recommendedSystematics()

◆ sysApplySystematicVariation()

◆ testInvariant()

Member Data Documentation

◆ m_affectingSystematics

◆ m_appliedSystematics

◆ m_recommendedSystematics

◆ m_systFilterMap