Home | Trees | Indices | Help |
|
---|
|
A measure computed from a `Dataset` All dataset measures support arbitrary transformation of the measure after it has been computed. Transformation are done by processing the measure with a functor that is specified via the `transformer` keyword argument of the constructor. Upon request, the raw measure (before transformations are applied) is stored in the `raw_result` state variable. Additionally all dataset measures support the estimation of the probabilit(y,ies) of a measure under some distribution. Typically this will be the NULL distribution (no signal), that can be estimated with permutation tests. If a distribution estimator instance is passed to the `null_dist` keyword argument of the constructor the respective probabilities are automatically computed and stored in the `null_prob` state variable. :Developer note: All subclasses shall get all necessary parameters via their constructor, so it is possible to get the same type of measure for multiple datasets by passing them to the __call__() method successively. Constructor information for `DatasetMeasure` class __________________________________________________ Does nothing special. :Parameter: transformer: Functor This functor is called in `__call__()` to perform a final processing step on the to be returned dataset measure. If None, nothing is called null_dist : instance of distribution estimator Documentation for base classes of `DatasetMeasure` =================================================== Documentation for class `Stateful` ---------------------------------- Base class for stateful objects. Classes inherited from this class gain ability to provide state variables, accessed as simple properties. Access to state variables "internals" is done via states property and interface of `StateCollection`. NB This one is to replace old State base class TODO: rename 'descr'? -- it should simply be 'doc' -- no need to drag classes docstring imho.
|
|||
Inherited from |
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from |
|
|||
raw_result = StateVariable(enabled= False, doc= "Computed resu
|
|||
null_prob = StateVariable(enabled= True) Stores the probability of a measure under the NULL hypothesis |
|||
__doc__ = enhancedDocString('DatasetMeasure', locals(), Stateful)
|
|||
_collections_template =
|
|||
Inherited from |
|
|||
__transformer Functor to be called in return statement of all subclass __call__() methods. |
|
|||
Inherited from Inherited from |
|
|
Compute measure on a given Dataset. Each implementation has to handle a single arguments: the source dataset. Returns the computed measure in some iterable (list-like) container applying transformer if such is defined |
Actually compute measure on a given Dataset. Each implementation has to handle a single arguments: the source dataset. Returns the computed measure in some iterable (list-like) container. |
|
|
raw_result
|
_collections_template
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Sun Jun 1 19:01:53 2008 | http://epydoc.sourceforge.net |