Getting started

Installation

To install bmlab, use one of the following methods:

• from PyPI:

  pip install bmlab

• from sources:

  pip install .

Basic usage

import pathlib

from bmlab.controllers import Controller
from bmlab.models import Orientation
from bmlab.models.setup import AVAILABLE_SETUPS

filepath = pathlib.Path(__file__).parent.parent / 'tests' / 'data' / 'Water.h5'
setup = AVAILABLE_SETUPS[0]
orientation = Orientation(rotation=1, reflection={
        'vertically': False, 'horizontally': False
    })

# Frequency ranges to evaluate in Hz
brillouin_regions = [(4.0e9, 6.0e9), (9.0e9, 11.0e9)]
rayleigh_regions = [(-2.0e9, 2.0e9), (13.0e9, 17.0e9)]

# This condition is necessary due to
# bmlab using multiprocessing!
if __name__ == '__main__':
    session = Controller().evaluate(
        filepath,
        setup,
        orientation,
        brillouin_regions,
        rayleigh_regions
    )
    session.save()

Citing bmlab

If you use bmlab in a scientific publication, please cite it with:

bmlab developers (2022), bmlab version X.X.X: Python library for the post-measurement analysis of Brillouin microscopy data sets [Software]. Available at https://github.com/BrillouinMicroscopy/bmlab.