SaveHistogramsRefiner Class Reference

Inheritance diagram for SaveHistogramsRefiner:

Collaboration diagram for SaveHistogramsRefiner:

Public Member Functions
def	__init__ (self, name=None, title=None, contact=None, description=None, check=None, lower_bound=None, upper_bound=None, bins=None, outlier_z_score=None, allow_discrete=False, stackby="", fit=None, fit_z_score=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)

Public Attributes
	name
	cached user-defined name for this histogram
	title
	cached user-defined title for this histogram
	description
	cached user-defined description for this histogram
	check
	cached user-defined user-check action for this histogram
	contact
	cached user-defined contact person for this histogram
	lower_bound
	cached lower bound for this histogram
	upper_bound
	cached upper bound for this histogram
	bins
	cached number of bins for this histogram
	outlier_z_score
	cached Z-score (for outlier detection) for this histogram
	allow_discrete
	cached flag to allow discrete values for this histogram
	stackby
	cached stacking selection for this histogram
	fit
	cached fit for this histogram
	fit_z_score
	cached fit Z-score (for outlier detection) for this histogram
	refiner_function
	cached copy of the instance's refiner function

Static Public Attributes
string	default_name = "{module.id}_{part_name}_histogram{groupby_key}{stackby_key}"
	default name for this histogram
string	default_title = "Histogram of {part_name}{groupby_key}{stackby_key} from {module.title}"
	default title for this histogram
string	default_contact = "{module.contact}"
	default contact person for this histogram
string	default_description = "This is a histogram of {part_name}{groupby_key}{stackby_key}."
	default description for this histogram
string	default_check = "Check if the distribution is reasonable"
	default user-check action for this histogram

Detailed Description

Refiner for histograms

Definition at line 180 of file refiners.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			name = None,
			title = None,
			contact = None,
			description = None,
			check = None,
			lower_bound = None,
			upper_bound = None,
			bins = None,
			outlier_z_score = None,
			allow_discrete = False,
			stackby = "",
			fit = None,
			fit_z_score = None
	)

Constructor for this refiner

Definition at line 193 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 histogram

Definition at line 242 of file refiners.py.

---

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

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