Source code for pylorenzmie.analysis.BaseEstimator

'''Abstract base class for hologram parameter estimators.'''

from abc import abstractmethod
from pylorenzmie.lib import LMObject
from pylorenzmie.lib.lmtypes import Result
from pylorenzmie.analysis.Hologram import Hologram




class BaseEstimator(LMObject):
    '''Abstract base for particle parameter estimators.

    Subclasses must implement :meth:`estimate` and the
    :attr:`~pylorenzmie.lib.LMObject.properties` getter inherited
    from :class:`~pylorenzmie.lib.LMObject`.

    See Also
    --------
    Estimator : conventional azimuthal-profile estimator.
    DEEstimator : global differential-evolution estimator.
    '''



    @abstractmethod
    def estimate(self, hologram: Hologram) -> Result:
        '''Estimate particle parameters from a normalized hologram.

        Parameters
        ----------
        hologram : Hologram
            Normalized hologram crop to analyze.

        Returns
        -------
        result : pandas.Series
            Estimated particle properties.
        '''