Inheritance diagram for Plot2DRefiner:

Public Member Functions
	__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)

	refine (self, harvesting_module, crops, tdirectory=None, groupby_part_name=None, groupby_value=None, **kwds)

	__get__ (self, harvesting_module, cls=None)

	__call__ (self, harvesting_module, crops=None, args, *kwds)

Static Public Member Functions
	has_more_than_one_value (xs)

Public Attributes
	name = name
	cached user-defined name for this profile histogram / scatterplot

	title = title
	cached user-defined title for this profile histogram / scatterplot

	description = description
	cached user-defined description for this profile histogram / scatterplot

	check = check
	cached user-defined user-check action for this profile histogram / scatterplot

	contact = contact
	cached user-defined contact person for this profile histogram / scatterplot

	x = x
	cached value of abscissa

	y = y
	cached value of ordinate

	stackby = stackby
	cached stacking selection for this profile histogram / scatterplot

	y_unit = y_unit
	cached measurement unit for ordinate

	lower_bound = lower_bound
	cached lower bound for this profile histogram / scatterplot

	upper_bound = upper_bound
	cached upper bound for this profile histogram / scatterplot

	bins = bins
	cached number of bins for this profile histogram / scatterplot

	y_binary = y_binary
	cached flag for probability y axis (range 0.0 .

	y_log = y_log
	cached flag for logarithmic y axis for this profile histogram / scatterplot

	outlier_z_score = outlier_z_score
	cached Z-score (for outlier detection) for this profile histogram / scatterplot

	allow_discrete = allow_discrete
	cached flag to allow discrete values for this profile histogram / scatterplot

	fit = fit
	cached fit for this profile histogram / scatterplot

	fit_z_score = fit_z_score
	cached fit Z-score (for outlier detection) for this profile histogram / scatterplot

	skip_single_valued = skip_single_valued
	cached flag to skip single-valued bins for this profile histogram / scatterplot

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

Static Public Attributes
str	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()

__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.

                 allow_discrete=False):
        """Constructor for this refiner"""
 
        super().__init__()
 
        ## cached user-defined name for this profile histogram / scatterplot
        self.name = name
        ## cached user-defined title for this profile histogram / scatterplot
        self.title = title
 
        ## cached user-defined description for this profile histogram / scatterplot
        self.description = description
        ## cached user-defined user-check action for this profile histogram / scatterplot
        self.check = check
        ## cached user-defined contact person for this profile histogram / scatterplot
        self.contact = contact
 
        ## cached value of abscissa
        self.x = x
        ## cached value of ordinate
        self.y = y
        ## cached stacking selection for this profile histogram / scatterplot
        self.stackby = stackby
        ## cached measurement unit for ordinate
        self.y_unit = y_unit
 
        ## cached lower bound for this profile histogram / scatterplot
        self.lower_bound = lower_bound
        ## cached upper bound for this profile histogram / scatterplot
        self.upper_bound = upper_bound
        ## cached number of bins for this profile histogram / scatterplot
        self.bins = bins
        ## cached flag for probability y axis (range 0.0 .. 1.05) for this profile histogram / scatterplot
        self.y_binary = y_binary
        ## cached flag for logarithmic y axis for this profile histogram / scatterplot
        self.y_log = y_log
 
        ## cached Z-score (for outlier detection) for this profile histogram / scatterplot
        self.outlier_z_score = outlier_z_score
        ## cached flag to allow discrete values for this profile histogram / scatterplot
        self.allow_discrete = allow_discrete
 
        ## cached fit for this profile histogram / scatterplot
        self.fit = fit
        ## cached fit Z-score (for outlier detection) for this profile histogram / scatterplot
        self.fit_z_score = fit_z_score
 
        ## cached flag to skip single-valued bins for this profile histogram / scatterplot
        self.skip_single_valued = skip_single_valued
 

Member Function Documentation

◆ call()

__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.

    def __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
        """
        if crops is None:
            # Decoration mode
            harvesting_module.refiners.append(self)
            return harvesting_module
        else:
            # Refining mode
            return self.refine(harvesting_module, crops, *args, **kwds)
 

◆ get()

__get__	(	self,
		harvesting_module,
		cls = None )

inherited

Getter of the Refiner instance

Definition at line 42 of file refiners.py.

    def __get__(self, harvesting_module, cls=None):
        """Getter of the Refiner instance"""
        if harvesting_module is None:
            # Class access
            return self
        else:
            # Instance access
            refine = self.refine
 
            def bound_call(*args, **kwds):
                return refine(harvesting_module, *args, **kwds)
            return bound_call
 

◆ has_more_than_one_value()

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.

    def has_more_than_one_value(xs):
        """check if a list has at least two unique values"""
        first_x = xs[0]
        for x in xs:
            if x != first_x:
                return True
        else:
            return False
 
 

◆ refine()

refine	(		self,
			harvesting_module,
			crops,
			tdirectory = None,
			groupby_part_name = None,
			groupby_value = None,
		**	kwds )

Process the profile histogram / scatterplot

Reimplemented from Refiner.

Definition at line 386 of file refiners.py.

               **kwds):
        """Process the profile histogram / scatterplot"""
 
        stackby = self.stackby
        if stackby:
            stackby_parts = crops[stackby]
        else:
            stackby_parts = None
 
        replacement_dict = dict(
            refiner=self,
            module=harvesting_module,
            stackby_key=' stacked by ' + stackby if stackby else "",
            groupby_key=' in group ' + groupby_part_name + groupby_value if groupby_part_name else "",
        )
 
        contact = self.contact or self.default_contact
        contact = formatter.format(contact, **replacement_dict)
 
        y_crops = select_crop_parts(crops, select=self.y)
        x_crops = select_crop_parts(crops, select=self.x, exclude=self.y)
 
        for y_part_name, y_parts in iter_items_sorted_for_key(y_crops):
            for x_part_name, x_parts in iter_items_sorted_for_key(x_crops):
 
                if self.skip_single_valued and not self.has_more_than_one_value(x_parts):
                    get_logger().info('Skipping "%s" by "%s" profile because x has only a single value "%s"',
                                      y_part_name,
                                      x_part_name,
                                      x_parts[0])
                    continue
 
                if self.skip_single_valued and not self.has_more_than_one_value(y_parts):
                    get_logger().info('Skipping "%s" by "%s" profile because y has only a single value "%s"',
                                      y_part_name,
                                      x_part_name,
                                      y_parts[0])
                    continue
 
                name = self.name or self.default_name
                title = self.title or self.default_title
                description = self.description or self.default_description
                check = self.check or self.default_check
 
                name = formatter.format(name,
                                        x_part_name=x_part_name,
                                        y_part_name=y_part_name,
                                        **replacement_dict)
 
                title = formatter.format(title,
                                         x_part_name=x_part_name,
                                         y_part_name=y_part_name,
                                         **replacement_dict)
 
                description = formatter.format(description,
                                               x_part_name=x_part_name,
                                               y_part_name=y_part_name,
                                               **replacement_dict)
 
                check = formatter.format(check,
                                         x_part_name=x_part_name,
                                         y_part_name=y_part_name,
                                         **replacement_dict)
 
                profile_plot = ValidationPlot(name)
 
                plot_kind = self.plot_kind
                if plot_kind == "profile":
                    profile_plot.profile(x_parts,
                                         y_parts,
                                         lower_bound=self.lower_bound,
                                         upper_bound=self.upper_bound,
                                         bins=self.bins,
                                         y_binary=self.y_binary,
                                         y_log=self.y_log,
                                         outlier_z_score=self.outlier_z_score,
                                         allow_discrete=self.allow_discrete,
                                         stackby=stackby_parts)
 
                    if self.fit:
                        if self.fit_z_score is None:
                            kwds = dict()
                        else:
                            kwds = dict(z_score=self.fit_z_score)
 
                        fit_method_name = 'fit_' + str(self.fit)
                        try:
                            fit_method = getattr(profile_plot, fit_method_name)
                        except BaseException:
                            profile_plot.fit(str(self.fit), **kwds)
                        else:
                            fit_method(**kwds)
 
                elif plot_kind == "scatter":
                    profile_plot.scatter(x_parts,
                                         y_parts,
                                         lower_bound=self.lower_bound,
                                         upper_bound=self.upper_bound,
                                         outlier_z_score=self.outlier_z_score,
                                         stackby=stackby_parts)
 
                profile_plot.title = title
                profile_plot.contact = contact
                profile_plot.description = description
                profile_plot.check = check
 
                profile_plot.xlabel = compose_axis_label(x_part_name)
                profile_plot.ylabel = compose_axis_label(y_part_name, self.y_unit)
 
                if tdirectory:
                    profile_plot.write(tdirectory)
 

Member Data Documentation

◆ allow_discrete

allow_discrete = allow_discrete

cached flag to allow discrete values for this profile histogram / scatterplot

Definition at line 376 of file refiners.py.

◆ bins

bins = bins

cached number of bins for this profile histogram / scatterplot

Definition at line 367 of file refiners.py.

◆ check

check = check

cached user-defined user-check action for this profile histogram / scatterplot

Definition at line 349 of file refiners.py.

◆ contact

contact = contact

cached user-defined contact person for this profile histogram / scatterplot

Definition at line 351 of file refiners.py.

◆ description

description = description

cached user-defined description for this profile histogram / scatterplot

Definition at line 347 of file refiners.py.

◆ fit

fit = fit

cached fit for this profile histogram / scatterplot

Definition at line 379 of file refiners.py.

◆ fit_z_score

fit_z_score = fit_z_score

cached fit Z-score (for outlier detection) for this profile histogram / scatterplot

Definition at line 381 of file refiners.py.

◆ lower_bound

lower_bound = lower_bound

cached lower bound for this profile histogram / scatterplot

Definition at line 363 of file refiners.py.

◆ name

name = name

cached user-defined name for this profile histogram / scatterplot

Definition at line 342 of file refiners.py.

◆ outlier_z_score

outlier_z_score = outlier_z_score

cached Z-score (for outlier detection) for this profile histogram / scatterplot

Definition at line 374 of file refiners.py.

◆ plot_kind

str plot_kind = "profile"

static

by default, this refiner is for profile histograms

Definition at line 315 of file refiners.py.

◆ refiner_function

refiner_function = refiner_function

inherited

cached copy of the instance's refiner function

Definition at line 40 of file refiners.py.

◆ skip_single_valued

skip_single_valued = skip_single_valued

cached flag to skip single-valued bins for this profile histogram / scatterplot

Definition at line 384 of file refiners.py.

◆ stackby

stackby = stackby

cached stacking selection for this profile histogram / scatterplot

Definition at line 358 of file refiners.py.

◆ title

title = title

cached user-defined title for this profile histogram / scatterplot

Definition at line 344 of file refiners.py.

◆ upper_bound

upper_bound = upper_bound

cached upper bound for this profile histogram / scatterplot

Definition at line 365 of file refiners.py.

◆ x

x = x

cached value of abscissa

Definition at line 354 of file refiners.py.

◆ y

y = y

cached value of ordinate

Definition at line 356 of file refiners.py.

◆ y_binary

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.

◆ y_log

y_log = y_log

cached flag for logarithmic y axis for this profile histogram / scatterplot

Definition at line 371 of file refiners.py.

◆ y_unit

y_unit = y_unit

cached measurement unit for ordinate

Definition at line 360 of file refiners.py.

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

tracking/scripts/tracking/harvest/refiners.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __call__()

◆ __get__()

◆ has_more_than_one_value()

◆ refine()

Member Data Documentation

◆ allow_discrete

◆ bins

◆ check

◆ contact

◆ description

◆ fit

◆ fit_z_score

◆ lower_bound

◆ name

◆ outlier_z_score

◆ plot_kind

◆ refiner_function

◆ skip_single_valued

◆ stackby

◆ title

◆ upper_bound

◆ x

◆ y

◆ y_binary

◆ y_log

◆ y_unit

◆ init()

◆ call()

◆ get()