Inheritance diagram for SavePullAnalysisRefiner:

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

	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 name for this pull analysis

	contact = contact
	cached contact person for this pull analysis

	title_postfix = title_postfix
	cached suffix for the title of this pull analysis

list	part_names = []
	cached array of part names for this pull analysis

	truth_name = truth_name
	cached name for the pull analysis truth-values collection

	estimate_name = estimate_name
	cached name for the pull analysis estimates collection

	variance_name = variance_name
	cached name for the pull analysis variances collection

	quantity_name = quantity_name
	cached name of the quantity for the pull analysis

	unit = unit
	cached measurement unit for the pull analysis

	aux_names = aux_names
	cached auxiliary names for the pull analysis

	outlier_z_score = outlier_z_score
	cached Z-score (for outlier detection) for the pull analysis

	absolute = absolute
	cached absolute-value-comparison flag for the pull analysis

	which_plots = which_plots
	cached list of plots produced by the pull analysis

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

Static Public Attributes
str	default_name = "{module.id}_{quantity_name}"
	default name for this pull analysis

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

str	default_title_postfix = " from {module.title}"
	default suffix for the title of this pull analysis

str	default_truth_name = "{part_name}_truth"
	default name for the pull analysis truth-values collection

str	default_estimate_name = "{part_name}_estimate"
	default name for the pull analysis estimates collection

str	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()

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

                 which_plots=None):
        """Constructor for this refiner"""
        if aux_names is None:
            aux_names = []
        ## cached name for this pull analysis
        self.name = name
        ## cached contact person for this pull analysis
        self.contact = contact
        ## cached suffix for the title of this pull analysis
        self.title_postfix = title_postfix
 
        ## cached array of part names for this pull analysis
        self.part_names = []
        if part_names is not None:
            self.part_names = part_names
 
        if part_name is not None:
            self.part_names.append(part_name)
 
        ## cached name for the pull analysis truth-values collection
        self.truth_name = truth_name
        ## cached name for the pull analysis estimates collection
        self.estimate_name = estimate_name
        ## cached name for the pull analysis variances collection
        self.variance_name = variance_name
 
        ## cached name of the quantity for the pull analysis
        self.quantity_name = quantity_name
        ## cached measurement unit for the pull analysis
        self.unit = unit
 
        ## cached auxiliary names for the pull analysis
        self.aux_names = aux_names
 
        ## cached Z-score (for outlier detection) for the pull analysis
        self.outlier_z_score = outlier_z_score
        ## cached absolute-value-comparison flag for the pull analysis
        self.absolute = absolute
        ## cached list of plots produced by the pull analysis
        self.which_plots = which_plots
 

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 pull analysis

Reimplemented from Refiner.

Definition at line 729 of file refiners.py.

               **kwds):
        """Process the pull analysis"""
 
        replacement_dict = dict(
            refiner=self,
            module=harvesting_module,
            # stackby_key='_' + stackby if stackby else "",
            groupby_key='_' + groupby_part_name + groupby_value if groupby_part_name else "",
            groupby=groupby_part_name,  # deprecated
            groupby_value=groupby_value,  # deprecated
        )
 
        contact = self.contact or self.default_contact
        contact = formatter.format(contact, **replacement_dict)
 
        name = self.name or self.default_name
 
        if self.aux_names:
            auxiliaries = select_crop_parts(crops, self.aux_names)
        else:
            auxiliaries = {}
 
        for part_name in self.part_names:
            name = formatter.format(name, part_name=part_name, **replacement_dict)
            plot_name = name + "_{subplot_name}"
 
            title_postfix = self.title_postfix
            if title_postfix is None:
                title_postfix = self.default_title_postfix
 
            title_postfix = formatter.format(title_postfix, part_name=part_name, **replacement_dict)
            plot_title = "{subplot_title} of {quantity_name}" + title_postfix
 
            if self.truth_name is not None:
                truth_name = self.truth_name
            else:
                truth_name = self.default_truth_name
 
            if self.estimate_name is not None:
                estimate_name = self.estimate_name
            else:
                estimate_name = self.default_estimate_name
 
            if self.variance_name is not None:
                variance_name = self.variance_name
            else:
                variance_name = self.default_variance_name
 
            truth_name = formatter.format(truth_name, part_name=part_name)
            estimate_name = formatter.format(estimate_name, part_name=part_name)
            variance_name = formatter.format(variance_name, part_name=part_name)
 
            truths = crops[truth_name]
            estimates = crops[estimate_name]
            try:
                variances = crops[variance_name]
            except KeyError:
                variances = None
 
            quantity_name = self.quantity_name or part_name
 
            which_plots = self.which_plots
 
            pull_analysis = PullAnalysis(quantity_name,
                                         unit=self.unit,
                                         absolute=self.absolute,
                                         outlier_z_score=self.outlier_z_score,
                                         plot_name=plot_name,
                                         plot_title=plot_title)
 
            pull_analysis.analyse(truths,
                                  estimates,
                                  variances,
                                  auxiliaries=auxiliaries,
                                  which_plots=which_plots)
 
            pull_analysis.contact = contact
 
            if tdirectory:
                pull_analysis.write(tdirectory)
 
 

Member Data Documentation

◆ absolute

absolute = absolute

cached absolute-value-comparison flag for the pull analysis

Definition at line 725 of file refiners.py.

◆ aux_names

aux_names = aux_names

cached auxiliary names for the pull analysis

Definition at line 720 of file refiners.py.

◆ contact

contact = contact

cached contact person for this pull analysis

Definition at line 695 of file refiners.py.

◆ default_contact

str default_contact = "{module.contact}"

static

default contact person for this pull analysis

Definition at line 663 of file refiners.py.

◆ default_estimate_name

str default_estimate_name = "{part_name}_estimate"

static

default name for the pull analysis estimates collection

Definition at line 670 of file refiners.py.

◆ default_name

str default_name = "{module.id}_{quantity_name}"

static

default name for this pull analysis

Definition at line 661 of file refiners.py.

◆ default_title_postfix

str default_title_postfix = " from {module.title}"

static

default suffix for the title of this pull analysis

Definition at line 665 of file refiners.py.

◆ default_truth_name

str default_truth_name = "{part_name}_truth"

static

default name for the pull analysis truth-values collection

Definition at line 668 of file refiners.py.

◆ default_variance_name

str default_variance_name = "{part_name}_variance"

static

default name for the pull analysis variances collection

Definition at line 672 of file refiners.py.

◆ estimate_name

estimate_name = estimate_name

cached name for the pull analysis estimates collection

Definition at line 710 of file refiners.py.

◆ name

name = name

cached name for this pull analysis

Definition at line 693 of file refiners.py.

◆ outlier_z_score

outlier_z_score = outlier_z_score

cached Z-score (for outlier detection) for the pull analysis

Definition at line 723 of file refiners.py.

◆ part_names

list part_names = []

cached array of part names for this pull analysis

Definition at line 700 of file refiners.py.

◆ quantity_name

quantity_name = quantity_name

cached name of the quantity for the pull analysis

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

◆ title_postfix

title_postfix = title_postfix

cached suffix for the title of this pull analysis

Definition at line 697 of file refiners.py.

◆ truth_name

truth_name = truth_name

cached name for the pull analysis truth-values collection

Definition at line 708 of file refiners.py.

◆ unit

unit = unit

cached measurement unit for the pull analysis

Definition at line 717 of file refiners.py.

◆ variance_name

variance_name = variance_name

cached name for the pull analysis variances collection

Definition at line 712 of file refiners.py.

◆ which_plots

which_plots = which_plots

cached list of plots produced by the pull analysis

Definition at line 727 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

◆ absolute

◆ aux_names

◆ contact

◆ default_contact

◆ default_estimate_name

◆ default_name

◆ default_title_postfix

◆ default_truth_name

◆ default_variance_name

◆ estimate_name

◆ name

◆ outlier_z_score

◆ part_names

◆ quantity_name

◆ refiner_function

◆ title_postfix

◆ truth_name

◆ unit

◆ variance_name

◆ which_plots

◆ init()

◆ call()

◆ get()