Python (Windows)
This topic introduces how to obtain and run the Mech-Eye API Python samples on Windows.
Sample List
Samples are divided into the following categories: basic, advanced, and util.
-
basic samples: Connect and acquire data.
-
advanced samples: Acquire data in more complicated manners and set model-specific parameters.
-
util samples: Obtain camera information and set common parameters.
The samples in each category and their descriptions are provided below.
basic
-
connect_to_camera: Connect to a camera.
-
connect_and_capture_images: Connect to a camera and obtain the 2D image, depth map, and point cloud data.
-
capture_2d_image: Obtain and save the 2D image.
-
capture_depth_map: Obtain and save the depth map.
-
capture_point_cloud: Obtain and save the untextured and textured point clouds.
-
capture_point_cloud_hdr: Set multiple exposure times, and then obtain and save the point cloud.
-
capture_point_cloud_with_normals: Calculate normals and save the point cloud with normals.
advanced
-
convert_depth_map_to_point_cloud: Generate a point cloud from the depth map and save the point cloud.
-
multiple_cameras_capture_sequentially: Obtain and save 2D images, depth maps, and point clouds sequentially from multiple cameras.
-
multiple_cameras_capture_simultaneously: Obtain and save 2D images, depth maps, and point clouds simultaneously from multiple cameras.
-
capture_periodically: Obtain and save 2D images, depth maps, and point clouds periodically for the specified duration from a camera.
-
mapping_2d_image_to_depth_map: Generate untextured and textured point clouds from a masked 2D image and a depth map.
-
set_parameters_of_laser_cameras: Set the parameters specific to laser cameras (the DEEP and LSR series).
-
set_parameters_of_uhp_cameras: Set the parameters specific to the UHP series.
-
register_camera_event: Define and register the callback function for monitoring the camera connection status.
-
capture_stereo_2d_images: Obtain the 2D images from both 2D cameras of Deep (V3), Laser L Enhanced (V3), PRO XS (V4), LSR L (V4), LSR S (V4), and DEEP (V4).
util
-
get_camera_intrinsics: Obtain and print the camera intrinsic parameters.
-
print_camera_info: Obtain and print the camera information, such as model, serial number, firmware version, and temperatures.
-
set_scanning_parameters: Set the parameters in the 3D Parameters, 2D Parameters, and ROI categories.
-
set_depth_range: Set the Depth Range parameter.
-
set_point_cloud_processing_parameters: Set the Point Cloud Processing parameters.
-
manage_user_sets: Manage parameter groups, such as obtaining the names of all parameter groups, adding a parameter group, switching the parameter group, and saving parameter settings to the parameter group.
-
save_and_load_user_set: Import and replace all parameter groups from a JSON file, and save all parameter groups to a JSON file.
Prerequisites
In order to use the Python samples of Mech-Eye API, the following prerequisites must be satisfied:
-
Make sure that the variant of Python installed is 64-bit, and that the version is between 3.7 and 3.11.
If Add Python to PATH was not selected during installation, please add the following two paths to the Path environment variable:
-
xxx/AppData/LocalProgramsPython/Python36/
-
xxx/AppData/LocalProgramsPython/Python36/Scripts/
-
-
Obtain the samples.
-
Install the required software.
-
(Optional) Install software libraries on which the samples depend.
Obtain Samples
Python samples are included in the installation path of Mech-Eye SDK or can be obtained from GitHub by cloning. The samples in the installation path are the version at the time of Mech-Eye SDK release. The version on GitHub may contain the latest changes.
-
The samples in the installation path are located in xxx/Mech-Eye SDK-2.2.2/API/samples/python/area_scan_3d_camera.
-
The samples cloned from GitHub are located in xxx/mecheye_python_samples/area_scan_3d_camera.
Install Required Software
In order to use the Python samples of Mech-Eye API, Mech-Eye SDK and Python Mech-Eye API must be installed.
Install the Latest Version of Mech-Eye SDK
Please install or upgrade Mech-Eye SDK according to Mech-Eye SDK Installation Guide.
Install the Latest Version of Python Mech-Eye API
Follow these steps to install the latest version of Python Mech-Eye API:
-
Press Win + R on the keyboard to open Run box. Type “PowerShell” and then press Ctrl+Shift+Enter to run PowerShell as Administrator.
-
Execute the following command to install Python Mech-Eye API:
pip install MechEyeAPI
(Optional) Install Dependent Software Libraries
Some samples contain functions that depend on OpenCV. If you need to use the samples listed in the table below, OpenCV must be installed (latest version recommended).
-
capture_2d_image
-
capture_depth_map
-
capture_periodically
-
capture_stereo_2d_images
-
multiple_cameras_capture_sequentially
-
multiple_cameras_capture_simultaneously
Execute the following command to install the latest version of OpenCV:
pip install opencv-python
Run Samples
The paths provided in this section correspond to the samples included in the installation path. If you are using the samples cloned from GitHub, please modify the paths correspondingly. |
Follow these steps to run the samples:
-
Navigate to the folder where a sample is located. Replace category with the category name of the sample.
cd xxx/Mech-Eye SDK-2.2.2/API/samples/python/area_scan_3d_camera/category
-
Run the sample: replace sample_name with the name of the sample. While the sample is running, input the index of the camera to which you want to connect according to the instruction, and press Enter to connect to the camera.
python sample_name.py
-
If image and/or point cloud files are saved by the sample, you can find the files in the folder where the sample is located.