Source code for pyfibre.core.i_multi_image_analyser
from traits.api import Interface, Instance, List, Str
from .i_multi_image import IMultiImage
[docs]class IMultiImageAnalyser(Interface):
"""Interface class that provides requirements any object defines
analysis of IMultiImage class"""
#: Reference to multi image under analysis
multi_image = Instance(IMultiImage)
#: List of names for each database that will be generated by the
#: analysis
database_names = List(Str)
[docs] def image_analysis(self, *args, **kwargs):
"""Perform analysis on data"""
[docs] def create_metrics(self, *args, **kwargs):
"""Create metrics from multi-image components that can be
generated upon end of analysis"""
[docs] def make_directories(self):
"""Creates required directories for analysis"""
[docs] def save_databases(self, databases):
"""Save databases that have been generated by the analysis
Parameters
----------
databases: list(pd.DataFrame)
List of pandas dataframes generated by the analysis
"""
[docs] def load_databases(self):
"""Loads and returns databases that have been generated by
the analysis
Returns
-------
databases: list(pd.DataFrame)
List of pandas dataframes generated by the analysis
"""