--- a/qtmobility/src/sensors/qmagnetometer.cpp Fri May 14 16:41:33 2010 +0300
+++ b/qtmobility/src/sensors/qmagnetometer.cpp Thu May 27 13:42:11 2010 +0300
@@ -50,7 +50,6 @@
\class QMagnetometerReading
\ingroup sensors_reading
- \preliminary
\brief The QMagnetometerReading class represents one reading from the
magnetometer.
@@ -58,25 +57,7 @@
The magnetometer returns magnetic flux density values along 3 axes.
The scale of the values is teslas. The axes are arranged as follows.
-\code
- +z
- |
- | +y
- | /
- |----/----
- /| NOKIA /|
- //|--/--- / |
- // | / // /
- // |/ // /
- // '--------------- +x
- // // /
- // // /
- /---------/ /
- / O / /
- / / /
- ---------- /
- |_________!/
-\endcode
+ \image sensors-coordinates2.jpg
The magnetometer can report on either raw magnetic flux values or geomagnetic flux values.
By default it returns raw magnetic flux values. The QMagnetometer::returnGeoValues property
@@ -87,6 +68,11 @@
represent only the effect of the Earth's magnetic field. This process is not perfect
and the accuracy of each reading may change.
+ The image below shows the difference between geomagnetic (on the left) and raw (on the right)
+ readings for a phone that is being subjected to magnetic interference.
+
+ \image sensors-geo-vs-raw-magnetism.jpg
+
The accuracy of each reading is measured as a number from 0 to 1.
A value of 1 is the highest level that the device can support and 0 is
the worst.
@@ -185,7 +171,6 @@
\class QMagnetometerFilter
\ingroup sensors_filter
- \preliminary
\brief The QMagnetometerFilter class is a convenience wrapper around QSensorFilter.
The only difference is that the filter() method features a pointer to QMagnetometerReading
@@ -206,7 +191,6 @@
\class QMagnetometer
\ingroup sensors_type
- \preliminary
\brief The QMagnetometer class is a convenience wrapper around QSensor.
The only behavioural difference is that this class sets the type properly.