ATLAS Offline Software
Loading...
Searching...
No Matches
python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig Class Reference
Inheritance diagram for python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig:
Collaboration diagram for python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig:

Public Member Functions

 __init__ (self)
 instanceName (self)
 makeAlgs (self, config)

Public Attributes

 forceFullSimConfig
 noEffSF
 saveDetailedSF
 containerName
str identificationWP = 'LooseBLayerLH':
 saveCombinedSF

Detailed Description

the ConfigBlock for the electron working point efficiency computation

Definition at line 680 of file ElectronAnalysisConfig.py.

Constructor & Destructor Documentation

◆ __init__()

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.__init__ ( self)

Definition at line 683 of file ElectronAnalysisConfig.py.

683 def __init__(self) :
684 super (ElectronWorkingPointEfficiencyConfig, self).__init__ ()
685 self.setBlockName('ElectronWorkingPointEfficiency')
686 self.addDependency('ElectronWorkingPointSelection', required=True)
687 self.addDependency('EventSelection', required=False)
688 self.addDependency('EventSelectionMerger', required=False)
689 self.addOption ('containerName', '', type=str,
690 noneAction='error',
691 info="the name of the input container.",
692 meta={'role':'containerRef'})
693 self.addOption ('selectionName', '', type=str,
694 noneAction='error',
695 info="the name of the electron selection to define (e.g. `tight` or "
696 "`loose`).",
697 meta={'role':'selection'})
698 self.addOption ('postfix', None, type=str,
699 info="a postfix to apply to decorations and algorithm names. "
700 "Typically not needed here as `selectionName` is used internally.")
701 self.addOption ('identificationWP', None, type=str,
702 info="the ID WP to use. Supported ID WPs: `TightLH`, "
703 "`MediumLH`, `LooseBLayerLH`, `TightDNN`, `MediumDNN`, `LooseDNN`, "
704 "`TightNoCFDNN`, `MediumNoCFDNN`, `VeryLooseNoCF97DNN`, `NoID`.",
705 expertMode=["NoID"],
706 meta={'choices':(['MediumLH', 'LooseBLayerLH', 'TightDNN', 'MediumDNN', 'LooseDNN',
707 'TightNoCFDNN', 'MediumNoCFDNN', 'VeryLooseNoCF97DNN', 'NoID'],1)})
708 self.addOption ('isolationWP', None, type=str,
709 info="the isolation WP to use. Supported isolation WPs: "
710 "`HighPtCaloOnly`, `Loose_VarRad`, `Tight_VarRad`, `TightTrackOnly_"
711 "VarRad`, `TightTrackOnly_FixedRad`, `NonIso`.",
712 meta={'choices':(['HighPtCaloOnly', 'Loose_VarRad', 'Tight_VarRad', 'TightTrackOnly_VarRad',
713 'TightTrackOnly_FixedRad', 'NonIso'],1)})
714 self.addOption ('noEffSF', False, type=bool,
715 info="disables the calculation of efficiencies and scale factors. "
716 "Experimental! only useful to test a new WP for which scale "
717 "factors are not available.",
718 expertMode=True)
719 self.addOption ('chargeIDSelectionRun2', False, type=bool,
720 info="whether to run the ECIDS tool. Only available for Run 2.")
721 self.addOption ('saveDetailedSF', True, type=bool,
722 info="save all the independent detailed object scale factors.")
723 self.addOption ('saveCombinedSF', False, type=bool,
724 info="save the combined object scale factor.")
725 self.addOption ('forceFullSimConfig', False, type=bool,
726 info="whether to force the tool to use the configuration meant for "
727 "full simulation samples. Only for testing purposes.")
728 self.addOption ('correlationModelId', 'SIMPLIFIED', type=str,
729 info="the correlation model to use for ID scale factors. "
730 "Supported models: `SIMPLIFIED`, `FULL`, `TOTAL`, `TOYS`.",
731 meta={'choices':(['SIMPLIFIED','FULL','TOTAL','TOYS'],1)})
732 self.addOption ('correlationModelIso', 'SIMPLIFIED', type=str,
733 info="the correlation model to use for isolation scale factors, "
734 "Supported models: `SIMPLIFIED`, `FULL`, `TOTAL`, `TOYS`.",
735 meta={'choices':(['SIMPLIFIED','FULL','TOTAL','TOYS'],1)})
736 self.addOption ('correlationModelReco', 'SIMPLIFIED', type=str,
737 info="the correlation model to use for reconstruction scale factors. "
738 "Supported models: `SIMPLIFIED`, `FULL`, `TOTAL`, `TOYS`.",
739 meta={'choices':(['SIMPLIFIED','FULL','TOTAL','TOYS'],1)})
740 self.addOption('addChargeMisIDSF', False, type=bool,
741 info="adds scale factors for charge-misID.")
742

Member Function Documentation

◆ instanceName()

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.instanceName ( self)
Return the instance name for this block

Definition at line 743 of file ElectronAnalysisConfig.py.

743 def instanceName (self) :
744 """Return the instance name for this block"""
745 if self.postfix is not None :
746 return self.containerName + '_' + self.selectionName + self.postfix
747 return self.containerName + '_' + self.selectionName
748

◆ makeAlgs()

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.makeAlgs ( self,
config )

Definition at line 749 of file ElectronAnalysisConfig.py.

749 def makeAlgs (self, config) :
750
751 if self.forceFullSimConfig:
752 warnings.warn_explicit(
753 "You are running ElectronWorkingPointSelectionConfig forcing"
754 " full sim config. This is only intended to be used for"
755 " testing purposes.",
756 TestingOnlyWarning, filename='', lineno=0)
757
758 selectionPostfix = self.selectionName
759 if selectionPostfix != '' and selectionPostfix[0] != '_' :
760 selectionPostfix = '_' + selectionPostfix
761
762 # The setup below is inappropriate for Run 1
763 if config.geometry() is LHCPeriod.Run1:
764 raise ValueError ("Can't set up the ElectronWorkingPointSelectionConfig with %s, there must be something wrong!" % config.geometry().value)
765
766 if self.identificationWP is None:
767 raise ValueError ("ElectronWorkingPointEfficiencyConfig: the identificationWP option must be set")
768
769 postfix = self.postfix
770 if postfix is None :
771 postfix = self.selectionName
772 if postfix != '' and postfix[0] != '_' :
773 postfix = '_' + postfix
774
775 correlationModels = ["SIMPLIFIED", "FULL", "TOTAL", "TOYS"]
776 map_file = 'ElectronEfficiencyCorrection/2015_2025/rel22.2/2026_Run2Run3_Recommendation_v3/map1.txt'
777 sfList = []
778 # Set up the RECO electron efficiency correction algorithm:
779 if config.dataType() is not DataType.Data and not self.noEffSF:
780 alg = config.createAlgorithm( 'CP::ElectronEfficiencyCorrectionAlg',
781 'ElectronEfficiencyCorrectionAlgReco' )
782 config.addPrivateTool( 'efficiencyCorrectionTool',
783 'CP::AsgElectronEfficiencyCorrectionTool' )
784 alg.scaleFactorDecoration = 'el_reco_effSF' + selectionPostfix + '_%SYS%'
785 alg.efficiencyCorrectionTool.MapFilePath = map_file
786 alg.efficiencyCorrectionTool.RecoKey = "Reconstruction"
787 if self.correlationModelReco not in correlationModels:
788 raise ValueError('Invalid correlation model for reconstruction efficiency, '
789 f'has to be one of: {", ".join(correlationModels)}')
790 if config.geometry() >= LHCPeriod.Run3 and self.correlationModelReco != "TOTAL":
791 warnings.warn_explicit(
792 "Only TOTAL correlation model is currently supported "
793 "for reconstruction efficiency correction in Run 3."
794 f"Your choice {self.correlationModelReco} will be "
795 "overwritten with TOTAL",
796 ElectronEfficiencyCorrelationWarning,
797 filename='', lineno=0)
798 alg.efficiencyCorrectionTool.CorrelationModel = "TOTAL"
799 else:
800 alg.efficiencyCorrectionTool.CorrelationModel = self.correlationModelReco
801 if config.dataType() is DataType.FastSim:
802 alg.efficiencyCorrectionTool.ForceDataType = (
803 PATCore.ParticleDataType.Full if self.forceFullSimConfig
804 else PATCore.ParticleDataType.Fast)
805 elif config.dataType() is DataType.FullSim:
806 alg.efficiencyCorrectionTool.ForceDataType = \
807 PATCore.ParticleDataType.Full
808 alg.outOfValidity = 2 #silent
809 alg.outOfValidityDeco = 'el_reco_bad_eff' + selectionPostfix
810 alg.electrons = config.readName (self.containerName)
811 alg.preselection = config.getPreselection (self.containerName, self.selectionName)
812 if self.saveDetailedSF:
813 config.addOutputVar (self.containerName, alg.scaleFactorDecoration,
814 'reco_effSF' + postfix, auxType='float')
815 sfList += [alg.scaleFactorDecoration]
816
817 # Set up the ID electron efficiency correction algorithm:
818 if config.dataType() is not DataType.Data and not self.noEffSF and self.identificationWP != 'NoID':
819
820 alg = config.createAlgorithm( 'CP::ElectronEfficiencyCorrectionAlg',
821 'ElectronEfficiencyCorrectionAlgID' )
822 config.addPrivateTool( 'efficiencyCorrectionTool',
823 'CP::AsgElectronEfficiencyCorrectionTool' )
824 alg.scaleFactorDecoration = 'el_id_effSF' + selectionPostfix + '_%SYS%'
825 alg.efficiencyCorrectionTool.MapFilePath = map_file
826 alg.efficiencyCorrectionTool.IdKey = self.identificationWP
827 if self.correlationModelId not in correlationModels:
828 raise ValueError('Invalid correlation model for identification efficiency, '
829 f'has to be one of: {", ".join(correlationModels)}')
830 alg.efficiencyCorrectionTool.CorrelationModel = self.correlationModelId
831 if config.dataType() is DataType.FastSim:
832 alg.efficiencyCorrectionTool.ForceDataType = (
833 PATCore.ParticleDataType.Full if self.forceFullSimConfig
834 else PATCore.ParticleDataType.Fast)
835 elif config.dataType() is DataType.FullSim:
836 alg.efficiencyCorrectionTool.ForceDataType = \
837 PATCore.ParticleDataType.Full
838 alg.outOfValidity = 2 #silent
839 alg.outOfValidityDeco = 'el_id_bad_eff' + selectionPostfix
840 alg.electrons = config.readName (self.containerName)
841 alg.preselection = config.getPreselection (self.containerName, self.selectionName)
842 if self.saveDetailedSF:
843 config.addOutputVar (self.containerName, alg.scaleFactorDecoration,
844 'id_effSF' + postfix, auxType='float')
845 sfList += [alg.scaleFactorDecoration]
846
847 # Set up the ISO electron efficiency correction algorithm:
848 if config.dataType() is not DataType.Data and self.isolationWP != 'NonIso' and not self.noEffSF:
849 alg = config.createAlgorithm( 'CP::ElectronEfficiencyCorrectionAlg',
850 'ElectronEfficiencyCorrectionAlgIsol' )
851 config.addPrivateTool( 'efficiencyCorrectionTool',
852 'CP::AsgElectronEfficiencyCorrectionTool' )
853 alg.scaleFactorDecoration = 'el_isol_effSF' + selectionPostfix + '_%SYS%'
854 alg.efficiencyCorrectionTool.MapFilePath = map_file
855 alg.efficiencyCorrectionTool.IdKey = self.identificationWP
856 alg.efficiencyCorrectionTool.IsoKey = self.isolationWP
857 if self.correlationModelIso not in correlationModels:
858 raise ValueError('Invalid correlation model for isolation efficiency, '
859 f'has to be one of: {", ".join(correlationModels)}')
860 if config.geometry() >= LHCPeriod.Run3 and self.correlationModelIso != 'TOTAL':
861 warnings.warn_explicit(
862 "Only TOTAL correlation model is currently supported "
863 "for isolation efficiency correction in Run 3."
864 f"Your choice {self.correlationModelIso} will be "
865 "overwritten with TOTAL",
866 ElectronEfficiencyCorrelationWarning,
867 filename='', lineno=0)
868 alg.efficiencyCorrectionTool.CorrelationModel = "TOTAL"
869 else:
870 alg.efficiencyCorrectionTool.CorrelationModel = self.correlationModelIso
871 if config.dataType() is DataType.FastSim:
872 alg.efficiencyCorrectionTool.ForceDataType = (
873 PATCore.ParticleDataType.Full if self.forceFullSimConfig
874 else PATCore.ParticleDataType.Fast)
875 elif config.dataType() is DataType.FullSim:
876 alg.efficiencyCorrectionTool.ForceDataType = \
877 PATCore.ParticleDataType.Full
878 alg.outOfValidity = 2 #silent
879 alg.outOfValidityDeco = 'el_isol_bad_eff' + selectionPostfix
880 alg.electrons = config.readName (self.containerName)
881 alg.preselection = config.getPreselection (self.containerName, self.selectionName)
882 if self.saveDetailedSF:
883 config.addOutputVar (self.containerName, alg.scaleFactorDecoration,
884 'isol_effSF' + postfix, auxType='float')
885 sfList += [alg.scaleFactorDecoration]
886
887 if (self.chargeIDSelectionRun2 and config.geometry() < LHCPeriod.Run3 and
888 config.dataType() is not DataType.Data and not self.noEffSF):
889 alg = config.createAlgorithm( 'CP::ElectronEfficiencyCorrectionAlg',
890 'ElectronEfficiencyCorrectionAlgEcids' )
891 config.addPrivateTool( 'efficiencyCorrectionTool',
892 'CP::AsgElectronEfficiencyCorrectionTool' )
893 alg.scaleFactorDecoration = 'el_ecids_effSF' + selectionPostfix + '_%SYS%'
894 if self.isolationWP != 'Tight_VarRad':
895 raise ValueError('ECIDS SFs are supported only for Tight_VarRad isolation.')
896 if self.identificationWP == 'LooseBLayerLH':
897 ecids_lh = 'loose'
898 elif self.identificationWP == 'MediumLH':
899 ecids_lh = 'medium'
900 elif self.identificationWP == 'TightLH':
901 ecids_lh = 'tight'
902 else:
903 raise ValueError('ECIDS SFs are supported only for ID LooseBLayerLH, MediumLH, or TightLH')
904
905 alg.efficiencyCorrectionTool.CorrelationModel = "TOTAL"
906 alg.efficiencyCorrectionTool.CorrectionFileNameList = \
907 [f'ElectronEfficiencyCorrection/2015_2025/rel22.2/2025_Run2Rel22_Recommendation_v2/ecids/efficiencySF.ChargeID.{ecids_lh}_ECIDS_Tight_VarRad.root']
908 if config.dataType() is DataType.FastSim:
909 alg.efficiencyCorrectionTool.ForceDataType = (
910 PATCore.ParticleDataType.Full if self.forceFullSimConfig
911 else PATCore.ParticleDataType.Fast)
912 elif config.dataType() is DataType.FullSim:
913 alg.efficiencyCorrectionTool.ForceDataType = \
914 PATCore.ParticleDataType.Full
915 alg.outOfValidity = 2 #silent
916 alg.outOfValidityDeco = 'el_ecids_bad_eff' + selectionPostfix
917 alg.electrons = config.readName (self.containerName)
918 alg.preselection = config.getPreselection (self.containerName, self.selectionName)
919 if self.saveDetailedSF:
920 config.addOutputVar (self.containerName, alg.scaleFactorDecoration,
921 'ecids_effSF' + postfix, auxType='float')
922 sfList += [alg.scaleFactorDecoration]
923
924 if self.addChargeMisIDSF and config.dataType() is not DataType.Data and not self.noEffSF and config.geometry() >= LHCPeriod.Run3:
925 warnings.warn_explicit(
926 "Charge mis-ID SFs are only available for Run 2 and will not"
927 " have any effect in Run 3.",
928 Run2OnlyFeatureWarning, filename='', lineno=0)
929
930 elif self.addChargeMisIDSF and config.dataType() is not DataType.Data and not self.noEffSF and config.geometry() < LHCPeriod.Run3:
931 alg = config.createAlgorithm( 'CP::ElectronEfficiencyCorrectionAlg',
932 'ElectronEfficiencyCorrectionAlgMisid' )
933 config.addPrivateTool( 'efficiencyCorrectionTool',
934 'CP::ElectronChargeEfficiencyCorrectionTool' )
935 alg.scaleFactorDecoration = 'el_charge_misid_effSF' + selectionPostfix + '_%SYS%'
936 if self.isolationWP != 'Tight_VarRad':
937 raise ValueError('Charge mis-ID SFs are supported only for Tight_VarRad isolation.')
938 if self.identificationWP == 'LooseBLayerLH':
939 misid_lh = 'LooseAndBLayerLLH'
940 elif self.identificationWP == 'MediumLH':
941 misid_lh = 'MediumLLH'
942 elif self.identificationWP == 'TightLH':
943 misid_lh = 'TightLLH'
944 else:
945 raise ValueError('Charge mis-ID SFs are supported only for ID LooseBLayerLH, MediumLH, or TightLH')
946 misid_suffix = '_ECIDSloose' if self.chargeIDSelectionRun2 else ''
947
948 alg.efficiencyCorrectionTool.CorrectionFileName = \
949 f'ElectronEfficiencyCorrection/2015_2025/rel22.2/2025_Run2Rel22_Recommendation_v2/charge_misID/chargeEfficiencySF.{misid_lh}_d0z0_TightVarRad{misid_suffix}.root'
950 if config.dataType() is DataType.FastSim:
951 alg.efficiencyCorrectionTool.ForceDataType = (
952 PATCore.ParticleDataType.Full if self.forceFullSimConfig
953 else PATCore.ParticleDataType.Fast)
954 elif config.dataType() is DataType.FullSim:
955 alg.efficiencyCorrectionTool.ForceDataType = \
956 PATCore.ParticleDataType.Full
957 alg.outOfValidity = 2 #silent
958 alg.outOfValidityDeco = 'el_misid_bad_eff' + selectionPostfix
959 alg.electrons = config.readName (self.containerName)
960 alg.preselection = config.getPreselection (self.containerName, self.selectionName)
961 if self.saveDetailedSF:
962 config.addOutputVar (self.containerName, alg.scaleFactorDecoration,
963 'charge_misid_effSF' + postfix, auxType='float')
964 sfList += [alg.scaleFactorDecoration]
965
966 if config.dataType() is not DataType.Data and not self.noEffSF and self.saveCombinedSF:
967 alg = config.createAlgorithm( 'CP::AsgObjectScaleFactorAlg',
968 'ElectronCombinedEfficiencyScaleFactorAlg' )
969 alg.particles = config.readName (self.containerName)
970 alg.inScaleFactors = sfList
971 alg.outScaleFactor = 'effSF' + postfix + '_%SYS%'
972 config.addOutputVar (self.containerName, alg.outScaleFactor, 'effSF' + postfix, auxType='float')
973

Member Data Documentation

◆ containerName

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.containerName

Definition at line 813 of file ElectronAnalysisConfig.py.

◆ forceFullSimConfig

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.forceFullSimConfig

Definition at line 751 of file ElectronAnalysisConfig.py.

◆ identificationWP

str python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.identificationWP = 'LooseBLayerLH':

Definition at line 896 of file ElectronAnalysisConfig.py.

◆ noEffSF

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.noEffSF

Definition at line 779 of file ElectronAnalysisConfig.py.

◆ saveCombinedSF

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.saveCombinedSF

Definition at line 966 of file ElectronAnalysisConfig.py.

◆ saveDetailedSF

python.ElectronAnalysisConfig.ElectronWorkingPointEfficiencyConfig.saveDetailedSF

Definition at line 812 of file ElectronAnalysisConfig.py.


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