Inheritance diagram for SaveFiguresOfMeritRefiner:

Public Member Functions
	__init__ (self, name=None, title=None, contact=None, description=None, check=None, key=None, aggregation=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)

Static Public Member Functions
	mean (xs)
	return the mean of the parts, ignoring NaNs

Public Attributes
	name = name
	cached name of the figure of merit

	title = title
	cached title of the figure of merit

	description = description
	cached description of the figure of merit

	check = check
	cached user-check action of the figure of merit

	contact = contact
	cached contact person of the figure of merit

	key = key
	cached copy of the figures-of-merit key

	aggregation = aggregation
	cached copy of the crops-aggregation method

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

Static Public Attributes
str	default_name = "{module.id}_figures_of_merit{groupby_key}"
	default name for this refiner

str	default_title = "Figures of merit in {module.title}"
	default title for this refiner

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

str	default_description = "Figures of merit are the {aggregation.__name__} of {keys}"
	default description for this refiner

str	default_check = "Check for reasonable values"
	default user-check action for this refiner

str	default_key = "{aggregation.__name__}_{part_name}"
	default key name for this refiner

	default_aggregation = mean
	default aggregation is the mean of the parts

Detailed Description

Refiner for figures of merit

Definition at line 74 of file refiners.py.

Constructor & Destructor Documentation

◆ init()

__init__	(	self,
		name = None,
		title = None,
		contact = None,
		description = None,
		check = None,
		key = None,
		aggregation = None )

Constructor for this refiner

Definition at line 97 of file refiners.py.

                 ):
        """Constructor for this refiner"""
 
        super().__init__()
 
        ## cached name of the figure of merit
        self.name = name
        ## cached title of the figure of merit
        self.title = title
 
        ## cached description of the figure of merit
        self.description = description
        ## cached user-check action of the figure of merit
        self.check = check
        ## cached contact person of the figure of merit
        self.contact = contact
 
        ## cached copy of the figures-of-merit key
        self.key = key
        ## cached copy of the crops-aggregation method
        self.aggregation = aggregation
 

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
 

◆ mean()

mean ( xs )

static

return the mean of the parts, ignoring NaNs

Definition at line 91 of file refiners.py.

    def mean(xs):
        return np.nanmean(xs)
 

◆ refine()

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

Process the figures of merit

Reimplemented from Refiner.

Definition at line 127 of file refiners.py.

               **kwds):
        """Process the figures of merit"""
 
        name = self.name or self.default_name
        title = self.title or self.default_title
        contact = self.contact or self.default_contact
        description = self.description or self.default_description
        check = self.check or self.default_check
 
        aggregation = self.aggregation or self.default_aggregation
 
        replacement_dict = dict(
            refiner=self,
            module=harvesting_module,
            aggregation=aggregation,
            groupby_key='_' + groupby_part_name + groupby_value if groupby_part_name else "",
            groupby=groupby_part_name,  # deprecated
            groupby_value=groupby_value,  # deprecated
        )
 
        name = formatter.format(name, **replacement_dict)
        title = formatter.format(title, **replacement_dict)
        contact = formatter.format(contact, **replacement_dict)
 
        figures_of_merit = ValidationFiguresOfMerit(name,
                                                    contact=contact,
                                                    title=title)
 
        for part_name, parts in iter_items_sorted_for_key(crops):
            key = self.key or self.default_key
            key = formatter.format(key, part_name=part_name, **replacement_dict)
            figures_of_merit[key] = aggregation(parts)
 
        keys = list(figures_of_merit.keys())
 
        description = formatter.format(description, keys=keys, **replacement_dict)
        check = formatter.format(check, keys=keys, **replacement_dict)
 
        figures_of_merit.description = description
        figures_of_merit.check = check
 
        if tdirectory:
            figures_of_merit.write(tdirectory)
 
        print(figures_of_merit)
 
 

Member Data Documentation

◆ aggregation

aggregation = aggregation

cached copy of the crops-aggregation method

Definition at line 125 of file refiners.py.

◆ check

check = check

cached user-check action of the figure of merit

Definition at line 118 of file refiners.py.

◆ contact

contact = contact

cached contact person of the figure of merit

Definition at line 120 of file refiners.py.

◆ default_aggregation

default_aggregation = mean

static

default aggregation is the mean of the parts

Definition at line 95 of file refiners.py.

◆ default_check

str default_check = "Check for reasonable values"

static

default user-check action for this refiner

Definition at line 85 of file refiners.py.

◆ default_contact

str default_contact = "{module.contact}"

static

default contact person for this refiner

Definition at line 81 of file refiners.py.

◆ default_description

str default_description = "Figures of merit are the {aggregation.__name__} of {keys}"

static

default description for this refiner

Definition at line 83 of file refiners.py.

◆ default_key

str default_key = "{aggregation.__name__}_{part_name}"

static

default key name for this refiner

Definition at line 87 of file refiners.py.

◆ default_name

str default_name = "{module.id}_figures_of_merit{groupby_key}"

static

default name for this refiner

Definition at line 77 of file refiners.py.

◆ default_title

str default_title = "Figures of merit in {module.title}"

static

default title for this refiner

Definition at line 79 of file refiners.py.

◆ description

description = description

cached description of the figure of merit

Definition at line 116 of file refiners.py.

◆ key

key = key

cached copy of the figures-of-merit key

Definition at line 123 of file refiners.py.

◆ name

name = name

cached name of the figure of merit

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

title = title

cached title of the figure of merit

Definition at line 113 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__()

◆ mean()

◆ refine()

Member Data Documentation

◆ aggregation

◆ check

◆ contact

◆ default_aggregation

◆ default_check

◆ default_contact

◆ default_description

◆ default_key

◆ default_name

◆ default_title

◆ description

◆ key

◆ name

◆ refiner_function

◆ title

◆ init()

◆ call()

◆ get()