MagnetometerData Class Reference

Contains magnetometer sensor data. More...

Functions
def	is_available (self)
	Defines if the sensor is available.
def	effective_rate (self)
	Realtime data acquisition rate [Hz].
def	magnetic_heading (self)
	The camera heading in degrees relative to the magnetic North Pole. More...
def	magnetic_heading_accuracy (self)
	The accuracy of the magnetic heading measure in the range [0.0,1.0]. More...
def	magnetic_heading_state (self)
	The state of the magnetic_heading value.
def	get_magnetic_field_uncalibrated (self)
	(3x1) Vector for magnetometer raw values (uncalibrated). More...
def	get_magnetic_field_calibrated (self)
	(3x1) Vector for magnetometer values (after user calibration). More...
def	timestamp (self)
	Defines the sensors data timestamp.

Detailed Description

Contains magnetometer sensor data.

Functions

magnetic_heading()

def magnetic_heading

(

self

)

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_accuracy()

def magnetic_heading_accuracy

(

self

)

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

get_magnetic_field_uncalibrated()

def get_magnetic_field_uncalibrated

(

self

)

(3x1) Vector for magnetometer raw values (uncalibrated).

In other words, the current magnetic field (uT), along with the x, y, and z axes.

Returns

the magnetic field array

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.

get_magnetic_field_calibrated()

def get_magnetic_field_calibrated

(

self

)

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

Returns

the magnetic field array

Note

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