Inheritance diagram for SaveClassificationAnalysisRefiner:

Public Member Functions
	__init__ (self, part_name=None, contact=None, estimate_name=None, truth_name=None, cut_direction=None, cut=None, lower_bound=None, upper_bound=None, outlier_z_score=None, allow_discrete=False, unit=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
	part_name = part_name
	cached part name for this truth-classification analysis

	contact = contact
	cached contact person for this truth-classification analysis

	estimate_name = estimate_name
	cached estimates-collection name for this truth-classification analysis

	truth_name = truth_name
	cached truth-values-collection name for this truth-classification analysis

	cut = cut
	cached threshold of estimates for this truth-classification analysis

	cut_direction = cut_direction
	cached cut direction (> or <) of estimates for this truth-classification analysis

	lower_bound = lower_bound
	cached lower bound of estimates for this truth-classification analysis

	upper_bound = upper_bound
	cached upper bound of estimates for this truth-classification analysis

	outlier_z_score = outlier_z_score
	cached Z-score (for outlier detection) of estimates for this truth-classification analysis

	allow_discrete = allow_discrete
	cached discrete-value flag of estimates for this truth-classification analysis

	unit = unit
	cached measurement unit of estimates for this truth-classification analysis

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

Static Public Attributes
str	default_contact = "{module.contact}"
	default contact person for this truth-classification analysis

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

str	default_estimate_name = "{part_name}_estimate"
	default name for the truth-classification analysis estimates collection

Detailed Description

Refiner for truth-classification analyses

Definition at line 549 of file refiners.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		part_name = None,
		contact = None,
		estimate_name = None,
		truth_name = None,
		cut_direction = None,
		cut = None,
		lower_bound = None,
		upper_bound = None,
		outlier_z_score = None,
		allow_discrete = False,
		unit = None )

Constructor for this refiner

Definition at line 560 of file refiners.py.

                 unit=None):
        """Constructor for this refiner"""
 
        ## cached part name for this truth-classification analysis
        self.part_name = part_name
        ## cached contact person for this truth-classification analysis
        self.contact = contact
        ## cached estimates-collection name for this truth-classification analysis
        self.estimate_name = estimate_name
        ## cached truth-values-collection name for this truth-classification analysis
        self.truth_name = truth_name
 
        ## cached threshold of estimates for this truth-classification analysis
        self.cut = cut
        ## cached cut direction (> or <) of estimates for this truth-classification analysis
        self.cut_direction = cut_direction
 
        ## cached lower bound of estimates for this truth-classification analysis
        self.lower_bound = lower_bound
        ## cached upper bound of estimates for this truth-classification analysis
        self.upper_bound = upper_bound
        ## cached Z-score (for outlier detection) of estimates for this truth-classification analysis
        self.outlier_z_score = outlier_z_score
        ## cached discrete-value flag of estimates for this truth-classification analysis
        self.allow_discrete = allow_discrete
        ## cached measurement unit of estimates for this truth-classification analysis
        self.unit = unit
 

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 truth-classification analysis

Reimplemented from Refiner.

Definition at line 599 of file refiners.py.

               **kwds):
        """Process the truth-classification analysis"""
 
        replacement_dict = dict(
            refiner=self,
            module=harvesting_module,
            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)
 
        if self.truth_name is not None:
            truth_name = self.truth_name
        else:
            truth_name = self.default_truth_name
 
        truth_name = formatter.format(truth_name, part_name=self.part_name)
        truths = crops[truth_name]
 
        if self.estimate_name is not None:
            estimate_name = self.estimate_name
        else:
            estimate_name = self.default_estimate_name
 
        if isinstance(estimate_name, str):
            estimate_names = [estimate_name, ]
        else:
            estimate_names = estimate_name
 
        for estimate_name in estimate_names:
            estimate_name = formatter.format(estimate_name, part_name=self.part_name)
            estimates = crops[estimate_name]
 
            classification_analysis = ClassificationAnalysis(quantity_name=estimate_name,
                                                             contact=contact,
                                                             cut_direction=self.cut_direction,
                                                             cut=self.cut,
                                                             lower_bound=self.lower_bound,
                                                             upper_bound=self.upper_bound,
                                                             outlier_z_score=self.outlier_z_score,
                                                             allow_discrete=self.allow_discrete,
                                                             unit=self.unit)
 
            classification_analysis.analyse(estimates, truths)
 
            if tdirectory:
                classification_analysis.write(tdirectory)
 
 

Member Data Documentation

◆ allow_discrete

allow_discrete = allow_discrete

cached discrete-value flag of estimates for this truth-classification analysis

Definition at line 595 of file refiners.py.

◆ contact

contact = contact

cached contact person for this truth-classification analysis

Definition at line 577 of file refiners.py.

◆ cut

cut = cut

cached threshold of estimates for this truth-classification analysis

Definition at line 584 of file refiners.py.

◆ cut_direction

cut_direction = cut_direction

cached cut direction (> or <) of estimates for this truth-classification analysis

Definition at line 586 of file refiners.py.

◆ default_contact

str default_contact = "{module.contact}"

static

default contact person for this truth-classification analysis

Definition at line 553 of file refiners.py.

◆ default_estimate_name

str default_estimate_name = "{part_name}_estimate"

static

default name for the truth-classification analysis estimates collection

Definition at line 558 of file refiners.py.

◆ default_truth_name

str default_truth_name = "{part_name}_truth"

static

default name for the truth-classification analysis truth-values collection

Definition at line 556 of file refiners.py.

◆ estimate_name

estimate_name = estimate_name

cached estimates-collection name for this truth-classification analysis

Definition at line 579 of file refiners.py.

◆ lower_bound

lower_bound = lower_bound

cached lower bound of estimates for this truth-classification analysis

Definition at line 589 of file refiners.py.

◆ outlier_z_score

outlier_z_score = outlier_z_score

cached Z-score (for outlier detection) of estimates for this truth-classification analysis

Definition at line 593 of file refiners.py.

◆ part_name

part_name = part_name

cached part name for this truth-classification analysis

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

◆ truth_name

truth_name = truth_name

cached truth-values-collection name for this truth-classification analysis

Definition at line 581 of file refiners.py.

◆ unit

unit = unit

cached measurement unit of estimates for this truth-classification analysis

Definition at line 597 of file refiners.py.

◆ upper_bound

upper_bound = upper_bound

cached upper bound of estimates for this truth-classification analysis

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

◆ contact

◆ cut

◆ cut_direction

◆ default_contact

◆ default_estimate_name

◆ default_truth_name

◆ estimate_name

◆ lower_bound

◆ outlier_z_score

◆ part_name

◆ refiner_function

◆ truth_name

◆ unit

◆ upper_bound

◆ init()

◆ call()

◆ get()