Metadata-Version: 2.1
Name: BeamDelta
Version: 1.0.0
Summary: A software tool to improve microscope alignment
Home-page: https://github.com/MicronOxford/BeamDelta
Author: See homepage for a complete list of contributors
Author-email: 
License: UNKNOWN
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: PyQt5
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: microscope

# BeamDelta
Alignment tool

Copyright Nicholas Hall, David Pinto, Ian Dobbie (2019)

A simple GUI interface for python-microscope which allows a compatible camera 
(see python-microscope compatibility list) to be used for optical alignment purposes.
The Gui will display live images, calculate and mark beam centroids and then store
an alignment centroid position. Once a position is stored the live centroid then 
displays a pixel based delta position to allow precise alignment between the marked
position and the new beam. 

Called from the command line using the following format:

"BeamDeltaUI [exposure_time] [camera_1_uri] [camera_2_uri]"

"exposure_time" has a default value of 150 ms and can be set bu adding the flag --exposure-time. 
The camera URIs have the following format:

"PYRO:[microscope_device_name]@[ip_address]:[port]"

Suggested uses:

Centering lenses within an optical setup.
1) align the system with no lenses present using a laser or similar well collimated
beam.
2) position camera in beam.
3) mark centroid.
4) add first lens and check centroid.
5) shift lens in X and Y (perpendicular to optic axis) to align centroids.
6) check for back reflection to ensure the lens is perpendicular to optic axis
7) repeat 5 & 6 until no change.

Co-aligning two beams
1) start with one correctly aligned beam.
2) construct a dual camera setup (description needed!)
3) mark centroids on both cameras.
4) turn of first beam, turn on second beam
5) use two mirrors to walk the beam (description needed) so it matches both centroids.

Required Python version: Python 3.6.3

Required Python packages: sys, argparse, PyQt5, numpy, skimage, scipy and microscope

