:mod:`neuron_morphology.feature_extractor.feature_extraction_run` ================================================================= .. py:module:: neuron_morphology.feature_extractor.feature_extraction_run Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: neuron_morphology.feature_extractor.feature_extraction_run.FeatureExtractionRun .. py:class:: FeatureExtractionRun(data) .. method:: select_marks(self, marks: Collection[Type[Mark]], required_marks: AbstractSet[Type[Mark]] = frozenset()) Choose marks for this run by validating a set of candidates against the data. :Parameters: **marks** : candidate marks to be validated .. **required_marks** : if provided, raise an exception if any of these marks do not validate successfully :Returns: **self** : This FeatureExtractionRun, with selected_marks updated .. .. !! processed by numpydoc !! .. method:: select_features(self, features: Collection[MarkedFeature], only_marks: Optional[AbstractSet[Type[Mark]]] = None) Choose features to calculated for this run on the basis of selected marks. :Parameters: **features** : Candidates features for selection .. **only_marks** : if provided, reject features not marked with marks in this set :Returns: **self** : This FeatureExtractionRun, with selected_features updated .. .. !! processed by numpydoc !! .. method:: extract(self) For each selected feature, carry out calculation on this run's dataset. :Returns: **self** : This FeatureExtractionRun, with results updated .. .. !! processed by numpydoc !! .. method:: serialize(self) Return a dictionary describing this run .. !! processed by numpydoc !!