python.JetDefinition.JetDefinition Class Reference

Inheritance diagram for python.JetDefinition.JetDefinition:

Collaboration diagram for python.JetDefinition.JetDefinition:

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

Public Attributes
	ptmin
	ghostdefs
	modifiers
	extrainputs
	standardRecoMode
	byVertex

Private Member Functions
def	_defineName (self)

Private Attributes
	_locked
	_algorithm
	_radius
	_inputdef
	_prefix
	_suffix
	_infix
	_context
	_VRMinRadius
	_VRMassScale
	_ghostarea
	_prereqDic
	_prereqOrder
	_internalAtt
	_cflags
	_contextDic
	_basename

Static Private Attributes
list	_allowedattributes = ['_cflags','_contextDic']
def	__repr__ = __str__

Detailed Description

Definition at line 68 of file JetDefinition.py.

Constructor & Destructor Documentation

__init__()

def python.JetDefinition.JetDefinition.__init__	(		self,
			algorithm,
			radius,
			inputdef,
			ptmin = 5e3*MeV,
			ghostdefs = [],
			modifiers = [],
			extrainputs = [],
			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.

    def __init__(self,
                 algorithm,           # The fastjet clustering algorithm
                 radius,              # The jet radius specifier (clustering cutoff)
                 inputdef,            # The input JetConstit
                 ptmin=5e3*MeV,       # The pt cutoff for fastjet in MeV
                 ghostdefs=[],        # The list of alias to JetGhosts to ghost-associate
                 modifiers=[],        # The list of alias to JetModifiers to execute after jet finding
                 extrainputs=[],      # The list of additional input types needed for jet finding
                 standardRecoMode = False, # 
                 prefix = "",         # allows to tune the full JetContainer name
                 suffix = "",         # allows to tune the full JetContainer name
                 infix = "",         # allows to tune the full JetContainer name
                 context = "default", # describe a context for which this definition will be used. See StandardJetContext
                 VRMinR = -1.0, # Minimum radius for VR jet finding
                 VRMassSc = -1.0, # Mass scale for VR jet finding, in MeV
                 ghostarea = 0.01, # area resolution when evaluating jet area using "ghosts"
                 byVertex = False, # Reconstruct the jets by vertex
                 lock = False,        # lock the properties of this instance to avoid accidental overwrite after __init__
    ):     
 
        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
 
        self.ghostdefs = ghostdefs     # Objects to ghost-associate
        self.modifiers = modifiers     # Tools to modify the jet
        self.extrainputs = extrainputs # Any extra input dependencies
 
        self.standardRecoMode = standardRecoMode
        
        # 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.byVertex = byVertex
        self._locked = lock
 
            

Member Function Documentation

__deepcopy__()

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

Definition at line 146 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__()

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

Definition at line 130 of file JetDefinition.py.

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

__hash__()

def python.JetDefinition.JetDefinition.__hash__

(

self

)

Definition at line 127 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__()

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

Definition at line 133 of file JetDefinition.py.

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

__str__()

def python.JetDefinition.JetDefinition.__str__

(

self

)

Definition at line 238 of file JetDefinition.py.

    def __str__(self):
        return f"JetDefinition({self.fullname()})"

_defineName()

def python.JetDefinition.JetDefinition._defineName (   self )

private

Definition at line 228 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]

def python.JetDefinition.JetDefinition.algorithm

(

self

)

Definition at line 164 of file JetDefinition.py.

    def algorithm(self): pass
 

algorithm() [2/2]

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

Definition at line 167 of file JetDefinition.py.

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

basename() [1/2]

def python.JetDefinition.JetDefinition.basename

(

self

)

Definition at line 197 of file JetDefinition.py.

    def basename(self): pass
 

basename() [2/2]

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

Definition at line 200 of file JetDefinition.py.

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

context()

def python.JetDefinition.JetDefinition.context

(

self

)

Definition at line 219 of file JetDefinition.py.

    def context(self): pass
 

extrainputs()

def python.JetDefinition.JetDefinition.extrainputs

(

self

)

Definition at line 209 of file JetDefinition.py.

    def extrainputs(self): pass

fullname()

def python.JetDefinition.JetDefinition.fullname

(

self

)

Definition at line 225 of file JetDefinition.py.

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

ghostarea()

def python.JetDefinition.JetDefinition.ghostarea

(

self

)

Definition at line 222 of file JetDefinition.py.

    def ghostarea(self): pass
    
 

ghostdefs()

def python.JetDefinition.JetDefinition.ghostdefs

(

self

)

Definition at line 205 of file JetDefinition.py.

    def ghostdefs(self): pass

infix()

def python.JetDefinition.JetDefinition.infix

(

self

)

Definition at line 194 of file JetDefinition.py.

    def infix(self): pass
    

inputdef() [1/2]

def python.JetDefinition.JetDefinition.inputdef

(

self

)

Definition at line 180 of file JetDefinition.py.

    def inputdef(self): pass
    

inputdef() [2/2]

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

Definition at line 183 of file JetDefinition.py.

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

lock()

def python.JetDefinition.JetDefinition.lock

(

self

)

Definition at line 136 of file JetDefinition.py.

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

modifiers()

def python.JetDefinition.JetDefinition.modifiers

(

self

)

Definition at line 207 of file JetDefinition.py.

    def modifiers(self): pass

prefix()

def python.JetDefinition.JetDefinition.prefix

(

self

)

Definition at line 188 of file JetDefinition.py.

    def prefix(self): pass
    

radius() [1/2]

def python.JetDefinition.JetDefinition.radius

(

self

)

Definition at line 172 of file JetDefinition.py.

    def radius(self): pass
 

radius() [2/2]

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

Definition at line 175 of file JetDefinition.py.

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

standardRecoMode()

def python.JetDefinition.JetDefinition.standardRecoMode

(

self

)

Definition at line 211 of file JetDefinition.py.

    def standardRecoMode(self): pass
 

suffix()

def python.JetDefinition.JetDefinition.suffix

(

self

)

Definition at line 191 of file JetDefinition.py.

    def suffix(self): pass
 

VRMassScale()

def python.JetDefinition.JetDefinition.VRMassScale

(

self

)

Definition at line 216 of file JetDefinition.py.

    def VRMassScale(self): pass
 

VRMinRadius()

def python.JetDefinition.JetDefinition.VRMinRadius

(

self

)

Definition at line 214 of file JetDefinition.py.

    def VRMinRadius(self): pass

Member Data Documentation

__repr__

def python.JetDefinition.JetDefinition.__repr__ = __str__

staticprivate

Definition at line 241 of file JetDefinition.py.

_algorithm

python.JetDefinition.JetDefinition._algorithm

private

Definition at line 78 of file JetDefinition.py.

_allowedattributes

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

staticprivate

Definition at line 69 of file JetDefinition.py.

_basename

python.JetDefinition.JetDefinition._basename

private

Definition at line 229 of file JetDefinition.py.

_cflags

python.JetDefinition.JetDefinition._cflags

private

Definition at line 103 of file JetDefinition.py.

_context

python.JetDefinition.JetDefinition._context

private

Definition at line 85 of file JetDefinition.py.

_contextDic

python.JetDefinition.JetDefinition._contextDic

private

Definition at line 104 of file JetDefinition.py.

_ghostarea

python.JetDefinition.JetDefinition._ghostarea

private

Definition at line 88 of file JetDefinition.py.

_infix

python.JetDefinition.JetDefinition._infix

private

Definition at line 84 of file JetDefinition.py.

_inputdef

python.JetDefinition.JetDefinition._inputdef

private

Definition at line 81 of file JetDefinition.py.

_internalAtt

python.JetDefinition.JetDefinition._internalAtt

private

Definition at line 102 of file JetDefinition.py.

_locked

python.JetDefinition.JetDefinition._locked

private

Definition at line 72 of file JetDefinition.py.

_prefix

python.JetDefinition.JetDefinition._prefix

private

Definition at line 82 of file JetDefinition.py.

_prereqDic

python.JetDefinition.JetDefinition._prereqDic

private

Definition at line 100 of file JetDefinition.py.

_prereqOrder

python.JetDefinition.JetDefinition._prereqOrder

private

Definition at line 101 of file JetDefinition.py.

_radius

python.JetDefinition.JetDefinition._radius

private

Definition at line 80 of file JetDefinition.py.

_suffix

python.JetDefinition.JetDefinition._suffix

private

Definition at line 83 of file JetDefinition.py.

_VRMassScale

python.JetDefinition.JetDefinition._VRMassScale

private

Definition at line 87 of file JetDefinition.py.

_VRMinRadius

python.JetDefinition.JetDefinition._VRMinRadius

private

Definition at line 86 of file JetDefinition.py.

byVertex

python.JetDefinition.JetDefinition.byVertex

Definition at line 105 of file JetDefinition.py.

extrainputs

python.JetDefinition.JetDefinition.extrainputs

Definition at line 95 of file JetDefinition.py.

ghostdefs

python.JetDefinition.JetDefinition.ghostdefs

Definition at line 93 of file JetDefinition.py.

modifiers

python.JetDefinition.JetDefinition.modifiers

Definition at line 94 of file JetDefinition.py.

ptmin

python.JetDefinition.JetDefinition.ptmin

Definition at line 91 of file JetDefinition.py.

standardRecoMode

python.JetDefinition.JetDefinition.standardRecoMode

Definition at line 97 of file JetDefinition.py.

---

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

• JetDefinition.py