Inheritance diagram for python.JetDefinition.JetDefinition:

Collaboration diagram for python.JetDefinition.JetDefinition:

Public Member Functions
	__init__ (self, algorithm, radius, inputdef, ptmin=5e3 *MeV, ghostdefs=None, modifiers=None, extrainputs=None, standardRecoMode=False, prefix="", suffix="", infix="", context="default", VRMinR=-1.0, VRMassSc=-1.0, ghostarea=0.01, byVertex=False, lock=False)
	__hash__ (self)
	__eq__ (self, rhs)
	__ne__ (self, rhs)
	lock (self)
	__deepcopy__ (self, memo)
	algorithm (self)
	algorithm (self, algorithm)
	radius (self)
	radius (self, radius)
	inputdef (self)
	inputdef (self, inputdef)
	prefix (self)
	suffix (self)
	infix (self)
	basename (self)
	basename (self, v)
	ptmin (self)
	ghostdefs (self)
	modifiers (self)
	extrainputs (self)
	standardRecoMode (self)
	byVertex (self)
	VRMinRadius (self)
	VRMassScale (self)
	context (self)
	ghostarea (self)
	fullname (self)
	__str__ (self)

Public Attributes
	algorithm
	ptmin = ptmin
	ghostdefs = ghostdefs if ghostdefs is not None else []
	modifiers = modifiers if modifiers is not None else []
	extrainputs = extrainputs if extrainputs is not None else []
	standardRecoMode = standardRecoMode
	byVertex = byVertex
	basename

Protected Member Functions
	_defineName (self)

Protected Attributes
bool	_locked = False
	_algorithm = algorithm
	_radius = radius
	_inputdef = inputdef
	_prefix = prefix
	_suffix = suffix
	_infix = infix
	_context = context
	_VRMinRadius = VRMinR
	_VRMassScale = VRMassSc
	_ghostarea = ghostarea
dict	_prereqDic = {}
list	_prereqOrder = []
dict	_internalAtt = {}
	_cflags = None
	_contextDic = None
	_basename = buildJetAlgName(self.algorithm,self.radius,self.VRMassScale,self.VRMinRadius)+self.inputdef.label

Static Protected Attributes
list	_allowedattributes = ['_cflags','_contextDic']

Static Private Attributes
	__repr__ = __str__

Detailed Description

Definition at line 68 of file JetDefinition.py.

Constructor & Destructor Documentation

◆ init()

python.JetDefinition.JetDefinition.__init__	(	self,
		algorithm,
		radius,
		inputdef,
		ptmin = 5e3*MeV,
		ghostdefs = None,
		modifiers = None,
		extrainputs = None,
		standardRecoMode = False,
		prefix = "",
		suffix = "",
		infix = "",
		context = "default",
		VRMinR = -1.0,
		VRMassSc = -1.0,
		ghostarea = 0.01,
		byVertex = False,
		lock = False )

Definition at line 70 of file JetDefinition.py.

    ):     
 
        self._locked = False # unlock during init
        # Should add some type checking here
        # Could use JetContainerInfo conversion
        if algorithm not in ["Kt","AntiKt","CamKt"]:
            jetlog.error("FastJet algorithm specification was not one of Kt, AntiKt, CamKt!")
            raise KeyError("Invalid fastjet algorithm choice: {0}".format(self.algorithm))
        self._algorithm = algorithm
 
        self._radius = radius
        self._inputdef = inputdef
        self._prefix = prefix
        self._suffix = suffix
        self._infix = infix
        self._context = context
        self._VRMinRadius = VRMinR
        self._VRMassScale = VRMassSc
        self._ghostarea = ghostarea
        self._defineName()
        
        self.ptmin = ptmin # The pt down to which FastJet is run
 
        # Avoid modifying default args
        self.ghostdefs = ghostdefs if ghostdefs is not None else []       # Objects to ghost-associate
        self.modifiers = modifiers if modifiers is not None else []       # Tools to modify the jet
        self.extrainputs = extrainputs if extrainputs is not None else [] # Any extra input dependencies
 
        self.standardRecoMode = standardRecoMode
 
        self.byVertex = byVertex
 
        # used internally to resolve dependencies
        self._prereqDic = {}
        self._prereqOrder = [] 
        self._internalAtt = {}
        self._cflags = None # pointer to AthenaConfiguration.ConfigFlags. Mainly to allow to invoke building of input dependencies which are outside Jet domain during std reco
        self._contextDic = None # pointer to the context dictionnary. Convenient shortcut used to configure input or modifier dependencies 
        self._locked = lock
 
            

Member Function Documentation

◆ deepcopy()

python.JetDefinition.JetDefinition.__deepcopy__	(		self,
			memo )

Definition at line 151 of file JetDefinition.py.

    def __deepcopy__(self, memo):
        cls = self.__class__
        result = cls.__new__(cls)
        memo[id(self)] = result
        set_without_deepcopy = ['_cflags']
        for k, v in self.__dict__.items():
            if k in set_without_deepcopy:
                if v:
                    assert(v.locked())
                setattr(result, k, v)
            else:
                setattr(result, k, deepcopy(v, memo))
        return result
 

◆ eq()

python.JetDefinition.JetDefinition.__eq__	(		self,
			rhs )

Definition at line 135 of file JetDefinition.py.

    def __eq__(self,rhs):
        return self.__hash__() == rhs.__hash__()
 

◆ hash()

python.JetDefinition.JetDefinition.__hash__ ( self )

Definition at line 132 of file JetDefinition.py.

    def __hash__(self):
        return hash((self.basename,self._inputdef,self.ptmin,str(self.ghostdefs),str(self.modifiers),str(self.extrainputs),self.byVertex))
 

◆ ne()

python.JetDefinition.JetDefinition.__ne__	(		self,
			rhs )

Definition at line 138 of file JetDefinition.py.

    def __ne__(self,rhs):
        return (not self.__eq__(rhs))
 

◆ str()

python.JetDefinition.JetDefinition.__str__ ( self )

Definition at line 247 of file JetDefinition.py.

247 def __str__(self):

248 return f"JetDefinition({self.fullname()})"

◆ _defineName()

python.JetDefinition.JetDefinition._defineName ( self )

protected

Definition at line 237 of file JetDefinition.py.

    def _defineName(self):
        self._basename = buildJetAlgName(self.algorithm,self.radius,self.VRMassScale,self.VRMinRadius)+self.inputdef.label # .label
        if self.inputdef.basetype == xAODType.CaloCluster:
            # Omit cluster origin correction from jet name
            # Keep the origin correction explicit because sometimes we may not
            # wish to apply it, whereas PFlow corrections are applied implicitly
            self._basename = self.basename.replace("Origin","")
        pass
 

◆ algorithm() [1/2]

python.JetDefinition.JetDefinition.algorithm ( self )

Definition at line 169 of file JetDefinition.py.

169 def algorithm(self): pass

170

algorithm

std::string algorithm

Definition hcg.cxx:87

◆ algorithm() [2/2]

python.JetDefinition.JetDefinition.algorithm	(		self,
			algorithm )

Definition at line 172 of file JetDefinition.py.

    def algorithm(self,algorithm):
        self._algorithm = algorithm
        self._defineName()
 

◆ basename() [1/2]

python.JetDefinition.JetDefinition.basename ( self )

Definition at line 202 of file JetDefinition.py.

202 def basename(self): pass

203

basename

std::string basename(std::string name)

Definition utils.cxx:207

◆ basename() [2/2]

python.JetDefinition.JetDefinition.basename	(		self,
			v )

Definition at line 205 of file JetDefinition.py.

    def basename(self,v):
        raise Exception("Can NOT set property basename of JetDefinition ",self," Change prefix, infix or suffix instead.")
        

◆ byVertex()

python.JetDefinition.JetDefinition.byVertex ( self )

Definition at line 220 of file JetDefinition.py.

220 def byVertex(self): pass

221

◆ context()

python.JetDefinition.JetDefinition.context ( self )

Definition at line 228 of file JetDefinition.py.

228 def context(self): pass

229

◆ extrainputs()

python.JetDefinition.JetDefinition.extrainputs ( self )

Definition at line 216 of file JetDefinition.py.

216 def extrainputs(self): pass

◆ fullname()

python.JetDefinition.JetDefinition.fullname ( self )

Definition at line 234 of file JetDefinition.py.

    def fullname(self):
        return self.prefix+self.basename+self.infix+"Jets"+self.suffix
        

◆ ghostarea()

python.JetDefinition.JetDefinition.ghostarea ( self )

Definition at line 231 of file JetDefinition.py.

    def ghostarea(self): pass
    
 

◆ ghostdefs()

python.JetDefinition.JetDefinition.ghostdefs ( self )

Definition at line 212 of file JetDefinition.py.

212 def ghostdefs(self): pass

◆ infix()

python.JetDefinition.JetDefinition.infix ( self )

Definition at line 199 of file JetDefinition.py.

199 def infix(self): pass

200

◆ inputdef() [1/2]

python.JetDefinition.JetDefinition.inputdef ( self )

Definition at line 185 of file JetDefinition.py.

185 def inputdef(self): pass

186

◆ inputdef() [2/2]

python.JetDefinition.JetDefinition.inputdef	(		self,
			inputdef )

Definition at line 188 of file JetDefinition.py.

    def inputdef(self,inputdef):
        self._inputdef = inputdef
        self._defineName()
 

◆ lock()

python.JetDefinition.JetDefinition.lock ( self )

Definition at line 141 of file JetDefinition.py.

    def lock(self):
        if not self._locked:
            self._locked = True
 

◆ modifiers()

python.JetDefinition.JetDefinition.modifiers ( self )

Definition at line 214 of file JetDefinition.py.

214 def modifiers(self): pass

◆ prefix()

python.JetDefinition.JetDefinition.prefix ( self )

Definition at line 193 of file JetDefinition.py.

193 def prefix(self): pass

194

◆ ptmin()

python.JetDefinition.JetDefinition.ptmin ( self )

Definition at line 209 of file JetDefinition.py.

209 def ptmin(self): pass

210

◆ radius() [1/2]

python.JetDefinition.JetDefinition.radius ( self )

Definition at line 177 of file JetDefinition.py.

177 def radius(self): pass

178

◆ radius() [2/2]

python.JetDefinition.JetDefinition.radius	(		self,
			radius )

Definition at line 180 of file JetDefinition.py.

    def radius(self,radius):
        self._radius = radius
        self._defineName()
 

◆ standardRecoMode()

python.JetDefinition.JetDefinition.standardRecoMode ( self )

Definition at line 218 of file JetDefinition.py.

218 def standardRecoMode(self): pass

◆ suffix()

python.JetDefinition.JetDefinition.suffix ( self )

Definition at line 196 of file JetDefinition.py.

196 def suffix(self): pass

197

◆ VRMassScale()

python.JetDefinition.JetDefinition.VRMassScale ( self )

Definition at line 225 of file JetDefinition.py.

225 def VRMassScale(self): pass

226

◆ VRMinRadius()

python.JetDefinition.JetDefinition.VRMinRadius ( self )

Definition at line 223 of file JetDefinition.py.

223 def VRMinRadius(self): pass

Member Data Documentation

◆ repr

python.JetDefinition.JetDefinition.__repr__ = __str__

staticprivate

Definition at line 250 of file JetDefinition.py.

◆ _algorithm

python.JetDefinition.JetDefinition._algorithm = algorithm

protected

Definition at line 99 of file JetDefinition.py.

◆ _allowedattributes

list python.JetDefinition.JetDefinition._allowedattributes = ['_cflags','_contextDic']

staticprotected

Definition at line 69 of file JetDefinition.py.

◆ _basename

python.JetDefinition.JetDefinition._basename = buildJetAlgName(self.algorithm,self.radius,self.VRMassScale,self.VRMinRadius)+self.inputdef.label

protected

Definition at line 238 of file JetDefinition.py.

◆ _cflags

python.JetDefinition.JetDefinition._cflags = None

protected

Definition at line 127 of file JetDefinition.py.

◆ _context

python.JetDefinition.JetDefinition._context = context

protected

Definition at line 106 of file JetDefinition.py.

◆ _contextDic

python.JetDefinition.JetDefinition._contextDic = None

protected

Definition at line 128 of file JetDefinition.py.

◆ _ghostarea

python.JetDefinition.JetDefinition._ghostarea = ghostarea

protected

Definition at line 109 of file JetDefinition.py.

◆ _infix

python.JetDefinition.JetDefinition._infix = infix

protected

Definition at line 105 of file JetDefinition.py.

◆ _inputdef

python.JetDefinition.JetDefinition._inputdef = inputdef

protected

Definition at line 102 of file JetDefinition.py.

◆ _internalAtt

dict python.JetDefinition.JetDefinition._internalAtt = {}

protected

Definition at line 126 of file JetDefinition.py.

◆ _locked

bool python.JetDefinition.JetDefinition._locked = False

protected

Definition at line 93 of file JetDefinition.py.

◆ _prefix

python.JetDefinition.JetDefinition._prefix = prefix

protected

Definition at line 103 of file JetDefinition.py.

◆ _prereqDic

dict python.JetDefinition.JetDefinition._prereqDic = {}

protected

Definition at line 124 of file JetDefinition.py.

◆ _prereqOrder

list python.JetDefinition.JetDefinition._prereqOrder = []

protected

Definition at line 125 of file JetDefinition.py.

◆ _radius

python.JetDefinition.JetDefinition._radius = radius

protected

Definition at line 101 of file JetDefinition.py.

◆ _suffix

python.JetDefinition.JetDefinition._suffix = suffix

protected

Definition at line 104 of file JetDefinition.py.

◆ _VRMassScale

python.JetDefinition.JetDefinition._VRMassScale = VRMassSc

protected

Definition at line 108 of file JetDefinition.py.

◆ _VRMinRadius

python.JetDefinition.JetDefinition._VRMinRadius = VRMinR

protected

Definition at line 107 of file JetDefinition.py.

◆ algorithm

python.JetDefinition.JetDefinition.algorithm

Definition at line 98 of file JetDefinition.py.

◆ basename

python.JetDefinition.JetDefinition.basename

Definition at line 133 of file JetDefinition.py.

◆ byVertex

python.JetDefinition.JetDefinition.byVertex = byVertex

Definition at line 121 of file JetDefinition.py.

◆ extrainputs

python.JetDefinition.JetDefinition.extrainputs = extrainputs if extrainputs is not None else []

Definition at line 117 of file JetDefinition.py.

◆ ghostdefs

python.JetDefinition.JetDefinition.ghostdefs = ghostdefs if ghostdefs is not None else []

Definition at line 115 of file JetDefinition.py.

◆ modifiers

python.JetDefinition.JetDefinition.modifiers = modifiers if modifiers is not None else []

Definition at line 116 of file JetDefinition.py.

◆ ptmin

python.JetDefinition.JetDefinition.ptmin = ptmin

Definition at line 112 of file JetDefinition.py.

◆ standardRecoMode

python.JetDefinition.JetDefinition.standardRecoMode = standardRecoMode

Definition at line 119 of file JetDefinition.py.

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

JetDefinition.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __deepcopy__()

◆ __eq__()

◆ __hash__()

◆ __ne__()

◆ __str__()

◆ _defineName()

◆ algorithm() [1/2]

◆ algorithm() [2/2]

◆ basename() [1/2]

◆ basename() [2/2]

◆ byVertex()

◆ context()

◆ extrainputs()

◆ fullname()

◆ ghostarea()

◆ ghostdefs()

◆ infix()

◆ inputdef() [1/2]

◆ inputdef() [2/2]

◆ lock()

◆ modifiers()

◆ prefix()

◆ ptmin()

◆ radius() [1/2]

◆ radius() [2/2]

◆ standardRecoMode()

◆ suffix()

◆ VRMassScale()

◆ VRMinRadius()

Member Data Documentation

◆ __repr__

◆ _algorithm

◆ _allowedattributes

◆ _basename

◆ _cflags

◆ _context

◆ _contextDic

◆ _ghostarea

◆ _infix

◆ _inputdef

◆ _internalAtt

◆ _locked

◆ _prefix

◆ _prereqDic

◆ _prereqOrder

◆ _radius

◆ _suffix

◆ _VRMassScale

◆ _VRMinRadius

◆ algorithm

◆ basename

◆ byVertex

◆ extrainputs

◆ ghostdefs

◆ modifiers

◆ ptmin

◆ standardRecoMode

◆ init()

◆ deepcopy()

◆ eq()

◆ hash()

◆ ne()

◆ str()

◆ repr