From 5ce5522bdfb1e2466675a5e3068c41544921e833 Mon Sep 17 00:00:00 2001 From: Jianshun Gao Date: Fri, 22 Jul 2022 16:35:54 +0200 Subject: [PATCH] Update 'Absorption Imaging Class' --- Absorption-Imaging-Class.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/Absorption-Imaging-Class.md b/Absorption-Imaging-Class.md index de6b565..afea518 100644 --- a/Absorption-Imaging-Class.md +++ b/Absorption-Imaging-Class.md @@ -17,6 +17,8 @@ The path of those three standard pictures should be "camera_orientation\camera_l Just for get the absorption imaging, it doesn't require any information about camera and transition. But any further calculation, it has to call "transition" and "camera" +\_\_enter\_\_ and \_\_exit\_\_ functions is defined. But be careful, \_\_enter\_\_ function will calculate the atom number. + ### Parameters: * **data_path** *(unknown, necessary)*: The path of hdf5 file provided by lyse moduel in LabScript. * **camera_orientation** *(string, necessary)*: Name of the camare group in hdf5 file. @@ -24,4 +26,21 @@ Just for get the absorption imaging, it doesn't require any information about ca * **transition** *(objet of class dylab.TransitionClass.Transition, optional)*: A constant dictionary class storing the information of transition. * **camera** *(object of class dylab.Camera.\*, optional)*: A constant dictionary class storing the information of camera. * **detuning** *(float, optional)*: Detuning of the laser beam. -* **Intensity** *(float, optional)*: Laser beam intensity at the position of atom cloud! \ No newline at end of file +* **Intensity** *(float, optional)*: Laser beam intensity at the position of atom cloud! + +## absorption_imaging.set_image_name() +> dylab.absorption_imaging.set_image_name(image, name): + +It can set the searching name of those three satandard images. The defualt names are "atoms", "background" and "dark". + +### Parameters: +* **image** *(string, necessary)*: The contents of dictionary storing the name of those three images. It has to be one of "atoms", "background" and "dark". +* **name** *(string, necessary)*: The new searching name. + +### Return +* Nothing + +## absorption_imaging.get_image_absorption +> dylab.absorption_imaging.get_image_absorption(): + +It will calculate the absorption imaging, integrating in \_\_enter\_\_ function