Functional Hierarchy of Classes

You are viewing an old version of the documentation. You can switch to the documentation of the latest version by clicking the top-right corner of the page.

This topic introduces the functional hierarchy of the classes in Mech-Eye API. In the following figure, the classes higher up in the hierarchy provide methods for accessing the objects of the lower classes. Therefore, the higher classes should be instantiated earlier in the client application.

The following sections introduce the functions of each class in the above figure.

Camera

The Camera class represents a camera. It is the highest class in the functional hierarchy in Mech-Eye API. In the client application, this class should be instantiated first. Through the Camera class, you can access the objects of other classes.

The methods provided by the Camera class mainly include:

Discover cameras
Connect to a camera
Acquire data
Obtain the camera information
Access the objects of the UserSetManager and UserSet classes

Frame2D

The Frame2D class is used to store the 2D data. Using the data in this class, you can generate the 2D image.

Frame3D

The Frame3D class is used to store the 3D data. Using the data in this class, you can generate the depth map and untextured point cloud.

Frame2DAnd3D

The Frame2DAnd3D class is used to store the 2D and 3D data together. Using the data in this class, you can generate the 2D image, depth map, and textured point cloud.

UserSetManager

The UserSetManager class provides methods for managing parameter groups, which mainly include:

Check all available parameter groups
Select a parameter group
Create a parameter group
Delete a parameter group
Import parameter groups
Export parameter groups
Access the object of the UserSet class

UserSet

The UserSet class represents a parameter group and provides methods relevant to the currently selected parameter group. These methods mainly include:

Obtain all parameters in the current parameter group
Reset the current parameter group
Save parameters to the current parameter group
Obtain parameter information
Obtain and adjust parameter values
Rename the current parameter group

Parameter

The Parameter class represents a single parameter and provides methods relevant to individual parameters. These methods mainly include:

Obtain parameter information (including parameter name, parameter description, data type, maximum value, minimum value, minimum increment, read and write permissions, etc.)
Obtain and adjust parameter values

CameraInfo, etc.

The following classes are used to store the information and properties of the camera:

CameraInfo: model, serial number, hardware and firmware versions, IP configurations, and more
CameraStatus: the temperatures of the camera projector and CPU
CameraResolutions: the resolutions of the 2D image and depth map
CameraIntrinsics: camera intrinsic parameters

CameraEvent

The CameraEvent class provides methods for detecting events related to the camera. Currently, camera disconnection events can be detected.

This topic introduced the functional hierarchy of the classes in Mech-Eye API. The next topic will introduce the basic workflow of using Mech-Eye API to control a camera.