Belle II Software development
Refiner Class Reference
Inheritance diagram for Refiner:
CdRefiner ExpertLevelRefiner FilterRefiner GroupByRefiner Plot2DRefiner SaveClassificationAnalysisRefiner SaveFiguresOfMeritRefiner SaveHistogramsRefiner SavePullAnalysisRefiner SaveTreeRefiner SelectRefiner

Public Member Functions

 __init__ (self, refiner_function=None)
 
 __get__ (self, harvesting_module, cls=None)
 
 __call__ (self, harvesting_module, crops=None, *args, **kwds)
 
 refine (self, harvesting_module, *args, **kwds)
 

Public Attributes

 refiner_function = refiner_function
 cached copy of the instance's refiner function
 

Detailed Description

Python module to refine a peeled dictionary

Definition at line 34 of file refiners.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
refiner_function = None )
Constructor of the Refiner instance

Definition at line 37 of file refiners.py.

37 def __init__(self, refiner_function=None):
38 """Constructor of the Refiner instance"""
39
40 self.refiner_function = refiner_function
41

Member Function Documentation

◆ __call__()

__call__ ( self,
harvesting_module,
crops = None,
* args,
** kwds )
implementation of the function-call of the Refiner instance r = Refiner() r(harvester) # decoration r(harvester, crops, args, keywords) # refinement

Definition at line 55 of file refiners.py.

55 def __call__(self, harvesting_module, crops=None, *args, **kwds):
56 """implementation of the function-call of the Refiner instance
57 r = Refiner()
58 r(harvester) # decoration
59 r(harvester, crops, args, keywords) # refinement
60 """
61 if crops is None:
62 # Decoration mode
63 harvesting_module.refiners.append(self)
64 return harvesting_module
65 else:
66 # Refining mode
67 return self.refine(harvesting_module, crops, *args, **kwds)
68

◆ __get__()

__get__ ( self,
harvesting_module,
cls = None )
Getter of the Refiner instance

Definition at line 42 of file refiners.py.

42 def __get__(self, harvesting_module, cls=None):
43 """Getter of the Refiner instance"""
44 if harvesting_module is None:
45 # Class access
46 return self
47 else:
48 # Instance access
49 refine = self.refine
50
51 def bound_call(*args, **kwds):
52 return refine(harvesting_module, *args, **kwds)
53 return bound_call
54

◆ refine()

refine ( self,
harvesting_module,
* args,
** kwds )
Apply the instance's refiner function

Reimplemented in CdRefiner, ExpertLevelRefiner, FilterRefiner, GroupByRefiner, Plot2DRefiner, SaveClassificationAnalysisRefiner, SaveFiguresOfMeritRefiner, SaveHistogramsRefiner, SavePullAnalysisRefiner, SaveTreeRefiner, and SelectRefiner.

Definition at line 69 of file refiners.py.

69 def refine(self, harvesting_module, *args, **kwds):
70 """Apply the instance's refiner function"""
71 self.refiner_function(harvesting_module, *args, **kwds)
72
73

Member Data Documentation

◆ refiner_function

refiner_function = refiner_function

cached copy of the instance's refiner function

Definition at line 40 of file refiners.py.


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