Ringer Namespace Reference

Namespace dedicated for Ringer utilities. More...

Namespaces
	Discrimination
	Namespace dedicated for Ringer Discrimination utilities.
	onnx
	PreProcessing
	Namespace dedicated for Ringer pre-processing utilities.

Classes
class	AsgRingerSelectorTool
class	BitdefElectron_v1
	Define electron bits (v1) More...
class	BuildCaloRingsFctor
class	BuildCaloRingsFctorBase
	Interface for CaloRings builder functor. More...
class	CaloAsymRingsBuilder
class	CaloRingerAlgorithm
	Algorithm responsable for CaloRinger execution. More...
class	CaloRingerElectronsReader
class	CaloRingerInputReader
class	CaloRingerPhotonsReader
class	CaloRingsBuilder
class	CaloStripsRingsBuilder
class	DepVarStruct
class	ElectronTAccept_v1
	Get electron defined TAccept and its masks. More...
struct	GetParticleProp
	template to get particle_t name and if it has cluster access. More...
class	IAsgRingerSelectorTool
class	ICaloRingerElectronsReader
class	ICaloRingerInputReader
class	ICaloRingerPhotonsReader
class	ICaloRingsBuilder
class	IRingerProcedure
	The base interface for all Ringer procedures. More...
class	IRingerProcedureWrapper
	Specialization for Discriminator procedure. More...
class	IRingerProcedureWrapper< Discrimination::IDiscriminator >
class	IRingerProcedureWrapper< PreProcessing::IPreProcessor >
class	IRingerProcedureWrapperBase
	Used as base for all IRingerProcedureWrapper template specializations. More...
class	RingerCommonSelector
class	RingerIOVarDepObj
	Objects that can be recorded/read into/from configuration files. More...
class	RingerProcedureType
	Check Ringer Procedure type. More...
struct	RingerProcedureType< procedure_t * >
	RingerProcedureType specialization to ensure that procedure_t is not a pointer. More...
class	RingerProcedureWrapper
	Specialization for Discriminator procedure. More...
class	RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >
class	RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >
class	VariableDependency
	Interface for possible Eta and Et variable dependency. More...
class	xAODRingSetConfWriter
	Algorithm used to write the RingSets configuration. More...

Typedefs
typedef ElectronTAccept_v1	ElectronTAccept
typedef BitdefElectron_v1	BitdefElectron
typedef IRingerProcedureWrapper< Discrimination::IDiscriminator >	IDiscrWrapper
	Facilitate access into Discrimination Wrappers. More...
typedef IDiscrWrapper::WrapperCollection	IDiscrWrapperCollection
	Facilitate access into Discrimination Wrappers. More...
typedef IRingerProcedureWrapper< PreProcessing::IPreProcessor >	IPreProcWrapper
	Facilitate access into Threshold Wrappers. More...
typedef IPreProcWrapper::WrapperCollection	IPreProcWrapperCollection
	Facilitate access into Threshold Wrappers collection. More...
typedef IRingerProcedureWrapperBase	IProcWrapperBase
	Reduce verbosity. More...
typedef std::vector< IProcWrapperBase >	IProcWrapperBaseCollection
	Collection of interface base. More...

Enumerations
enum	CalJointSection { EM, HAD, NJointSections, UnknownJointSection }
	the joint calorimeter sections. More...
enum	CalJointLayer {   PS, EM1, EM2, EM3,   HAD1, HAD2, HAD3, NJointLayers,   UnknownJointLayer }
	the joint calorimeter layers. More...
enum	SegmentationType {   NoSegmentation = 0, TrackCalSegmentation, TrackCalPatTypeSegmentation, TrackCalJointSections,   TrackCalJointLayers, NSegmentations }
	the possible procedure longitudinal segmentation types. More...
enum	EtaDependency { EtaIndependent = 0, EtaDependent, NEtaDependencies }
	Specify eta position dependency. More...
enum	EtDependency { EtIndependent = 0, EtDependent, NEtDependencies }
	Specify et position dependency. More...
enum	Requirement {   Loose_CutID_Pd = 0, Medium_CutID_Pd, Tight_CutID_Pd, Loose_CutID_Pf,   Medium_CutID_Pf, Tight_CutID_Pf, Loose_LH_Pd, Medium_LH_Pd,   Tight_LH_Pd, Loose_LH_Pf, Medium_LH_Pf, Tight_LH_Pf,   Medium_MaxSP, Loose, Medium, Tight,   NoCut, NRequirements }
	the cut requirement More...

Functions
bool	check_wrap_around (const double phi_center, const bool reverse_wrap)
	Helper function to identify wrap around cases. More...
double	fix_wrap_around (const double phi_value, const bool reverse_wrap)
	Helper function to fix wrap around cases. More...

Detailed Description

Namespace dedicated for Ringer utilities.

WARNING: Do not change the order of the enumerations for backward files compatibility!!

This means that if a new value is needed, add it to the end (before the Nxxx enumeration) of the enumeration, instead of adding it to any place in the enumeration.

After adding a enumeration type, also add it to the methods in the RingerSelectorToolsDefs.cxx file.

Namespace dedicated for Ringer utilities

Typedef Documentation

BitdefElectron

typedef BitdefElectron_v1 Ringer::BitdefElectron

Definition at line 150 of file ElectronTAccept.h.

ElectronTAccept

typedef ElectronTAccept_v1 Ringer::ElectronTAccept

Definition at line 148 of file ElectronTAccept.h.

IDiscrWrapper

typedef IRingerProcedureWrapper< Discrimination::IDiscriminator > Ringer::IDiscrWrapper

Facilitate access into Discrimination Wrappers.

Definition at line 140 of file RingerDiscriminatorWrapper.h.

IDiscrWrapperCollection

typedef IDiscrWrapper::WrapperCollection Ringer::IDiscrWrapperCollection

Facilitate access into Discrimination Wrappers.

Definition at line 145 of file RingerDiscriminatorWrapper.h.

IPreProcWrapper

typedef IRingerProcedureWrapper< PreProcessing::IPreProcessor > Ringer::IPreProcWrapper

Facilitate access into Threshold Wrappers.

Definition at line 114 of file RingerPreProcessorWrapper.h.

IPreProcWrapperCollection

typedef IPreProcWrapper::WrapperCollection Ringer::IPreProcWrapperCollection

Facilitate access into Threshold Wrappers collection.

Definition at line 118 of file RingerPreProcessorWrapper.h.

IProcWrapperBase

typedef IRingerProcedureWrapperBase Ringer::IProcWrapperBase

Reduce verbosity.

Definition at line 126 of file RingerProcedureWrapper.h.

IProcWrapperBaseCollection

typedef std::vector<IProcWrapperBase> Ringer::IProcWrapperBaseCollection

Collection of interface base.

Definition at line 131 of file RingerProcedureWrapper.h.

Enumeration Type Documentation

CalJointLayer

enum Ringer::CalJointLayer

the joint calorimeter layers.

• PS stands for pre-sampler barrel and endcap;
• EM1 stands for the barrel and endcap of the first eletromagnetic calorimeter layer.
• EM2 stands for the barrel and endcap of the second eletromagnetic calorimeter layer.
• EM3 stands for the barrel and endcap of the third eletromagnetic calorimeter layer.
• HAD1 stands for the first hadronic calorimeter layer of the TileCal barrel and extended barrel.
• HAD2 stands for the second hadronic calorimeter layer of the TileCal barrel and extended barrel.
• HAD3 stands for the third hadronic calorimeter layer of the TileCal barrel and extended barrel.

Enumerator
PS
EM1
EM2
EM3
HAD1
HAD2
HAD3
NJointLayers
UnknownJointLayer

Definition at line 45 of file CaloRingsDefs.h.

                   {
  PS,
  EM1,
  EM2,
  EM3,
  HAD1,
  HAD2,
  HAD3,
  NJointLayers,
  UnknownJointLayer
};

CalJointSection

enum Ringer::CalJointSection

the joint calorimeter sections.

• EM stands for all eletromagnetic layers (included Pre-Sampler);
• HAD stands for all hadronic calorimeter layers.

Enumerator
EM
HAD
NJointSections
UnknownJointSection

Definition at line 18 of file CaloRingsDefs.h.

                     {
  EM,
  HAD,
  NJointSections,
  UnknownJointSection
};

EtaDependency

enum Ringer::EtaDependency

Specify eta position dependency.

This specifies whether the discriminator will operate only for a small (bin) eta region or will operate for the full analysis region (generally the ATLAS precision region).

Enumerator
EtaIndependent
EtaDependent
NEtaDependencies

Definition at line 81 of file RingerSelectorToolsEnums.h.

                   {
  EtaIndependent = 0,
  EtaDependent,
  NEtaDependencies
};

EtDependency

enum Ringer::EtDependency

Specify et position dependency.

This specifies whether the discriminator will operate only for a small (bin) Et region or will operate for the full analysis region (generally the ATLAS precision region).

Enumerator
EtIndependent
EtDependent
NEtDependencies

Definition at line 95 of file RingerSelectorToolsEnums.h.

                  {
  EtIndependent = 0,
  EtDependent,
  NEtDependencies
};

Requirement

enum Ringer::Requirement

the cut requirement

Enumerator
Loose_CutID_Pd
Medium_CutID_Pd
Tight_CutID_Pd
Loose_CutID_Pf
Medium_CutID_Pf
Tight_CutID_Pf
Loose_LH_Pd
Medium_LH_Pd
Tight_LH_Pd
Loose_LH_Pf
Medium_LH_Pf
Tight_LH_Pf
Medium_MaxSP
Loose
Medium
Tight
NoCut
NRequirements

Definition at line 104 of file RingerSelectorToolsEnums.h.

                 {
  Loose_CutID_Pd = 0, // Same detection probability as CutID Loose
  Medium_CutID_Pd,    // Same detection probability as CutID Medium
  Tight_CutID_Pd,     // Same detection probability as CutID Tight
  Loose_CutID_Pf,     // Same false alarm probability as CutID Loose
  Medium_CutID_Pf,    // Same false alarm probability as CutID Medium
  Tight_CutID_Pf,     // Same false alarm probability as CutID Tight
  Loose_LH_Pd,        // Same detection probability as LH Loose
  Medium_LH_Pd,       // Same detection probability as LH Medium
  Tight_LH_Pd,        // Same detection probability as LH Tight
  Loose_LH_Pf,        // Same false alarm probability as LH Loose
  Medium_LH_Pf,       // Same false alarm probability as LH Medium
  Tight_LH_Pf,        // Same false alarm probability as LH Tight
  Medium_MaxSP,       // Maximum SP-product
  Loose,              // Same as LooseCutIDPd
  Medium,             // Same as MediumSP
  Tight,              // Same as TightCutIDPf
  NoCut,              // Run to retrieve discriminators output, but no cut is applied
  NRequirements       // Number of Requirements available
};

SegmentationType

enum Ringer::SegmentationType

the possible procedure longitudinal segmentation types.

• NoSegmentation stands for a unique representation for all data. This may mean that the procedure:

  o is not applied for a pattern segment;

  o has a specialized implemented approach that works in distinct depths of the segmented information.

  o cannot be applied in a segmentation approach. This is the case whenever the procedure is not applied in the first layer or if the procedure is the application of a threshold. In another words, only the first PreProcessor and the first discriminator may have access to segmented information, the later only if its pre-processing chain does not affect the output segmentation.

• TrackCalSegmentation will segmentate track (if information available) from calorimeter.
• TrackCalPatTypeSegmentation will segmentate track (if information available) from calorimeter, the latter also being segmented between the standard calorimeter patterns and rings.
• TrackCalJointSections will segmentate track (if information available) from calorimeter. Besides, the calorimeter information will be segmentated through CalJointSections (see xAODCaloRings/CaloRingsDefs.h).
• TrackCalJointLayers will segmentate track (if information available) from calorimeter. Besides, the calorimeter information will be segmentated through CalJointLayers (see xAODCaloRings/CaloRingsDefs.h).

If adding a new value on this enumeration, add it to the numberOfSegments function on RingerSelectorToolsDefs.cxx

Enumerator
NoSegmentation
TrackCalSegmentation
TrackCalPatTypeSegmentation
TrackCalJointSections
TrackCalJointLayers
NSegmentations

Definition at line 64 of file RingerSelectorToolsEnums.h.

                      {
  NoSegmentation = 0,
  TrackCalSegmentation,
  TrackCalPatTypeSegmentation,
  TrackCalJointSections,
  TrackCalJointLayers,
  NSegmentations
};

Function Documentation

check_wrap_around()

bool Ringer::check_wrap_around ( const double  phi_center, const bool  reverse_wrap  )

inline

Helper function to identify wrap around cases.

if reverse_wrap = true, then we check for reverse wrap_arround.

Definition at line 17 of file PhiComps.h.

                                                                                  {
    if (reverse_wrap) return (phi_center < (1.0 - M_PI)); // 1.0 is the PI_THRESHOLD
    else return (phi_center > (M_PI - 1.0));
  }

fix_wrap_around()

double Ringer::fix_wrap_around ( const double  phi_value, const bool  reverse_wrap  )

inline

Helper function to fix wrap around cases.

if reverse_wrap = true, then we fix reverse wrap_arround cases.

Definition at line 26 of file PhiComps.h.

                                                                                 {
    if (reverse_wrap) {
      if (phi_value > 0.)  return (phi_value - 2*M_PI);
    } else {
      if (phi_value < 0.) return (phi_value + 2*M_PI);
    }
    return phi_value;
  }

getType() [1/2]

template<typename T >

T Ringer::getType

(

const char *

cStr

)

Return Ringer enumeration of type T identifying string type:

getType() [2/2]

template<>

Requirement Ringer::getType

(

const char *

cStr

)

Specialization for SegmentationType.

Specialization for Requirement.

Specialization for EtDependency.

Specialization for EtaDependency.

numberOfSegments()

unsigned Ringer::numberOfSegments

(

const SegmentationType

e

)

toStr() [1/4]

const char* Ringer::toStr

(

EtaDependency

e

)

Transform enumeration types to string.

toStr() [2/4]

const char* Ringer::toStr

(

EtDependency

e

)

Transform enumeration types to string.

toStr() [3/4]

const char* Ringer::toStr

(

Requirement

e

)

Transform enumeration types to string.

toStr() [4/4]

const char* Ringer::toStr

(

SegmentationType

e

)

Transform enumeration types to string.