Contains Magnetometer sensor data. More...

Types
enum class	HEADING_STATE

Attributes
bool	is_available

sl::Timestamp	timestamp

sl::float3	magnetic_field_uncalibrated

sl::float3	magnetic_field_calibrated

float	magnetic_heading

HEADING_STATE	magnetic_heading_state

float	magnetic_heading_accuracy

float	effective_rate

Detailed Description

Contains Magnetometer sensor data.

Enumeration

◆ HEADING_STATE

enum HEADING_STATE

strong

Enumerator
GOOD	The heading is reliable and not affected by iron interferences.
OK	The heading is reliable, but affected by slight iron interferences.
NOT_GOOD	The heading is not reliable because affected by strong iron interferences.
NOT_CALIBRATED	The magnetometer has not been calibrated.
MAG_NOT_AVAILABLE	The magnetomer sensor is not available.

Variables

◆ is_available

bool is_available

Defines if the sensor is available in your camera.

◆ timestamp

sl::Timestamp timestamp

Defines the sensors data timestamp

◆ magnetic_field_uncalibrated

sl::float3 magnetic_field_uncalibrated

(3x1) Vector for magnetometer raw values (uncalibrated) In other words, the current magnetic field (uT), along with the x, y, and z axes.

Note: The magnetometer raw values are affected by soft and hard iron interferences. The sensor must be calibrated, placing the camera in the working environment, using the ZED Sensor Viewer tool.; Not available in SVO or Stream mode.

◆ magnetic_field_calibrated

sl::float3 magnetic_field_calibrated

(3x1) Vector for magnetometer values (after user calibration) In other words, the current calibrated and normalized magnetic field (uT), along with the x, y, and z axes.

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

◆ magnetic_heading

float magnetic_heading

The 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 the ZED Sensor Viewer tool

◆ magnetic_heading_state

HEADING_STATE magnetic_heading_state

The state of the /ref magnetic_heading value

◆ magnetic_heading_accuracy

float magnetic_heading_accuracy

The accuracy of the magnetic heading measure in the range [0.0,1.0].

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

◆ effective_rate

float effective_rate

Realtime data acquisition rate [Hz]

Types

Attributes