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)
def	__get__ (self, harvesting_module, cls=None)
def	__call__ (self, harvesting_module, crops=None, *args, **kwds)
def	refine (self, harvesting_module, *args, **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
	refiner_function
	cached copy of the instance's refiner function

Static Public Attributes
string	default_name = "{module.id}_figures_of_merit{groupby_key}"
	default name for this refiner
string	default_title = "Figures of merit in {module.title}"
	default title for this refiner
string	default_contact = "{module.contact}"
	default contact person for this refiner
string	default_description = "Figures of merit are the {aggregation.__name__} of {keys}"
	default description for this refiner
string	default_check = "Check for reasonable values"
	default user-check action for this refiner
string	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

Definition at line 97 of file refiners.py.

Member Function Documentation

__call__()

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

__get__()

def __get__ (   self,   harvesting_module,   cls = None  )

inherited

Getter of the Refiner instance

Definition at line 42 of file refiners.py.

refine() [1/2]

def refine (   self,   harvesting_module, *  args, **  kwds  )

inherited

Apply the instance's refiner function

Definition at line 69 of file refiners.py.

refine() [2/2]

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

Process the figures of merit

Definition at line 127 of file refiners.py.

---

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

• tracking/scripts/tracking/harvest/refiners.py