Belle II Software  release-08-01-10
SavePullAnalysisRefiner Class Reference
Inheritance diagram for SavePullAnalysisRefiner:
Collaboration diagram for SavePullAnalysisRefiner:

Public Member Functions

def __init__ (self, name=None, contact=None, title_postfix=None, part_name=None, part_names=None, truth_name=None, estimate_name=None, variance_name=None, quantity_name=None, aux_names=None, unit=None, outlier_z_score=None, absolute=False, which_plots=None)
 
def refine (self, harvesting_module, crops, tdirectory=None, groupby_part_name=None, groupby_value=None, **kwds)
 
def __get__ (self, harvesting_module, cls=None)
 
def __call__ (self, harvesting_module, crops=None, *args, **kwds)
 
def refine (self, harvesting_module, *args, **kwds)
 

Public Attributes

 name
 cached name for this pull analysis
 
 contact
 cached contact person for this pull analysis
 
 title_postfix
 cached suffix for the title of this pull analysis
 
 part_names
 cached array of part names for this pull analysis
 
 truth_name
 cached name for the pull analysis truth-values collection
 
 estimate_name
 cached name for the pull analysis estimates collection
 
 variance_name
 cached name for the pull analysis variances collection
 
 quantity_name
 cached name of the quantity for the pull analysis
 
 unit
 cached measurement unit for the pull analysis
 
 aux_names
 cached auxiliary names for the pull analysis
 
 outlier_z_score
 cached Z-score (for outlier detection) for the pull analysis
 
 absolute
 cached absolute-value-comparison flag for the pull analysis
 
 which_plots
 cached list of plots produced by the pull analysis
 
 refiner_function
 cached copy of the instance's refiner function
 

Static Public Attributes

string default_name = "{module.id}_{quantity_name}"
 default name for this pull analysis
 
string default_contact = "{module.contact}"
 default contact person for this pull analysis
 
string default_title_postfix = " from {module.title}"
 default suffix for the title of this pull analysis
 
string default_truth_name = "{part_name}_truth"
 default name for the pull analysis truth-values collection
 
string default_estimate_name = "{part_name}_estimate"
 default name for the pull analysis estimates collection
 
string default_variance_name = "{part_name}_variance"
 default name for the pull analysis variances collection
 

Detailed Description

Refiner for pull analyses

Definition at line 657 of file refiners.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name = None,
  contact = None,
  title_postfix = None,
  part_name = None,
  part_names = None,
  truth_name = None,
  estimate_name = None,
  variance_name = None,
  quantity_name = None,
  aux_names = None,
  unit = None,
  outlier_z_score = None,
  absolute = False,
  which_plots = None 
)
Constructor for this refiner

Definition at line 674 of file refiners.py.

Member Function Documentation

◆ __call__()

def __call__ (   self,
  harvesting_module,
  crops = None,
args,
**  kwds 
)
inherited
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.

◆ __get__()

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

Definition at line 42 of file refiners.py.

◆ refine() [1/2]

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

Definition at line 69 of file refiners.py.

◆ refine() [2/2]

def refine (   self,
  harvesting_module,
  crops,
  tdirectory = None,
  groupby_part_name = None,
  groupby_value = None,
**  kwds 
)
Process the pull analysis

Definition at line 729 of file refiners.py.


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