FastJetInterfaceTool Class Reference

Wrapper for fastjet verion 2.4.4. More...

#include <FastJetInterfaceTool.h>

Inheritance diagram for FastJetInterfaceTool:

Collaboration diagram for FastJetInterfaceTool:

Public Types
typedef fastjet::PseudoJet	fjet_t
typedef std::vector< fjet_t >	fjetlist_t

Public Member Functions
	FastJetInterfaceTool (const std::string &n)
	Standard AlgTool constructor.
virtual	~FastJetInterfaceTool ()
	Base class destructor.
virtual StatusCode	initialize ()
	Initialize tool.
virtual StatusCode	execute (const fjetlist_t &inJets, fjetlist_t &outJets)
	Execute method.
virtual fastjet::ClusterSequence *	clusterSequence ()
	Access fastjet ClusterSequence.
virtual const fastjet::ClusterSequence *	clusterSequence () const
	Access fastjet ClusterSequence.
template<class S>
S *	specificClusterSequence ()
	Access to specific cluster sequence.
template<class S>
const S *	specificClusterSequence () const
	Access to specific cluster sequence.
const fastjet::JetDefinition *	getJetDefinition () const
	Access fastjet JetDefinition.
const fastjet::AreaDefinition *	getAreaDefinition () const
	Access fastjet AreaDefinition.
const std::string	getAreaDefinitionType () const
	Access fastjet area definition type.
const FastJetInterface::algomap_t &	getKnownAlgorithms ()
	Get known jet algorithms.
const FastJetInterface::strategymap_t &	getKnownStrategies ()
	Get known jet finding strategies.
const FastJetInterface::schememap_t &	getKnownRecombinationSchemes ()
	Get known recombination schemes.
const FastJetInterface::splitMergeScaleMap_t &	getKnownSplitMergeScales ()
	Get known split merge scales.
const FastJetInterface::areamap_t &	getKnownAreas ()
	Get known area types.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Types
typedef StatusCode(FastJetInterfaceTool::*	PROCESSOR) (const FastJetInterface::fjetlist_t &inJets, FastJetInterface::fjetlist_t &outJets)
	Processor function pointer type.
typedef StatusCode(FastJetInterfaceTool::*	EXTRACTOR) (FastJetInterface::fjetlist_t &outJets)
	Extractor function pointer type.

Protected Member Functions
bool	checkConfig (const std::string &key, fastjet::JetAlgorithm &fjalg)
	Check configuration keyword for jet algorithm.
bool	checkConfig (const std::string &key, fastjet::Strategy &fjstr)
	Check configuration keyword for jet clustering strategy.
bool	checkConfig (const std::string &key, fastjet::RecombinationScheme &fjrs)
	Check configuration keyword for recombination scheme.
bool	checkConfig (const std::string &key, fastjet::SISConePlugin::SplitMergeScale &fjsms)
	Check configuration keyword for SIS Cone split merge scale.
bool	checkConfig (const std::string &tag, fastjet::AreaType &fjart)
	Check configuration keyword for jet area type.
const std::string &	configName (fastjet::JetAlgorithm fjalg)
	Get keyword for fastjet configuration.
const std::string &	configName (fastjet::Strategy fjstr)
	Get keyword for fastjet configuration.
const std::string &	configName (fastjet::RecombinationScheme fjrs)
	Get keyword for fastjet configuration.
const std::string &	configName (fastjet::SISConePlugin::SplitMergeScale fjsms)
	Get keyword for fastjet configuration.
const std::string &	configName (fastjet::AreaType fjart)
	Get keyword for fastjet configuration.
StatusCode	f_processWithoutArea (const FastJetInterface::fjetlist_t &inJets, FastJetInterface::fjetlist_t &outJets)
	Processor implementation: cluster sequence without area calculation.
StatusCode	f_processWithArea (const FastJetInterface::fjetlist_t &inJets, FastJetInterface::fjetlist_t &outJets)
	Processor implementation: cluster sequence with area calculation.
StatusCode	configJetAreas ()
	Configures jet area calculation strategy.
StatusCode	f_extractInclusive (FastJetInterface::fjetlist_t &outJets)
	Inclusive extractor implementation.
StatusCode	f_extractExclDcut (FastJetInterface::fjetlist_t &outJets)
	Exclusive extractor implementation.
StatusCode	f_extractExclNjets (FastJetInterface::fjetlist_t &outJets)
	Exclusive extractor implementation.
virtual void	updateRandomSeeds ()
	Set the area rnd seed according to run/event numbers.
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
std::string	m_clusterSequenceType
	fastjet property: cluster sequence type
std::string	m_jetAlgorithmType
	fastjet property: jet algorithm
std::string	m_clusterStrategyType
	fastjet property: cluster strategy
std::string	m_recombinationSchemeType
	fastjet property: recombination scheme
double	m_CMS_seedThreshold
	fastjet property for CMS Cone plugin: seed threshold
double	m_SIS_overlapThreshold
	fastjet property for SIS Cone plugin: overlap threshold
int	m_SIS_nPass
	fastjet property for SIS Cone plugin: max number of passes
double	m_SIS_protojetPtMin
	fastjet property for SIS Cone plugin: protojet min pt
bool	m_SIS_doCaching
	fastjet property for SIS Cone plugin: do caching
std::string	m_SIS_splitMergeScale_STRING
	fastjet property for SIS Cone plugin: split merge scale
double	m_SIS_splitMergeStopScale
	fastjet property for SIS Cone plugin: split merge stop scale
double	m_radius
	Jet algorithm property: radius/distance parameter.
bool	m_inclusive
	Jet algorithm control property: inclusive/exclusive jet finding.
double	m_exclusiveDcut
	Exclusive jet finder property: d cut.
int	m_exclusiveNjets
	Exclusive jet finder property: number of jets requested.
double	m_pTmin
	Inclusive jet finder property: pTmin cut.
bool	m_doJetArea
	Tool property: flag controls if jet area is calculated.
std::string	m_jetAreaDefinitionType
	fastjet property: jet area definition
double	m_voronoiEffectiveRfact
	fastjet property: Voronoi area effective radius
double	m_ghostedMaxRap
	fastjet property: ghost area rapidity limit (max)
double	m_ghostedMinRap
	fastjet property: ghost area rapidity limit (min)
int	m_ghostedRepeat
	fastjet property: ghost area calculation repeatitions
double	m_ghostedArea
	fastjet property: size of area coverded by each ghost
double	m_ghostedGridScatter
	fastjet property: scatter of ghosts on grid
double	m_ghostedKtScatter
	fastjet property: scatter of kT of ghosts
double	m_ghostedMeanKt
	fastjet property: average kT of ghosts
fastjet::JetAlgorithm	m_jetAlgorithm
	fastjet tag: jet algorithm
fastjet::Strategy	m_strategy
	fastjet tag: jet clustering strategy
fastjet::AreaType	m_areaType
	fastjet tag: jet area type
fastjet::RecombinationScheme	m_recombinationScheme
	fastjet tag: recombination scheme
fastjet::SISConePlugin::SplitMergeScale	m_SIS_splitMergeScale
	fastjet tag: SIS split merge scale
fastjet::JetDefinition *	m_jetDefinition
	Pointer to jet definition.
fastjet::ClusterSequence *	m_clusterSequence
	Pointer to actual cluster sequence.
fastjet::AreaDefinition *	m_areaDefinition
	Pointer to area definition.
uint64_t	m_baseRNDSeed
	Base seed for random generator. Constructed from m_jetAlgorithm and m_radius.
uint64_t	m_userRNDSeed
	Seed modifier for random generator : a user property (default to 0, i.e m_baseRNDSeed is unmodified)
PROCESSOR	m_processor
	Pointer to processor.
EXTRACTOR	m_extractor
	Pointer to extractor.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
unsigned int	m_failedExecCtr
	Execution failure counter.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Static Private Attributes
static const std::string	m_invalidKeyReference = "INVALID_KEY"
	Reference for invalid fastjet tag.
static const unsigned int	m_failedExecCtrMax = 10
	Execution failure counter reporting cut-off.

Detailed Description

Wrapper for fastjet verion 2.4.4.

This wrapper provides the dictionary to translate a Athena tool configuration to known fastjet configurations at initilization. It executes the requested fastjet methods and provides access to the results. The data interfaces are purely based on the fastjet data model. This tool should therefore be wrapped by a module linking the fastjet data model to the Athena event data models for jet inputs.

The present version implements a rather large subset of fastjet functionality as is available in fastjet version 2.4.4. Accessing the largely improved features of fastjet versions 3.0.0 and up require adaptations of this tool.

Remarks on process control:

If Inclusive is false , exclusive jets are returned (a) based on \( d_{cut} \) if ExclusiveDcut > 0 or (b) based on \( N_{jet} \) if ExclusiveDcut < 0.

Definition at line 107 of file FastJetInterfaceTool.h.

Member Typedef Documentation

EXTRACTOR

typedef StatusCode(FastJetInterfaceTool::* FastJetInterfaceTool::EXTRACTOR) (FastJetInterface::fjetlist_t &outJets)

protected

Extractor function pointer type.

Definition at line 415 of file FastJetInterfaceTool.h.

fjet_t

typedef fastjet::PseudoJet IFastJetInterfaceTool::fjet_t

inherited

Definition at line 29 of file IFastJetInterfaceTool.h.

fjetlist_t

typedef std::vector<fjet_t> IFastJetInterfaceTool::fjetlist_t

inherited

Definition at line 30 of file IFastJetInterfaceTool.h.

PROCESSOR

typedef StatusCode(FastJetInterfaceTool::* FastJetInterfaceTool::PROCESSOR) (const FastJetInterface::fjetlist_t &inJets, FastJetInterface::fjetlist_t &outJets)

protected

Processor function pointer type.

Definition at line 411 of file FastJetInterfaceTool.h.

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

FastJetInterfaceTool()

FastJetInterfaceTool::FastJetInterfaceTool

(

const std::string &

n

)

Standard AlgTool constructor.

Definition at line 129 of file FastJetInterfaceTool.cxx.

  : asg::AsgTool(n)
    // jet clustering and jet definition --- ////////// jet clustering
  , m_clusterSequenceType("ClusterSequence") // <--{ not used right now!
  , m_jetAlgorithmType("anti-kt")            // 
  , m_clusterStrategyType("Best")            // 
  , m_recombinationSchemeType("E")           // 
  , m_CMS_seedThreshold(15.)                 //
  , m_SIS_overlapThreshold(0.75)             //
  , m_SIS_nPass(0)                           //
  , m_SIS_protojetPtMin(0.0)                 //
  , m_SIS_doCaching(false)                   //
  , m_SIS_splitMergeScale_STRING("PtTilde")  //
  , m_SIS_splitMergeStopScale(0.0)           //
  , m_radius(0.4)                            //
  , m_inclusive(true)                        //
  , m_exclusiveDcut(0.5)                     //
  , m_exclusiveNjets(3)                      //
  , m_pTmin(0.)                              //
    // jet areas --------------------------- ////////// jet areas
  , m_doJetArea(false)                       //
  , m_jetAreaDefinitionType("VoronoiArea")   //
    // Voronoi area specs                    // -- Voronoi
  , m_voronoiEffectiveRfact(1.0)             //
    // ghosted area specs                    // -- ghosted -- //
  , m_ghostedMaxRap(fastjet::gas::def_ghost_maxrap)           //
  , m_ghostedMinRap(-m_ghostedMaxRap)                         //
  , m_ghostedRepeat(fastjet::gas::def_repeat)                 //
  , m_ghostedArea(fastjet::gas::def_ghost_area)               //
  , m_ghostedGridScatter(fastjet::gas::def_grid_scatter)      //
  , m_ghostedKtScatter(fastjet::gas::def_pt_scatter)          //
  , m_ghostedMeanKt(fastjet::gas::def_mean_ghost_pt)          //
    // process control ----------------------///////////////////
  , m_failedExecCtr(0)
    // presets                               ////////// private data presets 
  , m_jetDefinition((fastjet::JetDefinition*)nullptr)
  , m_clusterSequence((fastjet::ClusterSequence*)nullptr)
  , m_areaDefinition((fastjet::AreaDefinition*)nullptr)
  , m_baseRNDSeed (0)
  , m_userRNDSeed (0)
{
    //declareInterface<IFastJetInterfaceTool>(this);
  // setup choices
  //  declareProperty("ClusterSequence",m_clusterSequenceType);
  declareProperty("Algorithm",m_jetAlgorithmType);
  // parameters for kt-style jets
  declareProperty("Strategy",m_clusterStrategyType);
  declareProperty("RecombScheme",m_recombinationSchemeType);
  // parameters for CMS cone jets
  declareProperty("CMS_SeedThreshold",m_CMS_seedThreshold);
  // parameters for SIS cone jets
  declareProperty("SIS_OverlapThreshold",m_SIS_overlapThreshold);
  declareProperty("SIS_NumPassMax",m_SIS_nPass);
  declareProperty("SIS_ProtojetPtMin",m_SIS_protojetPtMin);
  declareProperty("SIS_DoCaching",m_SIS_doCaching);
  declareProperty("SIS_SplitMergeScale",m_SIS_splitMergeScale_STRING);
  declareProperty("SIS_SplitMergeStopScale",m_SIS_splitMergeStopScale);
  // parameters for jet finders/jet definition
  declareProperty("Radius",m_radius);
  declareProperty("Inclusive",m_inclusive);
  declareProperty("InclusivePtMin",m_pTmin);
  declareProperty("ExclusiveDcut",m_exclusiveDcut);
  declareProperty("ExclusiveNjets",m_exclusiveNjets);
  // parameters for areas
  declareProperty("CalculateJetArea",m_doJetArea);
  declareProperty("JetAreaMethod",m_jetAreaDefinitionType);
  declareProperty("VoronoiEffectiveRfact",m_voronoiEffectiveRfact);
  declareProperty("GhostMaxRapidity",m_ghostedMaxRap);
  declareProperty("GhostMinRapidity",m_ghostedMinRap);
  declareProperty("GhostRepeats",m_ghostedRepeat);
  declareProperty("GhostAreaSize",m_ghostedArea);
  declareProperty("GhostGridScatter",m_ghostedGridScatter);
  declareProperty("GhostKtScatter",m_ghostedKtScatter);
  declareProperty("GhostMeanKt",m_ghostedMeanKt);
 
  declareProperty("UserRNDSeed", m_userRNDSeed = 0, "Added to the base RND seed for active areas. USE WITH CARE !");
 
  // default processor
  m_processor = &FastJetInterfaceTool::f_processWithoutArea;
  m_extractor = &FastJetInterfaceTool::f_extractInclusive;
  // other presets (will be set/overwritten in initialize)
  m_jetAlgorithm        = fastjet::antikt_algorithm;
  m_strategy            = fastjet::Best;
  m_areaType            = fastjet::voronoi_area;
  m_recombinationScheme = fastjet::E_scheme;
#ifndef XAOD_STANDALONE
  m_SIS_splitMergeScale = fastjet::SISConePlugin::SM_pttilde;
#endif
 
}

~FastJetInterfaceTool()

FastJetInterfaceTool::~FastJetInterfaceTool ( )

virtual

Base class destructor.

Definition at line 220 of file FastJetInterfaceTool.cxx.

{ 
  if(m_jetDefinition)  delete m_jetDefinition;
  if(m_areaDefinition) delete m_areaDefinition;
  if(m_clusterSequence) delete m_clusterSequence; 
 
}

Member Function Documentation

checkConfig() [1/5]

bool FastJetInterfaceTool::checkConfig ( const std::string & key, fastjet::JetAlgorithm & fjalg )

protected

Check configuration keyword for jet algorithm.

Returns

true if keyword is valid, else false

Parameters

[in]	key	client provided keyword
[out]	fjalg	fastjet tag

Definition at line 458 of file FastJetInterfaceTool.cxx.

{
  const algomap_t& map = this->getKnownAlgorithms();
  return chkConfig(key,fjalg,map);
}

checkConfig() [2/5]

bool FastJetInterfaceTool::checkConfig ( const std::string & key, fastjet::RecombinationScheme & fjrs )

protected

Check configuration keyword for recombination scheme.

Returns

true if keyword is valid, else false

Parameters

[in]	key	client provided keyword
[out]	fjrs	fastjet tag

Definition at line 472 of file FastJetInterfaceTool.cxx.

{
  const schememap_t& map = this->getKnownRecombinationSchemes();
  return chkConfig(key,fjrs,map);
}

checkConfig() [3/5]

bool FastJetInterfaceTool::checkConfig ( const std::string & key, fastjet::SISConePlugin::SplitMergeScale & fjsms )

protected

Check configuration keyword for SIS Cone split merge scale.

Returns

true if keyword is valid, else false

Parameters

[in]	key	client provided keyword
[out]	fjsms	fastjet tag

Definition at line 480 of file FastJetInterfaceTool.cxx.

{
  const splitMergeScaleMap_t& map = this->getKnownSplitMergeScales();
  return chkConfig(key,fjsms,map);
}

checkConfig() [4/5]

bool FastJetInterfaceTool::checkConfig ( const std::string & key, fastjet::Strategy & fjstr )

protected

Check configuration keyword for jet clustering strategy.

Returns

true if keyword is valid, else false

Parameters

[in]	key	client provided keyword
[out]	fjstr	fastjet tag

Definition at line 465 of file FastJetInterfaceTool.cxx.

{
  const strategymap_t& map = this->getKnownStrategies();
  return chkConfig(key,fjstr,map);
}

checkConfig() [5/5]

bool FastJetInterfaceTool::checkConfig ( const std::string & tag, fastjet::AreaType & fjart )

protected

Check configuration keyword for jet area type.

Returns

true if keyword is valid, else false

Parameters

[in]	key	client provided keyword
[out]	fjart	fastjet tag

Definition at line 488 of file FastJetInterfaceTool.cxx.

{
  const areamap_t& map = this->getKnownAreas();
  return chkConfig(key,fjart,map);
}

clusterSequence() [1/2]

fastjet::ClusterSequence * FastJetInterfaceTool::clusterSequence ( )

virtual

Access fastjet ClusterSequence.

Returns

Pointer to actual ClusterSequence object. Note that this object will only be updated after invoking the FastJetInterfaceTool::execute(...) method.

The object pointed to can be modified by client.

Implements IFastJetInterfaceTool.

Definition at line 576 of file FastJetInterfaceTool.cxx.

{ return m_clusterSequence; }

clusterSequence() [2/2]

const fastjet::ClusterSequence * FastJetInterfaceTool::clusterSequence ( ) const

virtual

Access fastjet ClusterSequence.

Returns

Const pointer to actual ClusterSequence object. Note that this object will only be updated after invoking the FastJetInterfaceTool::execute(...) method.

The object pointed to cannot be modified by client.

Implements IFastJetInterfaceTool.

Definition at line 579 of file FastJetInterfaceTool.cxx.

{ return m_clusterSequence; }

configJetAreas()

StatusCode FastJetInterfaceTool::configJetAreas ( )

protected

Configures jet area calculation strategy.

Returns

StatusCode::SUCCESS if area algorithm configured alright, else StatusCode::FAILURE (most likely indicates invalid area algorithm specs in the properties of the tool).

Definition at line 591 of file FastJetInterfaceTool.cxx.

{
  // check area type
  const areamap_t& map = getKnownAreas();
  const auto pPair = map.find("default");
  if (pPair == map.end()){
    return StatusCode::FAILURE;
  }
  m_areaType = pPair->second;
  if ( !checkConfig(m_jetAreaDefinitionType,m_areaType) )
    { return StatusCode::FAILURE; }
  // area definition according to type
  switch ( m_areaType )
    {
      // Voronoi
    case fastjet::voronoi_area:
      m_areaDefinition = 
    new 
    fastjet::AreaDefinition(fastjet::VoronoiAreaSpec(m_voronoiEffectiveRfact));
      break;
      // Ghosted
    case fastjet::active_area:
    case fastjet::active_area_explicit_ghosts:
    case fastjet::one_ghost_passive_area:
    case fastjet::passive_area:
      {
        fastjet::GhostedAreaSpec Garea_spec(m_ghostedMinRap,
                                            m_ghostedMaxRap,
                                            m_ghostedRepeat,
                                            m_ghostedArea,
                                            m_ghostedGridScatter,
                                            m_ghostedKtScatter,
                                            m_ghostedMeanKt);
 
        // create a seed from the jet alg and the seed
        m_baseRNDSeed = CxxUtils::crc64 ("FastJet");
        m_baseRNDSeed = CxxUtils::crc64addint (m_baseRNDSeed, (uint64_t) m_jetAlgorithm);
        m_baseRNDSeed = CxxUtils::crc64addint (m_baseRNDSeed, uint64_t (m_radius*10) );
        m_baseRNDSeed += m_userRNDSeed;
        // seed will be modified and reset in the Garea_spec for each event (see updateRandomSeeds() ).
 
        ATH_MSG_DEBUG(" Base  seed = "<< m_baseRNDSeed<< "  user seed ="<< m_userRNDSeed );
 
        m_areaDefinition = new fastjet::AreaDefinition(Garea_spec,                    
                                                       m_areaType);
        break;
      }
      // others
    default:
      m_areaDefinition = new fastjet::AreaDefinition(m_areaType);
      break;
    } // switch through area options
      
  // configure processor
  return StatusCode::SUCCESS;
}

configName() [1/5]

const std::string & FastJetInterfaceTool::configName ( fastjet::AreaType fjart )

protected

Get keyword for fastjet configuration.

Returns

Keyword if fastjet tag is known, else reference to "unknown"

Parameters

[in]

fjrs

fastjet area type tag

Definition at line 522 of file FastJetInterfaceTool.cxx.

{
  const areamap_t& map = this->getKnownAreas();
  return cfgName(fjart,map,m_invalidKeyReference);
}

configName() [2/5]

const std::string & FastJetInterfaceTool::configName ( fastjet::JetAlgorithm fjalg )

protected

Get keyword for fastjet configuration.

Returns

Keyword if fastjet tag is known, else reference to "unknown"

Parameters

[in]

fjalg

fastjet jet algorithm tag

Definition at line 495 of file FastJetInterfaceTool.cxx.

{
  const algomap_t& map = this->getKnownAlgorithms();
  return cfgName(fjalg,map,m_invalidKeyReference);
}

configName() [3/5]

const std::string & FastJetInterfaceTool::configName ( fastjet::RecombinationScheme fjrs )

protected

Get keyword for fastjet configuration.

Returns

Keyword if fastjet tag is known, else reference to "unknown"

Parameters

[in]

fjrs

fastjet recombination scheme tag

Definition at line 508 of file FastJetInterfaceTool.cxx.

{
  const schememap_t& map = this->getKnownRecombinationSchemes();
  return cfgName(fjrs,map,m_invalidKeyReference);
}

configName() [4/5]

const std::string & FastJetInterfaceTool::configName ( fastjet::SISConePlugin::SplitMergeScale fjsms )

protected

Get keyword for fastjet configuration.

Returns

Keyword if fastjet tag is known, else reference to "unknown"

Parameters

[in]

fjsms

fastjet SIS Cone split merge scale tag

Definition at line 516 of file FastJetInterfaceTool.cxx.

{
  const splitMergeScaleMap_t& map = this->getKnownSplitMergeScales();
  return cfgName(fjsms,map,m_invalidKeyReference);
}

configName() [5/5]

const std::string & FastJetInterfaceTool::configName ( fastjet::Strategy fjstr )

protected

Get keyword for fastjet configuration.

Returns

Keyword if fastjet tag is known, else reference to "unknown"

Parameters

[in]

fjstr

fastjet jet clustering strategy tag

Definition at line 501 of file FastJetInterfaceTool.cxx.

{
  const strategymap_t& map = this->getKnownStrategies();
  return cfgName(fjstr,map,m_invalidKeyReference);
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode FastJetInterfaceTool::execute ( const fjetlist_t & inJets, fjetlist_t & outJets )

virtual

Execute method.

Executes the requested fastjet configuration.

Parameters

[in]	inJets	reference to non-modifiable list of input objects
[out]	outJets	reference to modifiable list of output jets

Returns

StatusCode::SUCCESS independent of successful execution

Implements IFastJetInterfaceTool.

Definition at line 419 of file FastJetInterfaceTool.cxx.

{
  // clean up
  ATH_MSG_DEBUG( "  FastJetInterfaceTool::execute  injet size = "<< inJets.size() );
 
  if ( m_clusterSequence != nullptr ) 
    {
      delete m_clusterSequence;
      m_clusterSequence = (fastjet::ClusterSequence*)nullptr;
    }
  
  if ( ((this->*m_processor)(inJets,outJets)).isFailure() )
    {
      ++m_failedExecCtr;
      if ( m_failedExecCtr < m_failedExecCtrMax )
    {
      msg(MSG::WARNING) << "Cannot allocate new fastjet::ClusterSequence,"
                << " no jets found (message " 
                << m_failedExecCtr << " of "
                << m_failedExecCtrMax << ")" << endmsg;
    }
      else if ( m_failedExecCtr == m_failedExecCtrMax )
    {
      msg(MSG::WARNING) << "Cannot allocate new fastjet::ClusterSequence,"
                << " no jets found (message " 
                << m_failedExecCtr << " of "
                << m_failedExecCtrMax << ") [last message]" 
                << endmsg;
    }
      outJets.clear();
    }
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

f_extractExclDcut()

StatusCode FastJetInterfaceTool::f_extractExclDcut ( FastJetInterface::fjetlist_t & outJets )

protected

Exclusive extractor implementation.

Extracts exclusive jet sample defined by \( d_{cut} \) .

Parameters

[out]

outJets

reference to modifiable PseudoJet collection containing exclusive jet sample

Returns

StatusCode::SUCCESS if everything is ok.

Definition at line 569 of file FastJetInterfaceTool.cxx.

{
  outJets = m_clusterSequence->exclusive_jets(m_exclusiveDcut);
  ATH_MSG_DEBUG( "  extract exclusiveDcut outjets N= "<< outJets.size() );
  return ! outJets.empty() ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

f_extractExclNjets()

StatusCode FastJetInterfaceTool::f_extractExclNjets ( FastJetInterface::fjetlist_t & outJets )

protected

Exclusive extractor implementation.

Extracts exclusive jet sample defined by \( N_{jets} \) .

Parameters

[out]

outJets

reference to modifiable PseudoJet collection containing exclusive jet sample

Returns

StatusCode::SUCCESS if everything is ok.

Definition at line 561 of file FastJetInterfaceTool.cxx.

{
  outJets = m_clusterSequence->exclusive_jets(m_exclusiveNjets);
  ATH_MSG_DEBUG( "  extract exclusiveNjets outjets N= "<< outJets.size() );
 
  return !outJets.empty() ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

f_extractInclusive()

StatusCode FastJetInterfaceTool::f_extractInclusive ( FastJetInterface::fjetlist_t & outJets )

protected

Inclusive extractor implementation.

Extracts inclusive jets above a given \( p_T \) cut, as defined in the InclusivePtMin property.

Parameters

[out]

outJets

reference to modifiable PseudoJet collection containing inclusive jet sample

Returns

StatusCode::SUCCESS if everything is ok.

Definition at line 554 of file FastJetInterfaceTool.cxx.

{
  outJets = m_clusterSequence->inclusive_jets(m_pTmin);
  ATH_MSG_DEBUG( "  extract inclusive outjets N= "<< outJets.size() );
  return !outJets.empty() ? StatusCode::SUCCESS : StatusCode::FAILURE;
}

f_processWithArea()

StatusCode FastJetInterfaceTool::f_processWithArea ( const FastJetInterface::fjetlist_t & inJets, FastJetInterface::fjetlist_t & outJets )

protected

Processor implementation: cluster sequence with area calculation.

Sets up and executes a fastjet::ClusterSequence with finds jets with a client configured area calculation.

Returns

StatusCode::SUCCESS if execution ok, StatusCode::FAILURE if e.g. pointer to fastjet::ClusterSequence invalid, or returned jet list is empty.

Parameters

[in]	inJets	reference to non-modifiable list of fastjet::PseudoJet objects
[out]	outJets	reference to modifiable list of fastjet::PseudoJet objects to store output

Definition at line 542 of file FastJetInterfaceTool.cxx.

{
 
  updateRandomSeeds(); // make sure rnd seeds depend on event & run numbers
  m_clusterSequence = (fastjet::ClusterSequence*)
    new fastjet::ClusterSequenceArea(inJets,*m_jetDefinition,*m_areaDefinition);
 
  return m_clusterSequence != nullptr 
    ? (this->*m_extractor)(outJets) : StatusCode::FAILURE; 
}

f_processWithoutArea()

StatusCode FastJetInterfaceTool::f_processWithoutArea ( const FastJetInterface::fjetlist_t & inJets, FastJetInterface::fjetlist_t & outJets )

protected

Processor implementation: cluster sequence without area calculation.

Sets up and executes a fastjet::ClusterSequence with finds jets without area calculation.

Returns

StatusCode::SUCCESS if execution ok, StatusCode::FAILURE if e.g. pointer to fastjet::ClusterSequence invalid, or returned jet list is empty.

Parameters

[in]	inJets	reference to non-modifiable list of fastjet::PseudoJet objects
[out]	outJets	reference to modifiable list of fastjet::PseudoJet objects to store output

Definition at line 532 of file FastJetInterfaceTool.cxx.

{
  ATH_MSG_DEBUG( "  processing without area " );
  m_clusterSequence = new fastjet::ClusterSequence(inJets,*m_jetDefinition);
  ATH_MSG_DEBUG( "  processed without area " );
  return m_clusterSequence != nullptr 
    ? (this->*m_extractor)(outJets) : StatusCode::FAILURE;
}

getAreaDefinition()

const fastjet::AreaDefinition * FastJetInterfaceTool::getAreaDefinition ( ) const

virtual

Access fastjet AreaDefinition.

Returns

Const pointer to actual AreaDefinition object.

The object pointed to cannot be modified by client.

Implements IFastJetInterfaceTool.

Definition at line 585 of file FastJetInterfaceTool.cxx.

{ return m_areaDefinition; }

getAreaDefinitionType()

const std::string FastJetInterfaceTool::getAreaDefinitionType ( ) const

virtual

Access fastjet area definition type.

Returns

Const string of actual area definition type.

The string returned cannot be modified by client.

Implements IFastJetInterfaceTool.

Definition at line 588 of file FastJetInterfaceTool.cxx.

{ return m_jetAreaDefinitionType; }

getJetDefinition()

const fastjet::JetDefinition * FastJetInterfaceTool::getJetDefinition ( ) const

virtual

Access fastjet JetDefinition.

Returns

Const pointer to actual JetDefinition object.

The object pointed to cannot be modified by client.

Implements IFastJetInterfaceTool.

Definition at line 582 of file FastJetInterfaceTool.cxx.

{ return m_jetDefinition; }

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getKnownAlgorithms()

const algomap_t & FastJetInterfaceTool::getKnownAlgorithms

(

)

Get known jet algorithms.

Map of jet algorithm keywords and fastjet tags

Definition at line 27 of file FastJetInterfaceTool.cxx.

{
  static const FastJetInterface::algomap_t knownAlgorithms = {
    // kt-style algorithms
    {"default",           fastjet::antikt_algorithm},
    {"kt",                fastjet::kt_algorithm},
    {"anti-kt",           fastjet::antikt_algorithm},
    {"cambridge",         fastjet::cambridge_algorithm},
    {"genkt",             fastjet::genkt_algorithm},
    {"passive cambridge", fastjet::cambridge_for_passive_algorithm},
    {"passive genkt",     fastjet::genkt_for_passive_algorithm},
    // add also ATLAS kt-style
    {"Kt",         fastjet::kt_algorithm},
    {"AntiKt",     fastjet::antikt_algorithm},
    {"CamKt",      fastjet::cambridge_algorithm},
    // Plugin algorithms
    {"CMSCone",    fastjet::plugin_algorithm},
    {"SISCone",    fastjet::plugin_algorithm},
  };
  return knownAlgorithms;
}

getKnownAreas()

const areamap_t & FastJetInterfaceTool::getKnownAreas

(

)

Get known area types.

Map of jet area keywords and fastjet tags

Definition at line 110 of file FastJetInterfaceTool.cxx.

{
  static const FastJetInterface::areamap_t knownAreas = {
    {"default",    fastjet::voronoi_area},
    {"ActiveArea", fastjet::active_area},
    {"ActiveAreaExplicitGhost", fastjet::active_area_explicit_ghosts},
    {"PassiveArea", fastjet::passive_area},
    {"1GhostPassiveArea", fastjet::one_ghost_passive_area},
    {"VoronoiArea", fastjet::voronoi_area},
  };
  return knownAreas;
}

getKnownRecombinationSchemes()

const schememap_t & FastJetInterfaceTool::getKnownRecombinationSchemes

(

)

Get known recombination schemes.

Map of recombination scheme keywords and fastjet tags

Definition at line 74 of file FastJetInterfaceTool.cxx.

{
  static const FastJetInterface::schememap_t knownRecombinationSchemes = {
    {"default", fastjet::E_scheme},
    {"E",       fastjet::E_scheme},
    {"pt",      fastjet::pt_scheme},
    {"pt2",     fastjet::pt2_scheme},
    {"Et",      fastjet::Et_scheme},
    {"Et2",     fastjet::Et2_scheme},
    {"BIpt",    fastjet::BIpt_scheme},
    {"BIpt2",   fastjet::BIpt2_scheme},
  };
  return knownRecombinationSchemes;
}

getKnownSplitMergeScales()

const splitMergeScaleMap_t & FastJetInterfaceTool::getKnownSplitMergeScales

(

)

Get known split merge scales.

Map of split merge scale keywords and fastjet tags

Definition at line 91 of file FastJetInterfaceTool.cxx.

{
#ifndef XAOD_STANDALONE
  static const FastJetInterface::splitMergeScaleMap_t knownSplitMergeScales = {
    {"default", fastjet::SISConePlugin::SM_pttilde},
    {"pttilde", fastjet::SISConePlugin::SM_pttilde},
    {"PtTilde", fastjet::SISConePlugin::SM_pttilde},
    {"Pt",      fastjet::SISConePlugin::SM_pt},
    {"Et",      fastjet::SISConePlugin::SM_Et},
    {"mt",      fastjet::SISConePlugin::SM_mt},
  };
#else
  static const FastJetInterface::splitMergeScaleMap_t knownSplitMergeScales;
#endif
  return knownSplitMergeScales;
}

getKnownStrategies()

const strategymap_t & FastJetInterfaceTool::getKnownStrategies

(

)

Get known jet finding strategies.

Map of jet clustering strategy keywords and fastjet tags

Definition at line 51 of file FastJetInterfaceTool.cxx.

{
  static const FastJetInterface::strategymap_t knownStrategies = {
    {"default",         fastjet::Best},
    {"Best",            fastjet::Best},
    {"N2MinHeapTiled",  fastjet::N2MinHeapTiled},
    {"N2Tiled",         fastjet::N2Tiled},
    {"N2PoorTiled",     fastjet::N2PoorTiled},
    {"N2Plain",         fastjet::N2Plain},
    {"N3Dumb",          fastjet::N3Dumb},
    {"NlnN",            fastjet::NlnN},
    {"NlnN3pi",         fastjet::NlnN3pi},
    {"NlnN4pi",         fastjet::NlnN4pi},
    {"NlnNCam4pi",      fastjet::NlnNCam4pi},
    {"NlnNCam2pi2R",    fastjet::NlnNCam2pi2R},
    {"NlnNCam",         fastjet::NlnNCam},
    {"plugin_strategy", fastjet::plugin_strategy},
  };
  return knownStrategies;
}

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

initialize()

StatusCode FastJetInterfaceTool::initialize ( void )

virtual

Initialize tool.

Checks properties and configure fastjet

Reimplemented from asg::AsgTool.

Definition at line 232 of file FastJetInterfaceTool.cxx.

{
  ATH_MSG_DEBUG( "  initialize " );
 
  // check requested jet algorithm
  ATH_MSG_INFO("Algorithm type \042" << m_jetAlgorithmType << "\042");
  if ( !this->checkConfig(m_jetAlgorithmType,m_jetAlgorithm) )
    {
      msg(MSG::ERROR) << "FastJet configuration error: "
              << "Unknown jet algorithm \042"
              << m_jetAlgorithmType << "\042 requested"
              << endmsg;
      return StatusCode::FAILURE;
    }
  // check requested recombination scheme
  ATH_MSG_INFO("Recombination type \042" << m_recombinationSchemeType << "\042");
  if ( !this->checkConfig(m_recombinationSchemeType,m_recombinationScheme) )
    {
      msg(MSG::ERROR) << "FastJet configuration error: "
              << "Unknown recombination scheme \042"
              << m_recombinationScheme << "\042 requested"
              << endmsg;
      return StatusCode::FAILURE;
    }
  // check requested strategy
  ATH_MSG_INFO("Cluster strategy type \042" << m_clusterStrategyType << "\042");
  if ( !checkConfig(m_clusterStrategyType,m_strategy) )
    {
      msg(MSG::ERROR) << "FastJet configuration error: " 
              << "Unknown clustering strategy \042"
              << m_clusterStrategyType << "\042 requested" << endmsg;
      return StatusCode::FAILURE;
    }
  
  // determine the type of jet algorithm we have (kt-style vs plugins)
  enum jetAlgTypeEnum { unknown_type, Kt_type, CMS_type, SIS_type } jetAlgType = Kt_type;
  if (m_jetAlgorithm == fastjet::plugin_algorithm)
  {
    if (!m_jetAlgorithmType.compare("CMSCone"))
      jetAlgType = CMS_type; 
    else if(!m_jetAlgorithmType.compare("SISCone"))
      jetAlgType = SIS_type;
    else
      jetAlgType = unknown_type;
  }
  if (jetAlgType == unknown_type)
  {
    msg(MSG::ERROR) << "FastJet configuration error: "
                    << "Unknown jet algorithm plugin \042"
                    << m_jetAlgorithmType << "\042 requested" << endmsg;
    return StatusCode::FAILURE;
  }
 
#ifndef XAOD_STANDALONE
 
  // define jets depending on the jet type
  if (jetAlgType == CMS_type)
    m_jetDefinition = new fastjet::JetDefinition(new fastjet::CMSIterativeConePlugin(m_radius,m_CMS_seedThreshold));
  else if (jetAlgType == SIS_type)
    m_jetDefinition = new fastjet::JetDefinition(new fastjet::SISConePlugin(m_radius,
                                                                            m_SIS_overlapThreshold,
                                                                            m_SIS_nPass,
                                                                            m_SIS_protojetPtMin,
                                                                            m_SIS_doCaching,
                                                                            m_SIS_splitMergeScale,
                                                                            m_SIS_splitMergeStopScale
                                                                            ));
  else
    m_jetDefinition = new fastjet::JetDefinition(m_jetAlgorithm,
                                 m_radius,
                                 m_recombinationScheme,
                                 m_strategy);
#else 
  // no athena error on SIS or CMS
  if ( (jetAlgType == CMS_type) || (jetAlgType == SIS_type)){
    ATH_MSG_ERROR("CMS and SIScone plugin not supporeted outside athena yet");
    return StatusCode::FAILURE;
  }else
    m_jetDefinition = new fastjet::JetDefinition(m_jetAlgorithm,
                                 m_radius,
                                 m_recombinationScheme,
                                 m_strategy);
#endif    
 
 
  // without area calculation
  if ( !m_doJetArea )
    {
      m_processor = &FastJetInterfaceTool::f_processWithoutArea;
    }
  // with area calculation
  else
    {
      ATH_MSG_INFO("Jet area type \042" << m_jetAreaDefinitionType << "\042");
      if ( this->configJetAreas().isFailure() )
    {
      msg(MSG::ERROR) << "FastJet configuration error: "
              << "Clustering with areas requested but area type"
              << "\042" << m_jetAreaDefinitionType 
              << "\042 is not known" << endmsg;
      return StatusCode::FAILURE;
    }
      m_processor = &FastJetInterfaceTool::f_processWithArea;
    }
 
  // configure inclusive/exclusive jet extractor
  if ( m_inclusive )
    {
      m_extractor = &FastJetInterfaceTool::f_extractInclusive;
    } // inclusive jet finder
  else
    {
      // Priority:
      //  
      // if !inclusive: 
      //     m_exclusiveDcut > 0  -> yes
      //     m_exclusiveDcut <= 0 -> m_exclusiveNjets >= 0 -> yes
      //                             m_exclusiveNjets < 0 -> error
      if ( m_exclusiveDcut > 0. )
    {
      m_extractor = &FastJetInterfaceTool::f_extractExclDcut;
    }
      else
    {
      if ( m_exclusiveNjets >= 0 ) 
        {
          m_extractor = &FastJetInterfaceTool::f_extractExclNjets;
        } 
      else
        {
          msg(MSG::ERROR) << "Invalid configuration for exclusive "
                  << "jet finder, one of ExclusiveDcut("
                  << m_exclusiveDcut
                  << ") or ExclusiveNjets("
                  << m_exclusiveNjets
                  << ") properties should be >= 0."
                  << endmsg;
          return StatusCode::FAILURE;
        } // invalid configuration of exclusive jet finder
    } // exclusive jet finder using Njet cut
    } // exclusive jet finder using Dcut
 
  // print configuration
  msg(MSG::INFO) << "JetAlgorithm ................ \042" 
         << m_jetAlgorithmType << "\042" << endmsg;
  msg(MSG::INFO) << "Radius ...................... " << m_radius << endmsg;
  if (jetAlgType == Kt_type)
  {
    msg(MSG::INFO) << "Recombination scheme ........ \042"
           << m_recombinationSchemeType << "\042" << endmsg;
    msg(MSG::INFO) << "Strategy .................... \042"
           << m_clusterStrategyType << "\042" << endmsg;
  }
  else if (jetAlgType == CMS_type)
    msg(MSG::INFO) << "CMS seed threshold .......... "
                   << m_CMS_seedThreshold << endmsg;
  else if (jetAlgType == SIS_type)
  {
    msg(MSG::INFO) << "SIS overlap threshold ....... "
                   << m_SIS_overlapThreshold << endmsg;
    msg(MSG::INFO) << "SIS max num pass ............ "
                   << m_SIS_nPass << endmsg;
    msg(MSG::INFO) << "SIS protojet Pt min ......... "
                   << m_SIS_protojetPtMin << endmsg;
    msg(MSG::INFO) << "SIS do caching .............. "
                   << (m_SIS_doCaching ? std::string("yes") : std::string("no")) << endmsg;
    msg(MSG::INFO) << "SIS split/merge scale ....... \042"
                   << m_SIS_splitMergeScale_STRING << "\042" << endmsg;
    msg(MSG::INFO) << "SIS split/merge stop scale .. "
                   << m_SIS_splitMergeStopScale << endmsg;
  }
  if ( m_doJetArea )
    {
      msg(MSG::INFO) << "Calculate jet areas ......... yes" << endmsg;
      msg(MSG::INFO) << "Area type ................... \042" 
             << m_jetAreaDefinitionType << "\042" << endmsg;
    }
 
 
 
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

specificClusterSequence() [1/2]

template<class S>

S * FastJetInterfaceTool::specificClusterSequence ( )

inline

Access to specific cluster sequence.

The template parameter S is expect to be set to an object type derived from the basic fastjet ClusterSequence

Returns

Pointer to actual S object. Note that this object will only be updated after invoking the FastJetInterfaceTool::execute(...) method.

The object pointed to can be modified by client.

Definition at line 168 of file FastJetInterfaceTool.h.

  { return dynamic_cast<S*>(this->clusterSequence()); }

specificClusterSequence() [2/2]

template<class S>

const S * FastJetInterfaceTool::specificClusterSequence ( ) const

inline

Access to specific cluster sequence.

The template parameter S is expect to be set to an object type derived from the basic fastjet ClusterSequence

Returns

Const pointer to actual S object. Note that this object will only be updated after invoking the FastJetInterfaceTool::execute(...) method.

The object pointed to cannot be modified by client.

Definition at line 184 of file FastJetInterfaceTool.h.

  { return dynamic_cast<const S*>(this->clusterSequence()); }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateRandomSeeds()

void FastJetInterfaceTool::updateRandomSeeds ( )

protectedvirtual

Set the area rnd seed according to run/event numbers.

Definition at line 651 of file FastJetInterfaceTool.cxx.

{
 
 
  std::vector<int> seed;
  
  fastjet::GhostedAreaSpec & Garea_spec = m_areaDefinition->ghost_spec() ;
  Garea_spec.get_random_status (seed);
  
  unsigned int evnum = 0;
  unsigned int runnum = 0;
  
  const xAOD::EventInfo* ei = nullptr;
  if (evtStore()->retrieve (ei,"EventInfo").isSuccess()){
    evnum  = ei->eventNumber();
    runnum = ei->runNumber();
  }
 
  // Use both event and run nunmber to reset the random seeds
  uint64_t crc = CxxUtils::crc64addint (m_baseRNDSeed, evnum);
  crc = CxxUtils::crc64addint (crc, runnum);
  
  // Tacitly assuming that there are no consistency requirements
  // on the RNG state (true for the current RNG that fastjet uses).
  // Use fixed data sizes for crossplatform reproducibility.
  for (size_t i = 0; i < seed.size(); i++) {
    seed[i] = static_cast<int> (static_cast<uint32_t> (crc));
    crc = (crc >> 32) ^ crc;
  }
    
  
  Garea_spec.set_random_status (seed);
  seed.clear();
  Garea_spec.get_random_status (seed);
  ATH_MSG_DEBUG("area def "<< m_areaDefinition<< "   ghost spec= "<< &Garea_spec << " crc= "<< crc<< "  seed0="<< seed[0] << " seed1="<<seed[1]);
 
}

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_areaDefinition

fastjet::AreaDefinition* FastJetInterfaceTool::m_areaDefinition

protected

Pointer to area definition.

Definition at line 402 of file FastJetInterfaceTool.h.

m_areaType

fastjet::AreaType FastJetInterfaceTool::m_areaType

protected

fastjet tag: jet area type

Definition at line 390 of file FastJetInterfaceTool.h.

m_baseRNDSeed

uint64_t FastJetInterfaceTool::m_baseRNDSeed

protected

Base seed for random generator. Constructed from m_jetAlgorithm and m_radius.

Definition at line 405 of file FastJetInterfaceTool.h.

m_clusterSequence

fastjet::ClusterSequence* FastJetInterfaceTool::m_clusterSequence

protected

Pointer to actual cluster sequence.

Definition at line 400 of file FastJetInterfaceTool.h.

m_clusterSequenceType

std::string FastJetInterfaceTool::m_clusterSequenceType

protected

fastjet property: cluster sequence type

Definition at line 226 of file FastJetInterfaceTool.h.

m_clusterStrategyType

std::string FastJetInterfaceTool::m_clusterStrategyType

protected

fastjet property: cluster strategy

Definition at line 230 of file FastJetInterfaceTool.h.

m_CMS_seedThreshold

double FastJetInterfaceTool::m_CMS_seedThreshold

protected

fastjet property for CMS Cone plugin: seed threshold

Definition at line 235 of file FastJetInterfaceTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doJetArea

bool FastJetInterfaceTool::m_doJetArea

protected

Tool property: flag controls if jet area is calculated.

Definition at line 261 of file FastJetInterfaceTool.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_exclusiveDcut

double FastJetInterfaceTool::m_exclusiveDcut

protected

Exclusive jet finder property: d cut.

Definition at line 254 of file FastJetInterfaceTool.h.

m_exclusiveNjets

int FastJetInterfaceTool::m_exclusiveNjets

protected

Exclusive jet finder property: number of jets requested.

Definition at line 256 of file FastJetInterfaceTool.h.

m_extractor

EXTRACTOR FastJetInterfaceTool::m_extractor

protected

Pointer to extractor.

Definition at line 421 of file FastJetInterfaceTool.h.

m_failedExecCtr

unsigned int FastJetInterfaceTool::m_failedExecCtr

private

Execution failure counter.

Definition at line 376 of file FastJetInterfaceTool.h.

m_failedExecCtrMax

const unsigned int FastJetInterfaceTool::m_failedExecCtrMax = 10

staticprivate

Execution failure counter reporting cut-off.

Definition at line 378 of file FastJetInterfaceTool.h.

m_ghostedArea

double FastJetInterfaceTool::m_ghostedArea

protected

fastjet property: size of area coverded by each ghost

Definition at line 273 of file FastJetInterfaceTool.h.

m_ghostedGridScatter

double FastJetInterfaceTool::m_ghostedGridScatter

protected

fastjet property: scatter of ghosts on grid

Definition at line 275 of file FastJetInterfaceTool.h.

m_ghostedKtScatter

double FastJetInterfaceTool::m_ghostedKtScatter

protected

fastjet property: scatter of kT of ghosts

Definition at line 277 of file FastJetInterfaceTool.h.

m_ghostedMaxRap

double FastJetInterfaceTool::m_ghostedMaxRap

protected

fastjet property: ghost area rapidity limit (max)

Definition at line 267 of file FastJetInterfaceTool.h.

m_ghostedMeanKt

double FastJetInterfaceTool::m_ghostedMeanKt

protected

fastjet property: average kT of ghosts

Definition at line 279 of file FastJetInterfaceTool.h.

m_ghostedMinRap

double FastJetInterfaceTool::m_ghostedMinRap

protected

fastjet property: ghost area rapidity limit (min)

Definition at line 269 of file FastJetInterfaceTool.h.

m_ghostedRepeat

int FastJetInterfaceTool::m_ghostedRepeat

protected

fastjet property: ghost area calculation repeatitions

Definition at line 271 of file FastJetInterfaceTool.h.

m_inclusive

bool FastJetInterfaceTool::m_inclusive

protected

Jet algorithm control property: inclusive/exclusive jet finding.

Definition at line 252 of file FastJetInterfaceTool.h.

m_invalidKeyReference

const std::string FastJetInterfaceTool::m_invalidKeyReference = "INVALID_KEY"

staticprivate

Reference for invalid fastjet tag.

Definition at line 373 of file FastJetInterfaceTool.h.

m_jetAlgorithm

fastjet::JetAlgorithm FastJetInterfaceTool::m_jetAlgorithm

protected

fastjet tag: jet algorithm

Definition at line 386 of file FastJetInterfaceTool.h.

m_jetAlgorithmType

std::string FastJetInterfaceTool::m_jetAlgorithmType

protected

fastjet property: jet algorithm

Definition at line 228 of file FastJetInterfaceTool.h.

m_jetAreaDefinitionType

std::string FastJetInterfaceTool::m_jetAreaDefinitionType

protected

fastjet property: jet area definition

Definition at line 263 of file FastJetInterfaceTool.h.

m_jetDefinition

fastjet::JetDefinition* FastJetInterfaceTool::m_jetDefinition

protected

Pointer to jet definition.

Definition at line 398 of file FastJetInterfaceTool.h.

m_processor

PROCESSOR FastJetInterfaceTool::m_processor

protected

Pointer to processor.

Definition at line 419 of file FastJetInterfaceTool.h.

m_pTmin

double FastJetInterfaceTool::m_pTmin

protected

Inclusive jet finder property: pTmin cut.

Definition at line 258 of file FastJetInterfaceTool.h.

m_radius

double FastJetInterfaceTool::m_radius

protected

Jet algorithm property: radius/distance parameter.

Definition at line 250 of file FastJetInterfaceTool.h.

m_recombinationScheme

fastjet::RecombinationScheme FastJetInterfaceTool::m_recombinationScheme

protected

fastjet tag: recombination scheme

Definition at line 392 of file FastJetInterfaceTool.h.

m_recombinationSchemeType

std::string FastJetInterfaceTool::m_recombinationSchemeType

protected

fastjet property: recombination scheme

Definition at line 232 of file FastJetInterfaceTool.h.

m_SIS_doCaching

bool FastJetInterfaceTool::m_SIS_doCaching

protected

fastjet property for SIS Cone plugin: do caching

Definition at line 243 of file FastJetInterfaceTool.h.

m_SIS_nPass

int FastJetInterfaceTool::m_SIS_nPass

protected

fastjet property for SIS Cone plugin: max number of passes

Definition at line 239 of file FastJetInterfaceTool.h.

m_SIS_overlapThreshold

double FastJetInterfaceTool::m_SIS_overlapThreshold

protected

fastjet property for SIS Cone plugin: overlap threshold

Definition at line 237 of file FastJetInterfaceTool.h.

m_SIS_protojetPtMin

double FastJetInterfaceTool::m_SIS_protojetPtMin

protected

fastjet property for SIS Cone plugin: protojet min pt

Definition at line 241 of file FastJetInterfaceTool.h.

m_SIS_splitMergeScale

fastjet::SISConePlugin::SplitMergeScale FastJetInterfaceTool::m_SIS_splitMergeScale

protected

fastjet tag: SIS split merge scale

Definition at line 395 of file FastJetInterfaceTool.h.

m_SIS_splitMergeScale_STRING

std::string FastJetInterfaceTool::m_SIS_splitMergeScale_STRING

protected

fastjet property for SIS Cone plugin: split merge scale

Definition at line 245 of file FastJetInterfaceTool.h.

m_SIS_splitMergeStopScale

double FastJetInterfaceTool::m_SIS_splitMergeStopScale

protected

fastjet property for SIS Cone plugin: split merge stop scale

Definition at line 247 of file FastJetInterfaceTool.h.

m_strategy

fastjet::Strategy FastJetInterfaceTool::m_strategy

protected

fastjet tag: jet clustering strategy

Definition at line 388 of file FastJetInterfaceTool.h.

m_userRNDSeed

uint64_t FastJetInterfaceTool::m_userRNDSeed

protected

Seed modifier for random generator : a user property (default to 0, i.e m_baseRNDSeed is unmodified)

Definition at line 407 of file FastJetInterfaceTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_voronoiEffectiveRfact

double FastJetInterfaceTool::m_voronoiEffectiveRfact

protected

fastjet property: Voronoi area effective radius

Definition at line 265 of file FastJetInterfaceTool.h.

---

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

• FastJetInterfaceTool.h
• FastJetInterfaceTool.cxx