MagnetometerData Struct Reference

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

Attributes

bool available
 Whether the magnetometer sensor is available in your camera. More...
 
ulong timestamp
 Data acquisition timestamp in nanoseconds. More...
 
Vector3 magneticField
 Magnetic field local vector in microtesla (μT). More...
 
Vector3 magneticFieldUncalibrated
 Uncalibrated magnetic field local vector in microtesla (μT). More...
 
float magneticHeading
 Camera heading in degrees relative to the magnetic North Pole. More...
 
HEADING_STATE magnetic_heading_state
 State of magneticHeading. More...
 
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). More...
 

Detailed Description

Structure containing data from the magnetometer sensor.

Variables

◆ available

bool available

Whether the magnetometer sensor is available in your camera.

◆ timestamp

ulong timestamp

Data acquisition timestamp in nanoseconds.

◆ magneticField

Vector3 magneticField

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.

◆ magneticFieldUncalibrated

Vector3 magneticFieldUncalibrated

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.

◆ magneticHeading

float magneticHeading

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_state

HEADING_STATE magnetic_heading_state

State of magneticHeading.

◆ magnetic_heading_accuracy

float 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.

◆ effective_rate

float effective_rate

Realtime data acquisition rate in hertz (Hz).