SaveFiguresOfMeritRefiner Class Reference

Inheritance diagram for SaveFiguresOfMeritRefiner:

Collaboration diagram for SaveFiguresOfMeritRefiner:

Public Member Functions
def	__init__ (self, name=None, title=None, contact=None, description=None, check=None, key=None, aggregation=None)
def	refine (self, harvesting_module, crops, tdirectory=None, groupby_part_name=None, groupby_value=None, **kwds)

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

Public Attributes
	name
	cached name of the figure of merit
	title
	cached title of the figure of merit
	description
	cached description of the figure of merit
	check
	cached user-check action of the figure of merit
	contact
	cached contact person of the figure of merit
	key
	cached copy of the figures-of-merit key
	aggregation
	cached copy of the crops-aggregation method

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
def	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__()

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

Constructor for this refiner

Reimplemented from Refiner.

Definition at line 97 of file refiners.py.

                 ):
        """Constructor for this refiner"""
 
        super().__init__()
 
        
        self.name = name
        
        self.title = title
 
        
        self.description = description
        
        self.check = check
        
        self.contact = contact
 
        
        self.key = key
        
        self.aggregation = aggregation
 

Member Function Documentation

mean()

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

def 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

cached copy of the crops-aggregation method

Definition at line 125 of file refiners.py.

check

check

cached user-check action of the figure of merit

Definition at line 118 of file refiners.py.

contact

contact

cached contact person of the figure of merit

Definition at line 120 of file refiners.py.

default_aggregation

def 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

cached description of the figure of merit

Definition at line 116 of file refiners.py.

key

key

cached copy of the figures-of-merit key

Definition at line 123 of file refiners.py.

name

name

cached name of the figure of merit

Definition at line 111 of file refiners.py.

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