Source code for pylorenzmie.utilities.example_hologram

from pathlib import Path
from pylorenzmie.analysis.Hologram import Hologram


_TUTORIALS = Path(__file__).parent.parent / 'docs' / 'tutorials'




def example_hologram(name: str = 'crop.png') -> Hologram:
    '''Return a normalized example hologram.

    Loads an image from the package's tutorials directory and returns
    it as a :class:`~pylorenzmie.analysis.Hologram`.

    Parameters
    ----------
    name : str, optional
        Filename of the image in ``docs/tutorials/``.
        Default: ``'crop.png'``.

    Returns
    -------
    hologram : Hologram
        Hologram intensity divided by the background level (100 counts),
        shape ``(height, width)``, dtype ``float64``.
    '''
    import cv2
    data = cv2.imread(str(_TUTORIALS / name),
                      cv2.IMREAD_GRAYSCALE).astype(float) / 100.
    return Hologram(data)