Inheritance diagram for Refiner:

Public Member Functions
	__init__ (self, refiner_function=None)

	__get__ (self, harvesting_module, cls=None)

	__call__ (self, harvesting_module, crops=None, args, *kwds)

	refine (self, harvesting_module, args, *kwds)

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

Detailed Description


Python module to refine a peeled dictionary

Definition at line 34 of file refiners.py.

Constructor & Destructor Documentation

◆ init()

__init__	(		self,
			refiner_function = None )


Constructor of the Refiner instance

Definition at line 37 of file refiners.py.

    def __init__(self, refiner_function=None):
        """Constructor of the Refiner instance"""
        
        self.refiner_function = refiner_function
 

Member Function Documentation

◆ call()

__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

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 )


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,
		*	args,
		**	kwds )


Apply the instance's refiner function

Reimplemented in CdRefiner, ExpertLevelRefiner, FilterRefiner, GroupByRefiner, Plot2DRefiner, SaveClassificationAnalysisRefiner, SaveFiguresOfMeritRefiner, SaveHistogramsRefiner, SavePullAnalysisRefiner, SaveTreeRefiner, and SelectRefiner.

Definition at line 69 of file refiners.py.

    def refine(self, harvesting_module, *args, **kwds):
        """Apply the instance's refiner function"""
        self.refiner_function(harvesting_module, *args, **kwds)
 
 

Member Data Documentation

◆ refiner_function

refiner_function = refiner_function

cached copy of the instance's refiner function

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