Merge pull request #303 from jacobmcnamee/signal_t

Refactor signal_t to use a single enum for constellation and code

Author: jacobmcnamee

include/libswiftnav/signal.h

@@ -1,6 +1,7 @@
 /*
- * Copyright (c) 2015 Swift Navigation Inc.
+ * Copyright (c) 2016 Swift Navigation Inc.
  * Contact: Vlad Ungureanu <[email protected]>
+ *          Pasi Miettinen <[email protected]>
  *
  * This source is subject to the license found in the file 'LICENSE' which must
  * be be distributed together with this source. All other rights reserved.
@@ -15,68 +16,87 @@
 
 #include <libswiftnav/common.h>
 
+/** \addtogroup signal
+ * \{ */
+
+/* Number of satellites in each constellation. */
 #define NUM_SATS_GPS 32
 #define NUM_SATS_SBAS 19
 #define NUM_SATS (NUM_SATS_GPS + NUM_SATS_SBAS)
 
+/* Number of codes in each constellation. */
+#define NUM_CODES_GPS 2
+#define NUM_CODES_SBAS 1
+
+/* Number of signals in each code. */
+#define NUM_SIGNALS_GPS_L1CA NUM_SATS_GPS
+#define NUM_SIGNALS_GPS_L2CM NUM_SATS_GPS
+#define NUM_SIGNALS_SBAS_L1CA NUM_SATS_SBAS
+
+/* Number of signals in each constellation. */
+#define NUM_SIGNALS_GPS (NUM_SIGNALS_GPS_L1CA + NUM_SIGNALS_GPS_L2CM)
+#define NUM_SIGNALS_SBAS (NUM_SIGNALS_SBAS_L1CA)
+#define NUM_SIGNALS (NUM_SIGNALS_GPS + NUM_SIGNALS_SBAS)
+
+#define GPS_FIRST_PRN 1
+#define SBAS_FIRST_PRN 120
+
+#define SID_STR_LEN_MAX 16
+
+/** Constellation identifier. */
 enum constellation {
+  CONSTELLATION_INVALID = -1,
   CONSTELLATION_GPS,
   CONSTELLATION_SBAS,
   CONSTELLATION_COUNT,
 };
 
-enum band {
-  BAND_L1,
-  BAND_COUNT,
+/** Code identifier. */
+enum code {
+  CODE_INVALID = -1,
+  CODE_GPS_L1CA,
+  CODE_GPS_L2CM,
+  CODE_SBAS_L1CA,
+  CODE_COUNT,
 };
 
-#define GPS_FIRST_PRN 1
-#define SBAS_FIRST_PRN 120
-
-#define SID_STR_LEN_MAX 16
-
-typedef struct __attribute__((packed)) {
+/** GNSS signal identifier. */
+typedef struct {
   u16 sat;
-  u8 band;
-  u8 constellation;
+  enum code code;
 } gnss_signal_t;
 
+/** Signal comparison function. */
 static inline int sid_compare(const gnss_signal_t a, const gnss_signal_t b)
 {
   s32 x;
-  if ((x = a.constellation - b.constellation))
-    return x;
-  if ((x = a.band - b.band))
+  if ((x = a.code - b.code))
     return x;
   return a.sat - b.sat;
 }
 
+/** Untyped signal comparison function. */
 static inline int cmp_sid_sid(const void *a, const void *b)
 {
   return sid_compare(*(gnss_signal_t *)a, *(gnss_signal_t*)b);
 }
 
+/** Signal equality function. */
 static inline bool sid_is_equal(const gnss_signal_t a, const gnss_signal_t b)
 {
   return sid_compare(a, b) == 0;
 }
 
-/** Print a string representation of sid to the buffer s of capacity n.
- *  Returns the number of characters printed, excluding the terminating null.
- */
-int sid_to_string(char *s, int n, gnss_signal_t sid);
+/* \} */
 
-/** Returns true if sid corresponds to a known constellation, band, and
- *  satellite identifier.
- */
+gnss_signal_t construct_sid(enum code code, u16 sat);
+int sid_to_string(char *s, int n, gnss_signal_t sid);
 bool sid_valid(gnss_signal_t sid);
-
-/** Converts the global index i in [0, NUM_SATS) to the corresponding sid
- */
-gnss_signal_t sid_from_index(u32 i);
-
-/** Converts sid to a global index in [0, NUM_SATS)
- */
-u32 sid_to_index(gnss_signal_t sid);
+bool code_valid(enum code code);
+bool constellation_valid(enum constellation constellation);
+gnss_signal_t sid_from_code_index(enum code code, u16 code_index);
+u16 sid_to_code_index(gnss_signal_t sid);
+enum constellation sid_to_constellation(gnss_signal_t sid);
+enum constellation code_to_constellation(enum code code);
 
 #endif /* LIBSWIFTNAV_SIGNAL_H */

python/swiftnav/signal.pxd

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 Swift Navigation Inc.
+# Copyright (C) 2016 Swift Navigation Inc.
 #
 # This source is subject to the license found in the file 'LICENSE' which must
 # be be distributed together with this source. All other rights reserved.
@@ -11,32 +11,53 @@ from common cimport *
 from libcpp cimport bool
 
 cdef extern from "libswiftnav/signal.h":
-  enum:
-    GPS_L1_SATS
-    WAAS_SATS
-    EGNOS_SATS
-    GAGAN_SATS
-    MSAS_SATS
-    SDCM_SATS
-    SBAS_SATS
-    ALL_SATS
+  cdef enum constellation:
+    CONSTELLATION_INVALID = -1
     CONSTELLATION_GPS
     CONSTELLATION_SBAS
-    BAND_L1
+    CONSTELLATION_COUNT
+
+  cdef enum code:
+    CODE_INVALID = -1
+    CODE_GPS_L1CA
+    CODE_GPS_L2CM
+    CODE_SBAS_L1CA
+    CODE_COUNT
+
+  enum:
+    NUM_SATS_GPS
+    NUM_SATS_SBAS
+    NUM_SATS
+    NUM_CODES_GPS
+    NUM_CODES_SBAS
+    NUM_SIGNALS_GPS_L1CA
+    NUM_SIGNALS_GPS_L2CM
+    NUM_SIGNALS_SBAS_L1CA
+    NUM_SIGNALS_GPS
+    NUM_SIGNALS_SBAS
+    NUM_SIGNALS
+    GPS_FIRST_PRN
+    SBAS_FIRST_PRN
+    SID_STR_LEN_MAX
 
   ctypedef struct gnss_signal_t:
     u16 sat
-    u8 band
-    u8 constellation
+    code code
 
   int sid_compare(const gnss_signal_t a, const gnss_signal_t b)
   int cmp_sid_sid(const void *a, const void *b)
   bool sid_is_equal(const gnss_signal_t a, const gnss_signal_t b)
 
+  gnss_signal_t construct_sid(code code, u16 sat);
   int sid_to_string(char *s, int n, gnss_signal_t sid)
   bool sid_valid(gnss_signal_t sid)
-  gnss_signal_t sid_from_index(u32 i)
-  u32 sid_to_index(gnss_signal_t sid)
+  bool code_valid(code code)
+  bool constellation_valid(constellation constellation)
+
+  gnss_signal_t sid_from_code_index(code code, u16 code_index);
+  u16 sid_to_code_index(gnss_signal_t sid);
+  constellation sid_to_constellation(gnss_signal_t sid);
+  constellation code_to_constellation(code code);
 
 cdef class GNSSSignal:
   cdef gnss_signal_t _thisptr

python/swiftnav/signal.pyx

@@ -1,4 +1,4 @@
-# Copyright (C) 2015 Swift Navigation Inc.
+# Copyright (C) 2016 Swift Navigation Inc.
 #
 # This source is subject to the license found in the file 'LICENSE' which must
 # be be distributed together with this source. All other rights reserved.
@@ -39,18 +39,24 @@ cdef class GNSSSignal:
   def is_valid(self):
     return sid_valid(self._thisptr)
 
-  def to_index(self):
-    return sid_to_index(self._thisptr)
+  def to_code_index(self):
+    return sid_to_code_index(self._thisptr)
+
+  def from_code_index(self, code, code_index):
+    self._thisptr = sid_from_code_index(code, code_index)
+
+  def to_constellation(self):
+    return sid_to_constellation(self._thisptr)
 
   def to_string(self):
     cdef u8 n = 255
     cdef char s[255]
     cdef s8 length = sid_to_string(&s[0], n, self._thisptr)
     return s[:length].decode('UTF-8')
 
-def sid_from_index(i):
+def signal_from_code_index(code, code_index):
   sid = GNSSSignal()
-  sid._thispr = sid_from_index(i)
+  sid._thisptr = sid_from_code_index(code, code_index)
   return sid
 
 cdef mk_signal_array(py_signals, u8 n_c_signals, gnss_signal_t *c_signals):
@@ -77,3 +83,4 @@ cdef read_signal_array(u8 n_c_signals, gnss_signal_t *c_signals):
     sd_ = (<GNSSSignal> signal)._thisptr
     memcpy(&sd_, &c_signals[i], sizeof(gnss_signal_t))
   return py_signals
+

python/tests/test_almanac.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (C) 2015 Swift Navigation Inc.
+# Copyright (C) 2016 Swift Navigation Inc.
 # Contact: Bhaskar Mookerji <[email protected]>
 #
 # This source is subject to the license found in the file 'LICENSE' which must
@@ -29,8 +29,7 @@ def test_init():
     },
     'healthy': 1,
     'sid': {
-        'band': 0,
-        'constellation': 0,
+        'code': 0,
         'sat': 1
     },
     'valid': 1,
@@ -58,8 +57,7 @@ def test_almanac_functions():
     },
     'valid': 1,
     'sid': {
-        'band': 0,
-        'constellation': 0,
+        'code': 0,
         'sat': 1
     }
   }

python/tests/test_ambiguity_test.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (C) 2015 Swift Navigation Inc.
+# Copyright (C) 2016 Swift Navigation Inc.
 # Contact: Bhaskar Mookerji <[email protected]>
 #
 # This source is subject to the license found in the file 'LICENSE' which must
@@ -15,22 +15,22 @@
 import swiftnav.signal as s
 
 def test_update_sats_same_sats():
-  sids = [s.GNSSSignal(sat=3, band=0, constellation=0),
-          s.GNSSSignal(sat=1, band=0, constellation=0),
-          s.GNSSSignal(sat=2, band=0, constellation=0),
-          s.GNSSSignal(sat=4, band=0, constellation=0)]
+  sids = [s.GNSSSignal(sat=3, code=0),
+          s.GNSSSignal(sat=1, code=0),
+          s.GNSSSignal(sat=2, code=0),
+          s.GNSSSignal(sat=4, code=0)]
   sm = sat.SatsManagement(sids=sids)
   test = a.AmbiguityTest(sats=sm)
-  sdiffs = [o.SingleDiff(sid={'sat':1, 'band': 0, 'constellation': 0},
+  sdiffs = [o.SingleDiff(sid={'sat':1, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':2, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':2, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':3, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':3, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':4, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':4, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0)]
   assert not test.ambiguity_update_sats(sdiffs, None, None, None, None, False)
@@ -40,35 +40,35 @@ def test_update_sats_same_sats():
   assert test.sats['sids'][3]['sat'] == 4
 
 def test_bad_measurements():
-  sids = [s.GNSSSignal(sat=1, band=0, constellation=0),
-          s.GNSSSignal(sat=2, band=0, constellation=0),
-          s.GNSSSignal(sat=3, band=0, constellation=0),
-          s.GNSSSignal(sat=5, band=0, constellation=0),
-          s.GNSSSignal(sat=6, band=0, constellation=0)]
+  sids = [s.GNSSSignal(sat=1, code=0),
+          s.GNSSSignal(sat=2, code=0),
+          s.GNSSSignal(sat=3, code=0),
+          s.GNSSSignal(sat=5, code=0),
+          s.GNSSSignal(sat=6, code=0)]
   float_sats = sat.SatsManagement(sids=sids)
-  sids = [s.GNSSSignal(sat=3, band=0, constellation=0),
-          s.GNSSSignal(sat=1, band=0, constellation=0),
-          s.GNSSSignal(sat=2, band=0, constellation=0),
-          s.GNSSSignal(sat=5, band=0, constellation=0),
-          s.GNSSSignal(sat=6, band=0, constellation=0)]
+  sids = [s.GNSSSignal(sat=3, code=0),
+          s.GNSSSignal(sat=1, code=0),
+          s.GNSSSignal(sat=2, code=0),
+          s.GNSSSignal(sat=5, code=0),
+          s.GNSSSignal(sat=6, code=0)]
   amb_sats_init = sat.SatsManagement(sids=sids)
   test = a.AmbiguityTest(sats=float_sats)
-  sdiffs = [o.SingleDiff(sid={'sat':1, 'band': 0, 'constellation': 0},
+  sdiffs = [o.SingleDiff(sid={'sat':1, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':2, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':2, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':3, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':3, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':4, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':4, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':5, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':5, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0),
-            o.SingleDiff(sid={'sat':6, 'band': 0, 'constellation': 0},
+            o.SingleDiff(sid={'sat':6, 'code': 0},
                          pseudorange=0, sat_pos=(0, 0, 0), sat_vel=(0, 0, 0),
                          carrier_phase=0, raw_doppler=0, doppler=0, snr=0)]
   #ambiguity_update_sats(&amb_test, num_sdiffs, sdiffs, &float_sats, est, U, D, false);