Python Module¶

The following section documents the owl module API. This documentation is applicable to the owl module version 0.19.537.

owl.sys_info(*, force_all_modules=False)[source]¶

Collect relevant system and debugging information.

Returns:: system_information – Version information of many packages, optional and required, to run owl.
Return type:: dictionary

Example

>>> owl.sys_info()
{'python': '3.8.5 | packaged by conda-forge | (default, Sep 27 2020, 15:56:17) \n[GCC 7.5.0]',
 'owl': '0.15.18',
 'sys.executable': '/home/ramona/falcongui/bin/python',
 'sys.exec_prefix': '/home/mark/falcongui',
 'platform.node': 'falcon',
 'mcam_sdk': 'is not installed',
 'pyilluminate': '0.6.5',
 'teensytoany': '0.0.24',
 'opencv': '4.5.2',
 'numpy': '1.21.4',
 'scipy': '1.7.0',
 'imageio': '2.9.0',
 'scikit-image': '0.18.2',
 'xarray': '0.18.2',
 'dask': '2021.07.0',
 'vispy': '0.7.0',
 'tqdm': '4.61.2',
 'pillow': '8.3.1',
 'zaber-motion': '2.4.1',
 'ro_json': '3.15.5'}

Instrument control¶

When opened the MCAM class will contain up to 3 sub-devices:

A transmission illumination unit. This device can be accessed through the transmission_illumination attribute and is an object of the Illuminate class.
A reflection illumination unit. This device can be accessed through the reflection_illumination attribute and is an object of the Illuminate class.
A stage to control the height. This device can be accessed through the z_stage attribute and is an object of class X_LSM_E.

`instruments.MCAM`	The MCAM object.
`instruments.Illuminate`
`instruments.X_LSM_E`	Zaber Miniature Motorized linear stage with encoder and controller.
`instruments.MultiLidar`	Open a Ramona Optics Multi-Lidar ranging system.

Dataset manipulation¶

mcam_data

Stitching¶

Ramona Optics provides a stitching solution that utilizes the Hugin toolbox.

`stitch.hugin_stitching`	Stitch mcam images using hugin.
`stitch.hugin_global_transforms`	Create a homography matrix from the alingments in the given pto file.

Analysis & calibration¶

`analysis`
`color`
`calibration`

Visualization tools¶

The owl module provides the following visualization tools to explore the large datasets generated by the MCAM.

visualize

Graphical User Interface¶

The MCAM is shipped with a basic graphical user interface that enables one to interact with the basic features in an easy to use fashion.

Upon closing the interface, the last used settings are saved to the user’s directory. On Windows, (MCAM_OWL only) the directory location is:

C:\Users\<Username>\Application Data\Local Settings\ramonaoptics\mcam

and on linux, the configuration file is stored in:

~/.config/mcam