ATLAS Offline Software
Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes | List of all members
python.JetDefinition.JetInputExternal Class Reference
Inheritance diagram for python.JetDefinition.JetInputExternal:
Collaboration diagram for python.JetDefinition.JetInputExternal:

Public Member Functions

def __init__ (self, name, objtype, algoBuilder=None, specs=None, containername=None, filterfn=_condAlwaysPass, prereqs=[])
 
def name (self)
 
def algoBuilder (self)
 
def basetype (self)
 
def specs (self)
 
def filterfn (self)
 
def prereqs (self)
 
def __str__ (self)
 
def __hash__ (self)
 
def __eq__ (self, other)
 
def __ne__ (self, rhs)
 

Public Attributes

 name
 
 basetype
 
 algoBuilder
 
 containername
 
 specs
 
 filterfn
 
 prereqs
 

Static Public Attributes

 outputname = make_alias("name")
 

Static Private Attributes

def __repr__ = __str__
 

Detailed Description

This class allows to declare primary data sources to jet finding which are typically outside of jet domain.
Such sources can be container of particles (ex: clusters, selection of tracks,...) but also
other object needed by some JetModifier (ex: EventDensity or track-vertex association map).

The class is mainly here to hold a helper function (algoBuilder) in charge of configuring the proper algorithm to build the source. 
If this function is None, then we expect the container pre-exists in the evt store. 

Arguments to the constructor :
  - name : container name in event store 
  - objtype  : the xAODType (ex: xAODType.TruthParticle, xAODType.CaloCluster, ...)
  - algoBuilder [optional] : a function returning a configured algorithm which build the container
                             the function is called as algoBuilder(parentjetdef, specs) where 
                                 parentjetdef is the JetDefinition for which this input building is called.
                                 specs is self.specs
                             If omitted, it is assumed the container pre-exists in the event store.
 - specs [optional] : a string (or anything) which specifies some options, and passed to the algoBuilder function
 - filterfn : a function taking a CondFlags as argument and deciding if this JetModifier is compatible
              with the conditions (same as JetModifier.filterfn )
              The function must return a tuple : (bool, "reason of failure")
 - prereqs : a list of prerequisites (str) for this input definition. If any, these str must match the name of other existing JetInputExternal instances. 

Definition at line 347 of file JetDefinition.py.

Constructor & Destructor Documentation

◆ __init__()

def python.JetDefinition.JetInputExternal.__init__ (   self,
  name,
  objtype,
  algoBuilder = None,
  specs = None,
  containername = None,
  filterfn = _condAlwaysPass,
  prereqs = [] 
)

Definition at line 369 of file JetDefinition.py.

369  def __init__(self, name, objtype, algoBuilder=None, specs=None, containername=None, filterfn= _condAlwaysPass, prereqs=[]):
370  self.name = name
371  self.basetype = objtype
372 
373  self.algoBuilder = algoBuilder if algoBuilder is not None else buildNothing # buildNothing returns None (see below)
374 
375  # In certain cases (EventShape) we need to configure the concrete
376  # output container name based on the jetdef and specs, so can
377  # pass in a (lambda) function to define this.
378  if containername:
379  self.containername = containername
380  else:
381  # Ordinarily we just return the name
382  self.containername = lambda dummyjetdef,dummyspecs : self.name
383 
384  self.specs = specs
385  self.filterfn = filterfn
386  self.prereqs = prereqs
387 

Member Function Documentation

◆ __eq__()

def python.JetDefinition.JetInputExternal.__eq__ (   self,
  other 
)

Definition at line 417 of file JetDefinition.py.

417  def __eq__(self,other):
418  return hash(self) == hash(other)
419 

◆ __hash__()

def python.JetDefinition.JetInputExternal.__hash__ (   self)

Definition at line 408 of file JetDefinition.py.

408  def __hash__(self):
409  return hash((
410  self.name,str(self.basetype),str(self.algoBuilder),
411  self.containername(None,None),str(self.prereqs),
412  str(self.filterfn),str(self.specs)))
413 

◆ __ne__()

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

Definition at line 420 of file JetDefinition.py.

420  def __ne__(self,rhs):
421  return (not self.__eq__(rhs))
422 
423 

◆ __str__()

def python.JetDefinition.JetInputExternal.__str__ (   self)

Definition at line 405 of file JetDefinition.py.

405  def __str__(self):
406  return f"JetInputExternal({self.name},type={str(self.basetype)})"
407 

◆ algoBuilder()

def python.JetDefinition.JetInputExternal.algoBuilder (   self)

Definition at line 391 of file JetDefinition.py.

391  def algoBuilder(self): pass

◆ basetype()

def python.JetDefinition.JetInputExternal.basetype (   self)

Definition at line 393 of file JetDefinition.py.

393  def basetype(self): pass

◆ filterfn()

def python.JetDefinition.JetInputExternal.filterfn (   self)

Definition at line 397 of file JetDefinition.py.

397  def filterfn(self):pass

◆ name()

def python.JetDefinition.JetInputExternal.name (   self)

Definition at line 389 of file JetDefinition.py.

389  def name(self): pass

◆ prereqs()

def python.JetDefinition.JetInputExternal.prereqs (   self)

Definition at line 399 of file JetDefinition.py.

399  def prereqs(self):pass
400 

◆ specs()

def python.JetDefinition.JetInputExternal.specs (   self)

Definition at line 395 of file JetDefinition.py.

395  def specs(self): pass

Member Data Documentation

◆ __repr__

def python.JetDefinition.JetInputExternal.__repr__ = __str__
staticprivate

Definition at line 415 of file JetDefinition.py.

◆ algoBuilder

python.JetDefinition.JetInputExternal.algoBuilder

Definition at line 373 of file JetDefinition.py.

◆ basetype

python.JetDefinition.JetInputExternal.basetype

Definition at line 371 of file JetDefinition.py.

◆ containername

python.JetDefinition.JetInputExternal.containername

Definition at line 379 of file JetDefinition.py.

◆ filterfn

python.JetDefinition.JetInputExternal.filterfn

Definition at line 385 of file JetDefinition.py.

◆ name

python.JetDefinition.JetInputExternal.name

Definition at line 370 of file JetDefinition.py.

◆ outputname

python.JetDefinition.JetInputExternal.outputname = make_alias("name")
static

Definition at line 402 of file JetDefinition.py.

◆ prereqs

python.JetDefinition.JetInputExternal.prereqs

Definition at line 386 of file JetDefinition.py.

◆ specs

python.JetDefinition.JetInputExternal.specs

Definition at line 384 of file JetDefinition.py.


The documentation for this class was generated from the following file:
python.HLT.Jet.TriggerJetMods.prereqs
prereqs
Definition: TriggerJetMods.py:32
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:228
python.processes.powheg.ZZ.ZZ.__init__
def __init__(self, base_directory, **kwargs)
Constructor: all process options are set here.
Definition: ZZ.py:18
CaloCondBlobAlgs_fillNoiseFromASCII.hash
dictionary hash
Definition: CaloCondBlobAlgs_fillNoiseFromASCII.py:109
str
Definition: BTagTrackIpAccessor.cxx:11