python.JetGrooming.GroomingDefinition Class Reference

Inheritance diagram for python.JetGrooming.GroomingDefinition:

Collaboration diagram for python.JetGrooming.GroomingDefinition:

Public Member Functions
def	__init__ (self, ungroomeddef, modifiers=[], suffix='', lock=False, context=None, **properties)
def	__hash__ (self)
def	__eq__ (self, rhs)
def	__ne__ (self, rhs)
def	lock (self)
def	__deepcopy__ (self, memo)
def	ungroomeddef (self)
def	ungroomeddef (self, ungroomeddef)
def	properties (self)
def	modifiers (self)
def	suffix (self)
def	context (self)
def	groomSpecAsStr (self)
def	fullname (self)
def	__str__ (self)

Public Attributes
	inputdef
	properties
	suffix
	modifiers
	basename

Static Public Attributes
	tooltype = None
	groomalg = None

Private Member Functions
def	_defineName (self)

Private Attributes
	_ungroomeddef
	_context
	_prereqDic
	_prereqOrder
	_locked
	_cflags
	_contextDic

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

Detailed Description

Base class to define grooming procedure. 
Concrete classes will have to define the tooltype & groomalg class members
and aslo a groomSpecAsStr() function.

Definition at line 17 of file JetGrooming.py.

Constructor & Destructor Documentation

__init__()

def python.JetGrooming.GroomingDefinition.__init__	(		self,
			ungroomeddef,
			modifiers = [],
			suffix = '',
			lock = False,
			context = None,
		**	properties
	)

Definition at line 26 of file JetGrooming.py.

    def __init__(self, 
                 ungroomeddef,  # Ungroomed JetDefinition
                 modifiers=[],  # JetModifiers to run after grooming
                 suffix = '',   # allows to tune the full JetContainer name
                 lock=False,    # lock the properties of this instance to avoid accidental overwrite after __init__
                 context = None, # describe a context for which this definition will be used. See StandardJetContext
                 **properties   # any other argument is expected a grooming tool property
                 ): 
 
        self._ungroomeddef = ungroomeddef.clone() # clone to avoid messing with external jetdef
        self.inputdef = self._ungroomeddef.inputdef
        if lock: properties = ldict(properties) # ldict to freeze the properties
        self.properties = properties
 
        context = context if context is not None else ungroomeddef.context
        self._context = context
        self.suffix = suffix
        self._defineName()
 
        self.modifiers = modifiers 
        
        
        # used internally to resolve dependencies
        self._prereqDic = {}
        self._prereqOrder = [] 
        self._locked = lock
        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 
 
 

Member Function Documentation

__deepcopy__()

def python.JetGrooming.GroomingDefinition.__deepcopy__	(		self,
			memo
	)

Definition at line 75 of file JetGrooming.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.JetGrooming.GroomingDefinition.__eq__	(		self,
			rhs
	)

Definition at line 59 of file JetGrooming.py.

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

__hash__()

def python.JetGrooming.GroomingDefinition.__hash__

(

self

)

Definition at line 56 of file JetGrooming.py.

    def __hash__(self):
        return hash("")
 

__ne__()

def python.JetGrooming.GroomingDefinition.__ne__	(		self,
			rhs
	)

Definition at line 62 of file JetGrooming.py.

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

__str__()

def python.JetGrooming.GroomingDefinition.__str__

(

self

)

Definition at line 126 of file JetGrooming.py.

    def __str__(self):
        return "JetGrooming({0})".format(self.basename)

_defineName()

def python.JetGrooming.GroomingDefinition._defineName (   self )

private

Definition at line 120 of file JetGrooming.py.

    def _defineName(self):
        # chop the label off so we can insert the trimming spec
        groomedName = self.ungroomeddef.basename + self.groomSpecAsStr()
        self.basename = groomedName
 

context()

def python.JetGrooming.GroomingDefinition.context

(

self

)

Definition at line 108 of file JetGrooming.py.

    def context(self): pass
    

fullname()

def python.JetGrooming.GroomingDefinition.fullname

(

self

)

Definition at line 114 of file JetGrooming.py.

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

groomSpecAsStr()

def python.JetGrooming.GroomingDefinition.groomSpecAsStr

(

self

)

Reimplemented in python.JetGrooming.JetSoftDrop, and python.JetGrooming.JetTrimming.

Definition at line 111 of file JetGrooming.py.

    def groomSpecAsStr(self):
        raise Exception("Can not use a GroomingDefinition instance : use a derived class")
 

lock()

def python.JetGrooming.GroomingDefinition.lock

(

self

)

Definition at line 65 of file JetGrooming.py.

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

modifiers()

def python.JetGrooming.GroomingDefinition.modifiers

(

self

)

Definition at line 103 of file JetGrooming.py.

    def modifiers(self): pass

properties()

def python.JetGrooming.GroomingDefinition.properties

(

self

)

Definition at line 101 of file JetGrooming.py.

    def properties(self): pass

suffix()

def python.JetGrooming.GroomingDefinition.suffix

(

self

)

Definition at line 105 of file JetGrooming.py.

    def suffix(self): pass
 

ungroomeddef() [1/2]

def python.JetGrooming.GroomingDefinition.ungroomeddef

(

self

)

Definition at line 93 of file JetGrooming.py.

    def ungroomeddef(self): pass

ungroomeddef() [2/2]

def python.JetGrooming.GroomingDefinition.ungroomeddef	(		self,
			ungroomeddef
	)

Definition at line 95 of file JetGrooming.py.

    def ungroomeddef(self,ungroomeddef):
        self._ungroomeddef = ungroomeddef.clone()
        self._defineName()
 
 

Member Data Documentation

__repr__

def python.JetGrooming.GroomingDefinition.__repr__ = __str__

staticprivate

Definition at line 129 of file JetGrooming.py.

_allowedattributes

list python.JetGrooming.GroomingDefinition._allowedattributes = ['_cflags','_contextDic']

staticprivate

Definition at line 23 of file JetGrooming.py.

_cflags

python.JetGrooming.GroomingDefinition._cflags

private

Definition at line 45 of file JetGrooming.py.

_context

python.JetGrooming.GroomingDefinition._context

private

Definition at line 34 of file JetGrooming.py.

_contextDic

python.JetGrooming.GroomingDefinition._contextDic

private

Definition at line 46 of file JetGrooming.py.

_locked

python.JetGrooming.GroomingDefinition._locked

private

Definition at line 44 of file JetGrooming.py.

_prereqDic

python.JetGrooming.GroomingDefinition._prereqDic

private

Definition at line 42 of file JetGrooming.py.

_prereqOrder

python.JetGrooming.GroomingDefinition._prereqOrder

private

Definition at line 43 of file JetGrooming.py.

_ungroomeddef

python.JetGrooming.GroomingDefinition._ungroomeddef

private

Definition at line 28 of file JetGrooming.py.

basename

python.JetGrooming.GroomingDefinition.basename

Definition at line 123 of file JetGrooming.py.

groomalg

python.JetGrooming.GroomingDefinition.groomalg = None

static

Definition at line 25 of file JetGrooming.py.

inputdef

python.JetGrooming.GroomingDefinition.inputdef

Definition at line 29 of file JetGrooming.py.

modifiers

python.JetGrooming.GroomingDefinition.modifiers

Definition at line 38 of file JetGrooming.py.

properties

python.JetGrooming.GroomingDefinition.properties

Definition at line 31 of file JetGrooming.py.

suffix

python.JetGrooming.GroomingDefinition.suffix

Definition at line 35 of file JetGrooming.py.

tooltype

python.JetGrooming.GroomingDefinition.tooltype = None

static

Definition at line 24 of file JetGrooming.py.

---

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

• JetGrooming.py