Core Module

Classes

struct  Matrix3x3
 Structure representing a generic 3*3 matrix. More...
 
struct  Resolution
 Structure containing the width and height of an image. More...
 
struct  CameraConfiguration
 Structure containing information about the camera sensor. More...
 
struct  CameraInformation
 Structure containing information of a single camera (serial number, model, input type, etc.) More...
 
struct  ImuData
 Structure containing data from the IMU sensor. More...
 
struct  BarometerData
 Structure containing data from the barometer sensor. More...
 
struct  MagnetometerData
 Structure containing data from the magnetometer sensor. More...
 
struct  TemperatureSensorData
 Structure containing data from the temperature sensors. More...
 
struct  SensorsData
 Structure containing all sensors data (except image sensors) to be used for positional tracking or environment study. More...
 
struct  SensorParameters
 Structure containing information about a single sensor available in the current device. More...
 
struct  SensorsConfiguration
 Structure containing information about all the sensors available in the current device. More...
 
class  Mat
 Class representing 1 to 4-channel matrix of float or uchar, stored on CPU and/or GPU side. More...
 

Enumerations

enum class  ERROR_CODE
 List of error codes in the ZED SDK. More...
 
enum class  COORDINATE_SYSTEM
 Lists available coordinates systems for positional tracking and 3D measures. More...
 
enum class  SENSOR_TYPE
 Lists available sensor types. More...
 
enum class  SENSORS_UNIT
 Lists available measurement units of onboard sensors. More...
 
enum class  UNIT
 Lists available units for measures. More...
 
enum class  MAT_TYPE
 Lists available sl.Mat formats. More...
 
enum class  COPY_TYPE
 Lists available copy operation on sl.Mat. More...
 
enum class  MEM
 Lists available memory type. More...
 

Enumeration Type Documentation

◆ ERROR_CODE

enum ERROR_CODE
strong

List of error codes in the ZED SDK.

Note
For more info, read about the ZED SDK C++ enum it mirrors: ERROR_CODE
Enumerator
SENSOR_CONFIGURATION_CHANGED 

The sensor's configuration (mode, multicast, etc.) was changed externally while streaming. If auto_recovery_on_config_change is enabled, the SDK will automatically reconnect. This warning code is returned once after successful recovery.

POTENTIAL_CALIBRATION_ISSUE 

The camera has a potential calibration issue.

CONFIGURATION_FALLBACK 

The operation could not proceed with the target configuration but did success with a fallback.

SENSORS_DATA_REQUIRED 

The input data does not contains the high frequency sensors data, this is usually because it requires newer SVO/Streaming. In order to work this modules needs inertial data present in it input.

CORRUPTED_FRAME 

The image is corrupted with invalid colors (green/purple images). This indicates a serious hardware or driver issue.

CAMERA_REBOOTING 

The camera is currently rebooting.

SUCCESS 

Standard code for successful behavior.

FAILURE 

Standard code for unsuccessful behavior.

NO_GPU_COMPATIBLE 

No GPU found or CUDA capability of the device is not supported.

NOT_ENOUGH_GPUMEM 

Not enough GPU memory for this depth mode. Try a different mode (such as PERFORMANCE), or increase the minimum depth value (see InitParameters.depthMinimumDistance).

CAMERA_NOT_DETECTED 

No camera was detected.

SENSORS_NOT_INITIALIZED 

The MCU that controls the sensors module has an invalid serial number. You can try to recover it by launching the ZED Diagnostic tool from the command line with the option

-r.

SENSOR_NOT_DETECTED 

A camera with sensor is detected but the sensors (IMU, barometer, ...) cannot be opened. Only the MODEL.ZED does not has sensors. Unplug/replug is required.

INVALID_RESOLUTION 

In case of invalid resolution parameter, such as an upsize beyond the original image size in Camera.RetrieveImage.

LOW_USB_BANDWIDTH 

Insufficient bandwidth for the correct use of the camera. This issue can occur when you use multiple cameras or a USB 2.0 port.

CALIBRATION_FILE_NOT_AVAILABLE 

The calibration file of the camera is not found on the host machine. Use ZED Explorer or ZED Calibration to download the factory calibration file.

INVALID_CALIBRATION_FILE 

The calibration file is not valid. Try to download the factory calibration file or recalibrate your camera using ZED Calibration.

INVALID_SVO_FILE 

The provided SVO file is not valid.

SVO_RECORDING_ERROR 

An error occurred while trying to record an SVO (not enough free storage, invalid file, ...).

SVO_UNSUPPORTED_COMPRESSION 

An SVO related error, occurs when NVIDIA based compression cannot be loaded.

END_OF_SVO_FILE_REACHED 

SVO end of file has been reached.
No frame will be available until the SVO position is reset.

INVALID_COORDINATE_SYSTEM 

The requested coordinate system is not available.

INVALID_FIRMWARE 

The firmware of the camera is out of date. Update to the latest version.

INVALID_FUNCTION_PARAMETERS 

Invalid parameters have been given for the function.

CUDA_ERROR 

A CUDA error has been detected in the process, in Camera.Grab() or Camera.RetrieveXXX() only. Activate wrapperVerbose in ZEDManager.cs for more info.

CAMERA_NOT_INITIALIZED 

The ZED SDK is not initialized. Probably a missing call to Camera.Open().

NVIDIA_DRIVER_OUT_OF_DATE 

Your NVIDIA driver is too old and not compatible with your current CUDA version.

INVALID_FUNCTION_CALL 

The call of the function is not valid in the current context. Could be a missing call of Camera.Open().

CORRUPTED_SDK_INSTALLATION 

The ZED SDK was not able to load its dependencies or some assets are missing. Reinstall the ZED SDK or check for missing dependencies (cuDNN, TensorRT).

INCOMPATIBLE_SDK_VERSION 

The installed ZED SDK is incompatible with the one used to compile the program.

INVALID_AREA_FILE 

The given area file does not exist. Check the path.

INCOMPATIBLE_AREA_FILE 

The area file does not contain enough data to be used or the DEPTH_MODE used during the creation of the area file is different from the one currently set.

CAMERA_FAILED_TO_SETUP 

Failed to open the camera at the proper resolution. Try another resolution or make sure that the UVC driver is properly installed.

CAMERA_DETECTION_ISSUE 

Your camera can not be opened. Try replugging it to another port or flipping the USB-C connector (if there is one).

CAMERA_ALREADY_IN_USE 

Cannot start the camera stream. Make sure your camera is not already used by another process or blocked by firewall or antivirus.

NO_GPU_DETECTED 

No GPU found. CUDA is unable to list it. Can be a driver/reboot issue.

PLANE_NOT_FOUND 

Plane not found. Either no plane is detected in the scene, at the location or corresponding to the floor, or the floor plane doesn't match the prior given.

MODULE_NOT_COMPATIBLE_WITH_CAMERA 

The module you try to use is not compatible with your camera MODEL.

Note
MODEL.ZED does not has an IMU and does not support the AI modules.
MOTION_SENSORS_REQUIRED 

The module needs the sensors to be enabled (see InitParameters.sensorsRequired).

MODULE_NOT_COMPATIBLE_WITH_CUDA_VERSION 

The module needs a newer version of CUDA.

DRIVER_FAILURE 

The drivers initialization has failed. When using gmsl cameras, try restarting with sudo systemctl restart zed_x_daemon.service

◆ COORDINATE_SYSTEM

enum COORDINATE_SYSTEM
strong

Lists available coordinates systems for positional tracking and 3D measures.

Enumerator
IMAGE 

Standard coordinates system in computer vision.
Used in OpenCV: see here.

LEFT_HANDED_Y_UP 

Left-handed with Y up and Z forward.
Used in Unity3D with DirectX

RIGHT_HANDED_Y_UP 

Right-handed with Y pointing up and Z backward.
Used in OpenGL.

RIGHT_HANDED_Z_UP 

Right-handed with Z pointing up and Y forward.
Used in 3DSMax.

LEFT_HANDED_Z_UP 

Left-handed with Z axis pointing up and X forward
Used in Unreal Engine.

RIGHT_HANDED_Z_UP_X_FWD 

Right-handed with Z pointing up and X forward.
Used in ROS (REP 103)

◆ SENSOR_TYPE

enum SENSOR_TYPE
strong

Lists available sensor types.

Note
Sensors are not available on sl.MODEL.ZED.
Enumerator
ACCELEROMETER 

Three-axis accelerometer sensor to measure the inertial accelerations.

GYROSCOPE 

Three-axis gyroscope sensor to measure the angular velocities.

MAGNETOMETER 

Three-axis magnetometer sensor to measure the orientation of the device with respect to the Earth's magnetic field.

BAROMETER 

Barometer sensor to measure the atmospheric pressure.

◆ SENSORS_UNIT

enum SENSORS_UNIT
strong

Lists available measurement units of onboard sensors.

Note
Sensors are not available on sl.MODEL.ZED.
Enumerator
M_SEC_2 

m/s² (acceleration)

DEG_SEC 

deg/s (angular velocity)

U_T 

μT (magnetic field)

HPA 

hPa (atmospheric pressure)

CELSIUS 

°C (temperature)

HERTZ 

Hz (frequency)

◆ UNIT

enum UNIT
strong

Lists available units for measures.

Enumerator
MILLIMETER 

International System (1/1000 meters)

CENTIMETER 

International System (1/100 meters)

METER 

International System (1 meter)

INCH 

Imperial Unit (1/12 foot)

FOOT 

Imperial Unit (1 feet)

◆ MAT_TYPE

enum MAT_TYPE
strong

Lists available sl.Mat formats.

Note
sl.Mat type depends on image or measure type.
For the dependencies, see sl.VIEW and sl.MEASURE.
Enumerator
MAT_32F_C1 

1-channel matrix of float

MAT_32F_C2 

2-channel matrix of float

MAT_32F_C3 

3-channel matrix of float

MAT_32F_C4 

4-channel matrix of float

MAT_8U_C1 

1-channel matrix of unsigned char

MAT_8U_C2 

2-channel matrix of unsigned char

MAT_8U_C3 

3-channel matrix of unsigned char

MAT_8U_C4 

4-channel matrix of unsigned char

MAT_16U_C1 

1-channel matrix of unsigned short

MAT_S8_C4 

4-channel matrix of signed char

◆ COPY_TYPE

enum COPY_TYPE
strong

Lists available copy operation on sl.Mat.

Enumerator
CPU_CPU 

Copy data from CPU to CPU.

CPU_GPU 

Copy data from CPU to GPU.

GPU_GPU 

Copy data from GPU to GPU.

GPU_CPU 

Copy data from GPU to CPU.

◆ MEM

enum MEM
strong

Lists available memory type.

Enumerator
CPU 

Data will be stored on the CPU (processor side).

GPU 

Data will be stored on the GPU (graphic card side).

BOTH 

Data will be stored on both the CPU and GPU