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

Public Member Functions

def __init__ (self, y, x=None, name=None, title=None, contact=None, description=None, check=None, stackby=None, y_unit=None, y_binary=None, y_log=None, lower_bound=None, upper_bound=None, bins=None, outlier_z_score=None, fit=None, fit_z_score=None, skip_single_valued=False, allow_discrete=False)
 
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)
 

Static Public Member Functions

def has_more_than_one_value (xs)
 

Public Attributes

 name
 cached user-defined name for this profile histogram / scatterplot
 
 title
 cached user-defined title for this profile histogram / scatterplot
 
 description
 cached user-defined description for this profile histogram / scatterplot
 
 check
 cached user-defined user-check action for this profile histogram / scatterplot
 
 contact
 cached user-defined contact person for this profile histogram / scatterplot
 
 x
 cached value of abscissa
 
 y
 cached value of ordinate
 
 stackby
 cached stacking selection for this profile histogram / scatterplot
 
 y_unit
 cached measurement unit for ordinate
 
 lower_bound
 cached lower bound for this profile histogram / scatterplot
 
 upper_bound
 cached upper bound for this profile histogram / scatterplot
 
 bins
 cached number of bins for this profile histogram / scatterplot
 
 y_binary
 cached flag for probability y axis (range 0.0 . More...
 
 y_log
 cached flag for logarithmic y axis for this profile histogram / scatterplot
 
 outlier_z_score
 cached Z-score (for outlier detection) for this profile histogram / scatterplot
 
 allow_discrete
 cached flag to allow discrete values for this profile histogram / scatterplot
 
 fit
 cached fit for this profile histogram / scatterplot
 
 fit_z_score
 cached fit Z-score (for outlier detection) for this profile histogram / scatterplot
 
 skip_single_valued
 cached flag to skip single-valued bins for this profile histogram / scatterplot
 
 refiner_function
 cached copy of the instance's refiner function
 

Static Public Attributes

string plot_kind = "profile"
 by default, this refiner is for profile histograms
 

Detailed Description

Refiner for profile histograms and 2D scatterplots

Definition at line 312 of file refiners.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  y,
  x = None,
  name = None,
  title = None,
  contact = None,
  description = None,
  check = None,
  stackby = None,
  y_unit = None,
  y_binary = None,
  y_log = None,
  lower_bound = None,
  upper_bound = None,
  bins = None,
  outlier_z_score = None,
  fit = None,
  fit_z_score = None,
  skip_single_valued = False,
  allow_discrete = False 
)
Constructor for this refiner

Definition at line 317 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.

◆ has_more_than_one_value()

def has_more_than_one_value (   xs)
static
check if a list has at least two unique values

Definition at line 505 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 profile histogram / scatterplot

Definition at line 386 of file refiners.py.

Member Data Documentation

◆ y_binary

y_binary

cached flag for probability y axis (range 0.0 .

. 1.05) for this profile histogram / scatterplot

Definition at line 369 of file refiners.py.


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