Add individual pages for attributes in documentation of Quaternion an…

…d DCM.
Mayitzin · Sep 29, 2021 · ace61cb · ace61cb
1 parent f21200b
commit ace61cb
Show file tree

Hide file tree

Showing 38 changed files with 281 additions and 12 deletions.
diff --git a/docs/source/classQuaternion.rst b/docs/source/classQuaternion.rst
diff --git a/docs/source/nomenclature.rst b/docs/source/nomenclature.rst
@@ -78,82 +78,145 @@ Abbreviations
 
 ======  =========
 AACGM   Altitude-Adjusted Corrected Geomagnetic Coordinates
+ACARE   Advisory Council for Aeronautics Research in Europe
+ACAS    Airborne Collision Avoidance System
+ACC     Adapttive Cruise Control
+Ack     Acknowledge
 ADC     Analog-to-Digital Converter
+ADCS    Active Directed Control System
+ADI     Attitude Director Indicator
+ADIRS   Air Data Inertial Reference System
+ADIRU   Air Data Inertial Reference Unit
 ADEV    Allan deviation
+AGNSSS  Assisted Global Navigation Satellite System
+AGPS    Assisted Global Positioning System
 AHRS    Attitude and Heading Reference System
 AoA     Angle of Arrival
 AoD     Angle of Departure
 AR      Angular Rate
+asl     above sea level
 atan    Arctangent
 atan2   Arctangent (four quadrants)
+AQUA    Algebraic Quaternion Algorithm
+AU      Astronomical Unit
 AUV     Autonomous Underwater Vehicle
 AVAR    Allan variance
+AVCS    Autonomous Vehicle Control System
+AVG     Autonomous Vehicle Guidance
+AVLS    Autonomous Vehicle Localization System
+AWGN    Additive White Gaussian Noise
+az      Azimuth
+B2B     Business to Business
 BIH     Bureau International de l'Heure
+BIIT    Built-in Integrity Test
+BLE     Bluetooth Low Energy
+BLUE    Best Linear Unbiased Estimate
 BPF     Band-Pass Filter
+CAS     Collision Avoidance System
 CD      Centered Dipole
+CDI     Course Deviation Indicator
 CGM     Corrected Geomagnetic Coordinates
+CIRAS   Coriolis Inertial Rate and Acceleration Sensor
 CIRS    Conventional Inertial Reference System
 CRS     Conventional Celestial Reference System
 CTP     Conventional Terrestrial Pole
 CTRS    Conventional Terrestrial Reference System
 DCM     Direction Cosine Matrix
+DGPS    Differential Global Positioning System
+DME     Distance Measuring Equipment
 DoD     Department of Defense
 DoF     Degrees of Freedom
 DR      Dead Reckoning
+ECDIS   Electronic Chart Display and Information Systems
 ECEF    Earth-Centered Earth-Fixed
 ECIF    Earth-Centered Inertial Frame
 EGM     Earth Gravitational Model
+EGNOS   European Geostationary Navigation Overlay Service
 EGNSS   Enhanced GNSS
 EKF     Extended Kalman Filter
 ENU     East-North-Up
 ESA     European Space Agency
 EU      European Union
+FAA     Federal Aviation Administration
+FMS     Flight Management System
+GAGAN   GPS and Geo Augmented Navigation
+GGF     Global Earth-fixed frame with one axis aligned with gravity
+GIS     Geographic Information System
 GNSS    Global Navigation Satellite System
 GPS     Global Positioning System
 GTRF    Galileo Terrestrial Reference Frame
 gyro    Gyroscope
 HP      High Performance
 HPF     High-Pass Filter
+IAG     International Association of Geodesy
+IATA    International Air Transport Association
 IAU     International Astronomical Union
 IC      Integrated Circuit
+ICAO    International Civil Aviation Organization
 IERS    International Earth Rotation and Reference Systems Service
+IFR     Instrument Flight Rules
 IGRF    International Geomagnetic Reference Field
+ILS     Instrument landing system
 IMU     Inertial Measurement Unit
 INS     Inertial Navigation System
 INU     Inertial Navigation Unit
-CIRAS   Coriolis Inertial Rate and Acceleration Sensor
 ITRF    International Terrestrial Reference Frame
+JPALS   Joint Precision Approach and Landing System
 KF      Kalman Filter
+LAAS    Local Area Augmentation System
 lat     Latitude
+LERP    Linear Interpolation
 LLF     Local-level Frame
+LNAV    Lateral Navigation
 lon     Longitude
+LORAN   Long-range radio navigation
 LPF     Low-Pass Filter
+LPV     Localizer Performance with Vertical Guidance
 MagCal  Magnetic Calibration
 MARG    Magnetism, Angular Rate, and Gravity
+MIMU    Magnetic and Inertial Measurement Unit
+MIS     Management information system
 MCU     Micro-Controller Unit
 MEMS    Micro-electromechanical Systems
+MLF     Marker-cluster Local Frame
+MLS     Microwave landing system
 MLT     Magnetic Local Time
-MOEMS   Micro-opto electromechanical Systems
+mocap   Motion Capture
+MOEMS   Micro-opto Electromechanical Systems
 MST     Microsystem Technology
 μC      Microcontroller
+NASA    National Aeronautics and Space Administration
+NDB     Non-directional beacon
 NED     North-East-Down
+NSE     Navigation System Error
+PBN     Performance-Based Navigation
+PDR     Pedestrian Dead Reckoning
 PF      Particle Filtering
 PIGA    Pendulous Integrating Gyroscopic Accelerometer
 QD      Quasi-Dipole
 QUEST   Quaternion Estimator
 RHR     Right-Hand Rule
+RNAV    Area Navigation
+SBAS    Satellite-Based Augmentation System
 SCI     Serial Communications Interface
 SI      Système International d'unités
 SLERP   Spherical Linear Interpolation
 SOA     Silicon Oscillating Accelerometer
 SVD     Singular Value Decomposition
+TACAN   Tactical Air Navigation System
+TAWS    Terrain Awareness and Warning System
 TFG     Turning Fork Gyroscope
+TLS     Transponder landing system
+TSE     Total System Error
 UART    Universal Asynchronous Receiver / Transmitter
 UAV     Unmanned Aerial Vehicle
 UKF     Unscented Kalman Filter
 UT      Universal Time
+VFR     Visual Flight Rules
+VNAV    Vertical Navigation
+VOR     Very High Frequency Omnidirectional Radio Range
+WAAS    Wide Area Augmentation System
 WGS     World Geodetic System
 WMM     World Magnetic Model
 ZUPT    Zero Velocity Update
 ======  =========
-
diff --git a/docs/source/quaternion/classQuaternion.rst b/docs/source/quaternion/classQuaternion.rst
@@ -0,0 +1,51 @@
+
+Class Quaternion
+================
+
+.. autoclass:: ahrs.common.quaternion.Quaternion
+
+**Attributes**
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 2
+
+   quaternion.w
+   quaternion.x
+   quaternion.y
+   quaternion.z
+   quaternion.v
+   quaternion.conjugate
+   quaternion.conj
+   quaternion.inverse
+   quaternion.inv
+   quaternion.exponential
+   quaternion.exp
+   quaternion.logarithm
+   quaternion.log
+
+**Methods**
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 2
+
+   quaternion.is_pure
+   quaternion.is_real
+   quaternion.is_versor
+   quaternion.is_identity
+   quaternion.normalize
+   quaternion.product
+   quaternion.mult_L
+   quaternion.mult_R
+   quaternion.rotate
+   quaternion.to_array
+   quaternion.to_list
+   quaternion.to_axang
+   quaternion.to_angles
+   quaternion.to_DCM
+   quaternion.from_DCM
+   quaternion.from_rpy
+   quaternion.from_angles
+   quaternion.ode
+   quaternion.random
diff --git a/docs/source/classQuaternionArray.rst → ...ource/quaternion/classQuaternionArray.rst b/docs/source/classQuaternionArray.rst → ...ource/quaternion/classQuaternionArray.rst
diff --git a/docs/source/quaternion/quaternion.conj.rst b/docs/source/quaternion/quaternion.conj.rst
@@ -0,0 +1,5 @@
+
+conj
+====
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.conj
diff --git a/docs/source/quaternion/quaternion.conjugate.rst b/docs/source/quaternion/quaternion.conjugate.rst
@@ -0,0 +1,5 @@
+
+conjugate
+=========
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.conjugate
diff --git a/docs/source/quaternion/quaternion.exp.rst b/docs/source/quaternion/quaternion.exp.rst
@@ -0,0 +1,5 @@
+
+exp
+===
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.exp
diff --git a/docs/source/quaternion/quaternion.exponential.rst b/docs/source/quaternion/quaternion.exponential.rst
@@ -0,0 +1,5 @@
+
+exponential
+===========
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.exponential
diff --git a/docs/source/quaternion/quaternion.from_DCM.rst b/docs/source/quaternion/quaternion.from_DCM.rst
@@ -0,0 +1,5 @@
+
+from_DCM
+========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.from_DCM
diff --git a/docs/source/quaternion/quaternion.from_angles.rst b/docs/source/quaternion/quaternion.from_angles.rst
@@ -0,0 +1,5 @@
+
+from_angles
+===========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.from_angles
diff --git a/docs/source/quaternion/quaternion.from_rpy.rst b/docs/source/quaternion/quaternion.from_rpy.rst
@@ -0,0 +1,5 @@
+
+from_rpy
+========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.from_rpy
diff --git a/docs/source/quaternion/quaternion.inv.rst b/docs/source/quaternion/quaternion.inv.rst
@@ -0,0 +1,5 @@
+
+inv
+===
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.inv
diff --git a/docs/source/quaternion/quaternion.inverse.rst b/docs/source/quaternion/quaternion.inverse.rst
@@ -0,0 +1,5 @@
+
+inverse
+=======
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.inverse
diff --git a/docs/source/quaternion/quaternion.is_identity.rst b/docs/source/quaternion/quaternion.is_identity.rst
@@ -0,0 +1,5 @@
+
+is_identity
+===========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.is_identity
diff --git a/docs/source/quaternion/quaternion.is_pure.rst b/docs/source/quaternion/quaternion.is_pure.rst
@@ -0,0 +1,5 @@
+
+is_pure
+=======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.is_pure
diff --git a/docs/source/quaternion/quaternion.is_real.rst b/docs/source/quaternion/quaternion.is_real.rst
@@ -0,0 +1,5 @@
+
+is_real
+=======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.is_real
diff --git a/docs/source/quaternion/quaternion.is_versor.rst b/docs/source/quaternion/quaternion.is_versor.rst
@@ -0,0 +1,5 @@
+
+is_versor
+=========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.is_versor
diff --git a/docs/source/quaternion/quaternion.log.rst b/docs/source/quaternion/quaternion.log.rst
@@ -0,0 +1,5 @@
+
+log
+===
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.log
diff --git a/docs/source/quaternion/quaternion.logarithm.rst b/docs/source/quaternion/quaternion.logarithm.rst
@@ -0,0 +1,5 @@
+
+logarithm
+=========
+
+.. autoattribute:: ahrs.common.quaternion.Quaternion.logarithm
diff --git a/docs/source/quaternion/quaternion.mult_L.rst b/docs/source/quaternion/quaternion.mult_L.rst
@@ -0,0 +1,5 @@
+
+mult_L
+======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.mult_L
diff --git a/docs/source/quaternion/quaternion.mult_R.rst b/docs/source/quaternion/quaternion.mult_R.rst
@@ -0,0 +1,5 @@
+
+mult_R
+======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.mult_R
diff --git a/docs/source/quaternion/quaternion.normalize.rst b/docs/source/quaternion/quaternion.normalize.rst
@@ -0,0 +1,5 @@
+
+normalize
+=========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.normalize
diff --git a/docs/source/quaternion/quaternion.ode.rst b/docs/source/quaternion/quaternion.ode.rst
@@ -0,0 +1,5 @@
+
+ode
+===
+
+.. automethod:: ahrs.common.quaternion.Quaternion.ode
diff --git a/docs/source/quaternion/quaternion.product.rst b/docs/source/quaternion/quaternion.product.rst
@@ -0,0 +1,5 @@
+
+product
+=======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.product
diff --git a/docs/source/quaternion/quaternion.random.rst b/docs/source/quaternion/quaternion.random.rst
@@ -0,0 +1,5 @@
+
+random
+======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.random
diff --git a/docs/source/quaternion/quaternion.rotate.rst b/docs/source/quaternion/quaternion.rotate.rst
@@ -0,0 +1,5 @@
+
+rotate
+======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.rotate
diff --git a/docs/source/quaternion.rst → docs/source/quaternion/quaternion.rst b/docs/source/quaternion.rst → docs/source/quaternion/quaternion.rst
diff --git a/docs/source/quaternion/quaternion.to_DCM.rst b/docs/source/quaternion/quaternion.to_DCM.rst
@@ -0,0 +1,5 @@
+
+to_DCM
+======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.to_DCM
diff --git a/docs/source/quaternion/quaternion.to_angles.rst b/docs/source/quaternion/quaternion.to_angles.rst
@@ -0,0 +1,5 @@
+
+to_angles
+=========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.to_angles
diff --git a/docs/source/quaternion/quaternion.to_array.rst b/docs/source/quaternion/quaternion.to_array.rst
@@ -0,0 +1,5 @@
+
+to_array
+========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.to_array
diff --git a/docs/source/quaternion/quaternion.to_axang.rst b/docs/source/quaternion/quaternion.to_axang.rst
@@ -0,0 +1,5 @@
+
+to_axang
+========
+
+.. automethod:: ahrs.common.quaternion.Quaternion.to_axang
diff --git a/docs/source/quaternion/quaternion.to_list.rst b/docs/source/quaternion/quaternion.to_list.rst
@@ -0,0 +1,5 @@
+
+to_list
+=======
+
+.. automethod:: ahrs.common.quaternion.Quaternion.to_list