Inheritance diagram for SaveHistogramsRefiner:

Public Member Functions
	__init__ (self, name=None, title=None, contact=None, description=None, check=None, lower_bound=None, upper_bound=None, bins=None, outlier_z_score=None, allow_discrete=False, stackby="", fit=None, fit_z_score=None)

	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)

Public Attributes
	name = name
	cached user-defined name for this histogram

	title = title
	cached user-defined title for this histogram

	description = description
	cached user-defined description for this histogram

	check = check
	cached user-defined user-check action for this histogram

	contact = contact
	cached user-defined contact person for this histogram

	lower_bound = lower_bound
	cached lower bound for this histogram

	upper_bound = upper_bound
	cached upper bound for this histogram

	bins = bins
	cached number of bins for this histogram

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

	allow_discrete = allow_discrete
	cached flag to allow discrete values for this histogram

	stackby = stackby
	cached stacking selection for this histogram

	fit = fit
	cached fit for this histogram

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

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

Static Public Attributes
str	default_name = "{module.id}_{part_name}_histogram{groupby_key}{stackby_key}"
	default name for this histogram

str	default_title = "Histogram of {part_name}{groupby_key}{stackby_key} from {module.title}"
	default title for this histogram

str	default_contact = "{module.contact}"
	default contact person for this histogram

str	default_description = "This is a histogram of {part_name}{groupby_key}{stackby_key}."
	default description for this histogram

str	default_check = "Check if the distribution is reasonable"
	default user-check action for this histogram

Detailed Description

Refiner for histograms

Definition at line 180 of file refiners.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		name = None,
		title = None,
		contact = None,
		description = None,
		check = None,
		lower_bound = None,
		upper_bound = None,
		bins = None,
		outlier_z_score = None,
		allow_discrete = False,
		stackby = "",
		fit = None,
		fit_z_score = None )

Constructor for this refiner

Definition at line 193 of file refiners.py.

                 fit_z_score=None):
        """Constructor for this refiner"""
 
        super().__init__()
 
        ## cached user-defined name for this histogram
        self.name = name
        ## cached user-defined title for this histogram
        self.title = title
 
        ## cached user-defined description for this histogram
        self.description = description
        ## cached user-defined user-check action for this histogram
        self.check = check
        ## cached user-defined contact person for this histogram
        self.contact = contact
 
        ## cached lower bound for this histogram
        self.lower_bound = lower_bound
        ## cached upper bound for this histogram
        self.upper_bound = upper_bound
        ## cached number of bins for this histogram
        self.bins = bins
 
        ## cached Z-score (for outlier detection) for this histogram
        self.outlier_z_score = outlier_z_score
        ## cached flag to allow discrete values for this histogram
        self.allow_discrete = allow_discrete
        ## cached stacking selection for this histogram
        self.stackby = stackby
 
        ## cached fit for this histogram
        self.fit = fit
        ## cached fit Z-score (for outlier detection) for this histogram
        self.fit_z_score = fit_z_score
 

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
 

◆ refine()

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

Process the histogram

Reimplemented from Refiner.

Definition at line 242 of file refiners.py.

               **kwds):
        """Process the histogram"""
 
        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)
 
        for part_name, parts in iter_items_sorted_for_key(crops):
            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, part_name=part_name, **replacement_dict)
            title = formatter.format(title, part_name=part_name, **replacement_dict)
            description = formatter.format(description, part_name=part_name, **replacement_dict)
            check = formatter.format(check, part_name=part_name, **replacement_dict)
 
            histogram = ValidationPlot(name)
            histogram.hist(parts,
                           lower_bound=self.lower_bound,
                           upper_bound=self.upper_bound,
                           bins=self.bins,
                           outlier_z_score=self.outlier_z_score,
                           allow_discrete=self.allow_discrete,
                           stackby=stackby_parts)
 
            histogram.title = title
            histogram.contact = contact
            histogram.description = description
            histogram.check = check
 
            histogram.xlabel = compose_axis_label(part_name)
 
            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(histogram, fit_method_name)
                except AttributeError:
                    histogram.fit(str(self.fit), **kwds)
                else:
                    fit_method(**kwds)
 
            if tdirectory:
                histogram.write(tdirectory)
 
 

Member Data Documentation

◆ allow_discrete

allow_discrete = allow_discrete

cached flag to allow discrete values for this histogram

Definition at line 233 of file refiners.py.

◆ bins

bins = bins

cached number of bins for this histogram

Definition at line 228 of file refiners.py.

◆ check

check = check

cached user-defined user-check action for this histogram

Definition at line 219 of file refiners.py.

◆ contact

contact = contact

cached user-defined contact person for this histogram

Definition at line 221 of file refiners.py.

◆ default_check

str default_check = "Check if the distribution is reasonable"

static

default user-check action for this histogram

Definition at line 191 of file refiners.py.

◆ default_contact

str default_contact = "{module.contact}"

static

default contact person for this histogram

Definition at line 187 of file refiners.py.

◆ default_description

str default_description = "This is a histogram of {part_name}{groupby_key}{stackby_key}."

static

default description for this histogram

Definition at line 189 of file refiners.py.

◆ default_name

str default_name = "{module.id}_{part_name}_histogram{groupby_key}{stackby_key}"

static

default name for this histogram

Definition at line 183 of file refiners.py.

◆ default_title

str default_title = "Histogram of {part_name}{groupby_key}{stackby_key} from {module.title}"

static

default title for this histogram

Definition at line 185 of file refiners.py.

◆ description

description = description

cached user-defined description for this histogram

Definition at line 217 of file refiners.py.

◆ fit

fit = fit

cached fit for this histogram

Definition at line 238 of file refiners.py.

◆ fit_z_score

fit_z_score = fit_z_score

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

Definition at line 240 of file refiners.py.

◆ lower_bound

lower_bound = lower_bound

cached lower bound for this histogram

Definition at line 224 of file refiners.py.

◆ name

name = name

cached user-defined name for this histogram

Definition at line 212 of file refiners.py.

◆ outlier_z_score

outlier_z_score = outlier_z_score

cached Z-score (for outlier detection) for this histogram

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

◆ stackby

stackby = stackby

cached stacking selection for this histogram

Definition at line 235 of file refiners.py.

◆ title

title = title

cached user-defined title for this histogram

Definition at line 214 of file refiners.py.

◆ upper_bound

upper_bound = upper_bound

cached upper bound for this histogram

Definition at line 226 of file refiners.py.

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

tracking/scripts/tracking/harvest/refiners.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __call__()

◆ __get__()

◆ refine()

Member Data Documentation

◆ allow_discrete

◆ bins

◆ check

◆ contact

◆ default_check

◆ default_contact

◆ default_description

◆ default_name

◆ default_title

◆ description

◆ fit

◆ fit_z_score

◆ lower_bound

◆ name

◆ outlier_z_score

◆ refiner_function

◆ stackby

◆ title

◆ upper_bound

◆ init()

◆ call()

◆ get()