MagnetometerData Class Reference

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

Functions
bool	is_available (self)
	Whether the magnetometer sensor is available in your camera.
float	effective_rate (self)
	Realtime data acquisition rate in hertz (Hz).
float	magnetic_heading (self)
	Camera heading in degrees relative to the magnetic North Pole. More...
float	magnetic_heading_accuracy (self)
	Accuracy of magnetic_heading measure in the range [0.0, 1.0]. More...
HEADING_STATE	magnetic_heading_state (self)
	State of magnetic_heading.
np.array[float]	get_magnetic_field_uncalibrated (self)
	Gets the uncalibrated magnetic field local vector in microtesla (μT). More...
np.array[float]	get_magnetic_field_calibrated (self)
	Gets the magnetic field local vector in microtesla (μT). More...
int	timestamp (self)
	Data acquisition timestamp.

Detailed Description

Class containing data from the magnetometer sensor.

Functions

magnetic_heading()

float magnetic_heading

(

self

)

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 magnetic_heading_accuracy

(

self

)

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.

get_magnetic_field_uncalibrated()

np.array[float] get_magnetic_field_uncalibrated

(

self

)

Gets the 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.

get_magnetic_field_calibrated()

np.array[float] get_magnetic_field_calibrated

(

self

)

Gets the 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.