SL_MagnetometerData Struct Reference

Structure containing data from the magnetometer sensor. More...

Data Fields
bool	is_available
	Whether the magnetometer sensor is available in your camera.
uint64_t	timestamp_ns
	Data acquisition timestamp in nanoseconds.
struct SL_Vector3	magnetic_field_c
	Magnetic field local vector in microtesla (μT). More...
struct SL_Vector3	magnetic_field_unc
	Uncalibrated magnetic field local vector in microtesla (μT). More...
float	magnetic_heading
	Camera heading in degrees relative to the magnetic North Pole. More...
enum SL_HEADING_STATE	magnetic_heading_state
	State of magnetic_heading.
float	magnetic_heading_accuracy
	Accuracy of magnetic_heading measure in the range [0.0, 1.0]. More...
float	effective_rate
	Realtime data acquisition rate in hertz (Hz).

Detailed Description

Structure containing data from the magnetometer sensor.

Field Documentation

magnetic_field_c

struct SL_Vector3 SL_MagnetometerData::magnetic_field_c

Magnetic field local vector in microtesla (μT).

Note

To calibrate the magnetometer sensor, please use ZED Sensor Viewer tool after placing the camera in the final operating environment.

magnetic_field_unc

struct SL_Vector3 SL_MagnetometerData::magnetic_field_unc

Uncalibrated magnetic field local vector in microtesla (μT).

Note

The magnetometer raw values are affected by soft and hard iron interferences.

The sensor must be calibrated by placing the camera in the working environment and using ZED Sensor Viewer tool.

Not available in SVO or STREAM mode.

magnetic_heading

float SL_MagnetometerData::magnetic_heading

Camera heading in degrees relative to the magnetic North Pole.

Note

The magnetic North Pole has an offset with respect to the geographic North Pole, depending on the geographic position of the camera.

To get a correct magnetic heading, the magnetometer sensor must be calibrated using ZED Sensor Viewer tool.

magnetic_heading_accuracy

float SL_MagnetometerData::magnetic_heading_accuracy

Accuracy of magnetic_heading measure in the range [0.0, 1.0].

Note

A negative value means that the magnetometer must be calibrated using ZED Sensor Viewer tool.