canvod.readers API Reference¶
RINEX observation file parsing with validation and GNSS signal specifications.
Package¶
GNSS data format readers.
This package provides readers for various GNSS data formats, all implementing a common interface for seamless integration with processing pipelines.
Supported formats: - RINEX v3.04 (GNSS observations) - More formats coming soon...
Quick Start¶
from canvod.readers import Rnxv3Obs
# Read RINEX v3 file
reader = Rnxv3Obs(fpath="station.24o")
dataset = reader.to_ds()
Or use the canvodpy factory for automatic format detection:
from canvodpy import ReaderFactory
# Auto-detects format from file header
reader = ReaderFactory.create_from_file("station.24o")
dataset = reader.to_ds()
Directory Matching:
from canvod.readers import DataDirMatcher
# Find dates with RINEX files in both receivers
matcher = DataDirMatcher(root=Path("/data/01_Rosalia"))
for matched_dirs in matcher:
print(matched_dirs.yyyydoy)
# Load RINEX files from matched_dirs.canopy_data_dir
GNSSDataReader
¶
Bases: BaseModel, ABC
Abstract base class for all GNSS data format readers.
All readers must:
1. Inherit from this class
2. Implement all abstract methods
3. Return xarray.Dataset that passes :func:validate_dataset
4. Provide file hash for deduplication
This ensures compatibility with: - canvod-vod: VOD calculation - canvod-store: MyIcechunkStore storage - canvod-grids: Grid projection operations
Subclasses may override model_config to set frozen, extra,
etc. The base class provides arbitrary_types_allowed=True which is
needed by readers that use pint.Quantity or similar third-party types.
Examples¶
class Rnxv3Obs(GNSSDataReader): ... def to_ds(self, **kwargs) -> xr.Dataset: ... # Implementation ... return dataset ... reader = Rnxv3Obs(fpath="station.24o") ds = reader.to_ds() validate_dataset(ds)
Source code in packages/canvod-readers/src/canvod/readers/base.py
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 | |
source_format
property
¶
Return the format identifier for this reader (e.g. "rinex3", "sbf").
file_hash
abstractmethod
property
¶
Return SHA256 hash of file for deduplication.
Used by MyIcechunkStore to avoid duplicate ingestion. Must be deterministic and reproducible.
Returns¶
str Short hash (16 chars) or full hash of file content
start_time
abstractmethod
property
¶
end_time
abstractmethod
property
¶
systems
abstractmethod
property
¶
Return list of GNSS systems in file.
Returns¶
list of str System identifiers: 'G', 'R', 'E', 'C', 'J', 'S', 'I'
num_epochs
property
¶
Return number of epochs in file.
Default implementation iterates epochs. Subclasses may override with a faster approach.
Returns¶
int Total number of observation epochs.
num_satellites
abstractmethod
property
¶
Return total number of unique satellites observed.
Returns¶
int Count of unique satellite vehicles across all systems.
to_ds(keep_data_vars=None, **kwargs)
abstractmethod
¶
Convert data to xarray.Dataset.
Must return Dataset with structure: - Dims: (epoch, sid) - Coords: epoch, sid, sv, system, band, code, freq_* - Data vars: At minimum SNR - Attrs: Must include "File Hash"
Parameters¶
keep_data_vars : list of str, optional Data variables to include. If None, includes all available. **kwargs Implementation-specific parameters
Returns¶
xr.Dataset
Dataset that passes :func:validate_dataset.
Source code in packages/canvod-readers/src/canvod/readers/base.py
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | |
iter_epochs()
abstractmethod
¶
Iterate over epochs in the file.
Yields¶
Epoch Parsed epoch with satellites and observations.
Source code in packages/canvod-readers/src/canvod/readers/base.py
378 379 380 381 382 383 384 385 386 | |
to_ds_and_auxiliary(keep_data_vars=None, **kwargs)
¶
Produce the obs dataset and any auxiliary datasets in a single call.
Default: calls to_ds(**kwargs) and returns an empty auxiliary dict.
Readers that produce metadata (e.g. SBF) override this to collect both
in a single file scan.
Returns¶
tuple[xr.Dataset, dict[str, xr.Dataset]]
(obs_ds, {"name": aux_ds, ...}). Auxiliary dict is empty for
readers with no extra data (RINEX v2/v3).
Source code in packages/canvod-readers/src/canvod/readers/base.py
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | |
__repr__()
¶
Return the string representation.
Source code in packages/canvod-readers/src/canvod/readers/base.py
487 488 489 | |
SignalID
¶
Bases: BaseModel
Validated signal identifier (SV + band + code).
sid = SignalID(sv="G01", band="L1", code="C") str(sid) 'G01|L1|C' sid.system 'G'
Source code in packages/canvod-readers/src/canvod/readers/base.py
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
system
property
¶
GNSS system letter (e.g. 'G' for GPS).
sid
property
¶
Full signal ID string ('SV|band|code').
from_string(sid_str)
classmethod
¶
Parse a signal ID string ('SV|band|code') into a SignalID.
Parameters¶
sid_str : str Signal ID in 'SV|band|code' format (e.g. 'G01|L1|C').
Returns¶
SignalID Validated signal identifier.
Raises¶
ValueError If the string does not have exactly three pipe-separated parts.
Source code in packages/canvod-readers/src/canvod/readers/base.py
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
DatasetBuilder
¶
Guided builder for constructing valid GNSSDataReader output Datasets.
Handles coordinate arrays, dtype enforcement, frequency resolution, and contract validation automatically.
Parameters¶
reader : GNSSDataReader
The reader instance (used for _build_attrs() and file hash).
aggregate_glonass_fdma : bool, optional
Whether to aggregate GLONASS FDMA channels (default True).
Examples¶
builder = DatasetBuilder(reader) for epoch in reader.iter_epochs(): ... ei = builder.add_epoch(epoch.timestamp) ... for obs in epoch.observations: ... sig = builder.add_signal(sv="G01", band="L1", code="C") ... builder.set_value(ei, sig, "SNR", 42.0) ds = builder.build() # validated Dataset
Source code in packages/canvod-readers/src/canvod/readers/builder.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
add_epoch(timestamp)
¶
Register an epoch timestamp. Returns epoch index.
Source code in packages/canvod-readers/src/canvod/readers/builder.py
86 87 88 89 | |
add_signal(sv, band, code)
¶
Register a signal (idempotent). Returns validated SignalID.
Source code in packages/canvod-readers/src/canvod/readers/builder.py
91 92 93 94 95 | |
set_value(epoch_idx, signal, var, value)
¶
Set a data value for a given epoch, signal, and variable.
Parameters¶
epoch_idx : int
Index returned by :meth:add_epoch.
signal : SignalID or str
Signal identifier (SignalID or 'SV|band|code' string).
var : str
Variable name (e.g. 'SNR', 'Pseudorange', 'Phase').
value : float
The observation value.
Source code in packages/canvod-readers/src/canvod/readers/builder.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | |
build(keep_data_vars=None, extra_attrs=None)
¶
Build, validate, and return the Dataset.
- Sorts signals alphabetically
- Resolves frequencies from band names via SignalIDMapper
- Constructs coordinate arrays with correct dtypes (float32 for freq)
- Attaches CF-compliant metadata from COORDS_METADATA
- Calls validate_dataset() before returning
Parameters¶
keep_data_vars : list of str, optional
If provided, only include these data variables. If None,
includes all variables that had values set.
extra_attrs : dict, optional
Additional global attributes to merge into the Dataset.
Returns¶
xr.Dataset
Validated Dataset with dimensions (epoch, sid).
Source code in packages/canvod-readers/src/canvod/readers/builder.py
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
DatasetStructureValidator
¶
Bases: BaseModel
Validates that an xarray.Dataset meets the GNSSDataReader contract.
Wraps a Dataset and checks it against the contract constants above. Use this in tests and reader implementations to catch structural errors early with clear messages.
Examples¶
validator = DatasetStructureValidator(dataset=ds) validator.validate_all() # raises ValueError on any violation validator.validate_dimensions() # check just one aspect
Source code in packages/canvod-readers/src/canvod/readers/base.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | |
validate_all(required_vars=None)
¶
Run all validations, collecting all errors.
Delegates to :func:validate_dataset so the logic lives in one place.
Source code in packages/canvod-readers/src/canvod/readers/base.py
154 155 156 157 158 159 | |
validate_dimensions()
¶
Check that required dimensions (epoch, sid) exist.
Source code in packages/canvod-readers/src/canvod/readers/base.py
161 162 163 164 165 | |
validate_coordinates()
¶
Check that required coordinates exist with correct dtypes.
Source code in packages/canvod-readers/src/canvod/readers/base.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | |
validate_data_variables(required_vars=None)
¶
Check that required data variables exist with correct dims.
Source code in packages/canvod-readers/src/canvod/readers/base.py
184 185 186 187 188 189 190 191 192 193 194 195 196 | |
validate_attributes()
¶
Check that required global attributes are present.
Source code in packages/canvod-readers/src/canvod/readers/base.py
198 199 200 201 202 | |
Rnxv3Obs
¶
Bases: GNSSDataReader
RINEX v3.04 observation reader.
Attributes¶
fpath : Path Path to the RINEX observation file. polarization : str, default "RHCP" Polarization label for observables. completeness_mode : {"strict", "warn", "off"}, default "strict" Behavior when epoch completeness checks fail. expected_dump_interval : str or pint.Quantity, optional Expected file dump interval for completeness validation. expected_sampling_interval : str or pint.Quantity, optional Expected sampling interval for completeness validation. apply_overlap_filter : bool, default False Whether to filter overlapping signal groups. overlap_preferences : dict[str, str], optional Preferred signals for overlap resolution. aggregate_glonass_fdma : bool, optional Whether to aggregate GLONASS FDMA channels.
Notes¶
Inherits fpath, its validator, and arbitrary_types_allowed
from :class:GNSSDataReader.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 | |
header
property
¶
file_hash
property
¶
Return cached SHA256 short hash of the file content.
Returns¶
str 16-character short hash for deduplication.
start_time
property
¶
end_time
property
¶
systems
property
¶
num_satellites
property
¶
Return total number of unique satellites observed.
Returns¶
int Count of unique satellite vehicles across all systems.
epochs
property
¶
Materialize all epochs (legacy compatibility).
Returns¶
list of Rnxv3ObsEpochRecord All epochs in memory (use iter_epochs for efficiency)
__str__()
¶
Return a human-readable summary.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
808 809 810 811 812 813 814 815 | |
__repr__()
¶
Return a concise representation for debugging.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
817 818 819 | |
get_epoch_record_batches(epoch_record_indicator=EPOCH_RECORD_INDICATOR)
¶
Get the start and end line numbers for each epoch in the file.
Parameters¶
epoch_record_indicator : str, default '>' Character marking epoch record lines.
Returns¶
list of tuple of int List of (start_line, end_line) pairs for each epoch.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 | |
parse_observation_slice(slice_text)
¶
Parse a RINEX observation slice into value, LLI, and SSI.
Enhanced to handle both standard 16-character format and variable-length records.
Parameters¶
slice_text : str Observation slice to parse.
Returns¶
tuple[float | None, int | None, int | None] Parsed (value, LLI, SSI) tuple.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 | |
process_satellite_data(s)
¶
Process satellite data line into a Satellite object with observations.
Handles variable-length observation records correctly by adaptively parsing based on the actual line length and content.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 | |
iter_epochs()
¶
Yield epochs one by one instead of materializing the whole list.
Returns¶
Generator Generator yielding Rnxv3ObsEpochRecord objects
Yields¶
Rnxv3ObsEpochRecord Each epoch with timestamp and satellite observations
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 | |
iter_epochs_in_range(start, end)
¶
Yield epochs lazily that fall into the given datetime range.
Parameters¶
start : datetime Start of time range (inclusive) end : datetime End of time range (inclusive)
Returns¶
Generator Generator yielding epochs in the specified range
Yields¶
Rnxv3ObsEpochRecord Epochs within the time range
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 | |
get_datetime_from_epoch_record_info(epoch_record_info)
¶
Convert epoch record info to datetime object.
Parameters¶
epoch_record_info : Rnxv3ObsEpochRecordLineModel Parsed epoch record line
Returns¶
datetime Timestamp from epoch record
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 | |
epochrecordinfo_dt_to_numpy_dt(epch)
staticmethod
¶
Convert Python datetime to numpy datetime64[ns].
Parameters¶
epch : Rnxv3ObsEpochRecord Epoch record containing timestamp info
Returns¶
np.datetime64 Numpy datetime64 with nanosecond precision
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 | |
infer_sampling_interval()
¶
Infer sampling interval from consecutive epoch deltas.
Returns¶
pint.Quantity or None Sampling interval in seconds, or None if cannot be inferred
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 | |
infer_dump_interval(sampling_interval=None)
¶
Infer the intended dump interval for the RINEX file.
Parameters¶
sampling_interval : pint.Quantity, optional Known sampling interval. If provided, returns (#epochs * sampling_interval)
Returns¶
pint.Quantity or None Dump interval in seconds, or None if cannot be inferred
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 | |
validate_epoch_completeness(dump_interval=None, sampling_interval=None)
¶
Validate that the number of epochs matches the expected dump interval.
Parameters¶
dump_interval : str or pint.Quantity, optional Expected file dump interval. If None, inferred from epochs. sampling_interval : str or pint.Quantity, optional Expected sampling interval. If None, inferred from epochs.
Returns¶
None
Raises¶
MissingEpochError If total sampling time doesn't match dump interval ValueError If intervals cannot be inferred
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 | |
filter_by_overlapping_groups(ds, group_preference=None)
¶
Filter overlapping bands using per-group preferences.
Parameters¶
ds : xr.Dataset
Dataset with sid dimension and signal properties.
group_preference : dict[str, str], optional
Mapping of overlap group to preferred band.
Returns¶
xr.Dataset Dataset filtered to preferred overlapping bands.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 | |
create_rinex_netcdf_with_signal_id(start=None, end=None)
¶
Create a NetCDF dataset with signal IDs.
Always uses the fast single-pass path. Optionally restricts to epochs within a datetime range via post-filtering.
Parameters¶
start : datetime, optional Start of time range (inclusive). end : datetime, optional End of time range (inclusive).
Returns¶
xr.Dataset Dataset with dimensions (epoch, sid).
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 | |
to_ds(keep_data_vars=None, **kwargs)
¶
Convert RINEX observations to xarray.Dataset with signal ID structure.
Parameters¶
outname : Path or str, optional If provided, saves dataset to this file path keep_data_vars : list of str or None, optional Data variables to include in dataset. Defaults to config value. write_global_attrs : bool, default False If True, adds comprehensive global attributes pad_global_sid : bool, default True If True, pads to global signal ID space strip_fillval : bool, default True If True, removes fill values add_future_datavars : bool, default True If True, adds placeholder variables for future data keep_sids : list of str or None, default None If provided, filters/pads dataset to these specific SIDs. If None and pad_global_sid=True, pads to all possible SIDs.
Returns¶
xr.Dataset Dataset with dimensions (epoch, sid) and requested data variables
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 | |
validate_rinex_304_compliance(ds=None, strict=False, print_report=True)
¶
Run enhanced RINEX 3.04 specification validation.
Validates: 1. System-specific observation codes 2. GLONASS mandatory fields (slot/frequency, biases) 3. Phase shift records (RINEX 3.01+) 4. Observation value ranges
Parameters¶
ds : xr.Dataset, optional Dataset to validate. If None, creates one from current file. strict : bool If True, raise ValueError on validation failures print_report : bool If True, print validation report to console
Returns¶
dict[str, list[str]] Validation results by category
Examples¶
reader = Rnxv3Obs(fpath="station.24o") results = reader.validate_rinex_304_compliance()
Or validate a specific dataset¶
ds = reader.to_ds() results = reader.validate_rinex_304_compliance(ds=ds)
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 | |
SbfReader
¶
Bases: GNSSDataReader
Read and decode a Septentrio Binary Format (SBF) observation file.
Parameters¶
fpath : Path
Path to the *.sbf (or *.SBF, or receiver-named) binary file.
Examples¶
reader = SbfReader(fpath=Path("rref213a00.25_")) print(reader.header.rx_version) 4.14.4 for epoch in reader.iter_epochs(): ... for obs in epoch.observations: ... print(obs.system, obs.prn, obs.cn0)
Notes¶
- All physical-unit conversions follow RefGuide-4.14.0.
- Physical quantities are expressed as :class:
pint.Quantityobjects using the shared :data:~canvod.readers.gnss_specs.constants.UREG. - GLONASS FDMA frequencies are resolved from the most recently seen
ChannelStatus block; observations before the first ChannelStatus for a
given SVID have
phase_cycles=None. - The file is scanned once per :meth:
iter_epochscall; use :attr:num_epochsfor a pre-computed count (scans once on first access). - Inherits
fpath, its validator, andarbitrary_types_allowedfrom :class:GNSSDataReader.
Source code in packages/canvod-readers/src/canvod/readers/sbf/reader.py
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 | |
file_hash
cached
property
¶
SHA-256 hex digest of the file (first 16 characters).
Returns¶
str 16-character hexadecimal prefix of the SHA-256 hash.
start_time
cached
property
¶
end_time
cached
property
¶
systems
cached
property
¶
Return sorted list of GNSS system codes present in the file.
Returns¶
list of str
Sorted list of RINEX system letters (e.g. ["E", "G", "R"]).
num_satellites
cached
property
¶
Return the number of unique satellites observed in the file.
Returns¶
int
Count of unique system + PRN pairs across all epochs.
num_epochs
cached
property
¶
header
cached
property
¶
iter_epochs()
¶
Iterate over decoded MeasEpoch blocks.
Yields decoded :class:SbfEpoch objects with all signal observations
converted to physical units as :class:pint.Quantity.
Yields¶
SbfEpoch One decoded observation epoch.
Notes¶
- The file is scanned from start to finish on each call.
- The :attr:
_freq_nr_cacheis pre-populated from ALL ChannelStatus blocks before the first call, so all GLONASS FDMA epochs have accurate carrier frequencies. delta_ls(leap seconds) is taken from the most recent ReceiverTime block; defaults to 18 if none has been seen yet.
Source code in packages/canvod-readers/src/canvod/readers/sbf/reader.py
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 | |
to_ds(keep_data_vars=None, pad_global_sid=True, strip_fillval=True, **kwargs)
¶
Convert SBF observations to an (epoch, sid) xarray Dataset.
Produces the same structure as :class:~canvod.readers.rinex.v3_04.Rnxv3Obs
and passes :func:~canvod.readers.base.validate_dataset.
Parameters¶
keep_data_vars : list of str, optional
Data variables to retain. If None, all five variables are
kept: SNR, Pseudorange, Phase, Doppler, SSI.
Note: LLI is not produced — SBF has no loss-of-lock indicator.
pad_global_sid : bool, default True
If True, pads the dataset to the global SID space via
:func:canvod.auxiliary.preprocessing.pad_to_global_sid.
strip_fillval : bool, default True
If True, removes fill values via
:func:canvod.auxiliary.preprocessing.strip_fillvalue.
**kwargs
Ignored (for ABC compatibility).
Returns¶
xr.Dataset
Dataset with dimensions (epoch, sid) that passes
:func:~canvod.readers.base.validate_dataset.
Source code in packages/canvod-readers/src/canvod/readers/sbf/reader.py
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 | |
to_metadata_ds(pad_global_sid=True, **kwargs)
¶
Decode SBF metadata blocks to an (epoch, sid) xarray Dataset.
Decodes PVTGeodetic, DOP, ReceiverStatus, SatVisibility, and MeasExtra blocks in a single file scan.
Parameters¶
pad_global_sid : bool, default True
If True, pads to the global SID space via
:func:canvod.auxiliary.preprocessing.pad_to_global_sid.
Returns¶
xr.Dataset
Dataset with dimensions (epoch, sid). Epoch-level scalars
(PDOP, NrSV, …) are 1-D (epoch,) coordinates. Satellite
geometry (theta, phi) and signal quality (MPCorrection, …) are
(epoch, sid) data variables.
Source code in packages/canvod-readers/src/canvod/readers/sbf/reader.py
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 | |
to_ds_and_auxiliary(keep_data_vars=None, pad_global_sid=True, strip_fillval=True, store_raw_observables=True, **kwargs)
¶
Single file scan producing both the obs dataset and the SBF metadata dataset.
Performs ONE parser.read() pass, collecting MeasEpoch observations
and PVTGeodetic/DOP/SatVisibility/MeasExtra metadata blocks simultaneously.
to_ds() and to_metadata_ds() remain unchanged for standalone use.
Parameters¶
keep_data_vars : list of str, optional
Data variables to retain in the obs dataset.
pad_global_sid : bool, default True
Pad obs dataset to the global SID space.
strip_fillval : bool, default True
Strip fill values from the obs dataset.
store_raw_observables : bool, default True
Add pre-correction "raw" observable variables to the obs dataset:
SNR_raw, Pseudorange_unsmoothed, Pseudorange_raw,
Phase_raw. Set to False to reduce dataset size when these
are not needed.
**kwargs
Forwarded to pad_to_global_sid (e.g. keep_sids).
Returns¶
tuple[xr.Dataset, dict[str, xr.Dataset]]
(obs_ds, {"sbf_obs": meta_ds}).
Source code in packages/canvod-readers/src/canvod/readers/sbf/reader.py
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 | |
__repr__()
¶
Return a short string representation.
Source code in packages/canvod-readers/src/canvod/readers/sbf/reader.py
2481 2482 2483 | |
DataDirMatcher
¶
Match RINEX data directories for canopy and reference receivers.
Scans a root directory structure to find dates with RINEX files present in both canopy and reference receiver directories.
Parameters¶
root : Path Root directory containing receiver subdirectories reference_pattern : Path, optional Relative path pattern for reference receiver (default: "01_reference/01_GNSS/01_raw") canopy_pattern : Path, optional Relative path pattern for canopy receiver (default: "02_canopy/01_GNSS/01_raw")
Examples¶
from pathlib import Path matcher = DataDirMatcher( ... root=Path("/data/01_Rosalia"), ... reference_pattern=Path("01_reference/01_GNSS/01_raw"), ... canopy_pattern=Path("02_canopy/01_GNSS/01_raw") ... )
Iterate over matched directories¶
for matched_dirs in matcher: ... print(matched_dirs.yyyydoy) ... rinex_files = list(matched_dirs.canopy_data_dir.glob("*.25o")) ... print(f" Found {len(rinex_files)} RINEX files")
Get list of common dates¶
dates = matcher.get_common_dates() print(f"Found {len(dates)} dates with data")
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | |
__init__(root, reference_pattern=Path('01_reference/01_GNSS/01_raw'), canopy_pattern=Path('02_canopy/01_GNSS/01_raw'))
¶
Initialize matcher with directory structure.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | |
__iter__()
¶
Iterate over matched directory pairs with RINEX files.
Yields¶
MatchedDirs Matched directories for each date.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
get_common_dates()
¶
Get dates with RINEX files in both receivers.
Uses parallel processing to check directories efficiently.
Returns¶
list[str] Sorted list of date strings (YYDDD format, e.g., "25001") that have RINEX files in both canopy and reference directories.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
PairDataDirMatcher
¶
Match RINEX directories for receiver pairs across dates.
Supports multi-receiver configurations where multiple canopy/reference pairs may exist at the same site. Requires a configuration dict specifying receiver locations and analysis pairs.
Parameters¶
base_dir : Path
Root directory containing all receiver data
receivers : dict
Receiver configuration mapping receiver names to their directory paths.
The directory value is the full relative path from base_dir to the
raw RINEX data directory (before the {YYDOY} date folders).
Example: {"canopy_01": {"directory": "02_canopy_01/01_GNSS/01_raw"},
"reference_01": {"directory": "01_reference_01/01_GNSS/01_raw"}}
analysis_pairs : dict
Analysis pair configuration specifying which receivers to match
Example: {"pair_01": {"canopy_receiver": "canopy_01",
"reference_receiver": "reference_01"}}
Examples¶
receivers = { ... "canopy_01": {"directory": "02_canopy/01_GNSS/01_raw"}, ... "reference_01": {"directory": "01_reference/01_GNSS/01_raw"} ... } pairs = { ... "main_pair": { ... "canopy_receiver": "canopy_01", ... "reference_receiver": "reference_01" ... } ... }
matcher = PairDataDirMatcher( ... base_dir=Path("/data/01_Rosalia"), ... receivers=receivers, ... analysis_pairs=pairs ... )
for matched in matcher: ... print(f"{matched.yyyydoy}: {matched.pair_name}") ... print(f" Canopy: {matched.canopy_data_dir}") ... print(f" Reference: {matched.reference_data_dir}")
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | |
__init__(base_dir, receivers, analysis_pairs)
¶
Initialize pair matcher with receiver configuration.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | |
__iter__()
¶
Iterate over all date/pair combinations with available data.
Yields¶
PairMatchedDirs Matched directories for a receiver pair on a specific date.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | |
MatchedDirs
dataclass
¶
Matched directory paths for canopy and reference receivers.
Immutable container representing a pair of directories containing RINEX data for the same date.
Parameters¶
canopy_data_dir : Path Path to canopy receiver RINEX directory. reference_data_dir : Path Path to reference (open-sky) receiver RINEX directory. yyyydoy : YYYYDOY Date object for this matched pair.
Examples¶
from pathlib import Path from canvod.utils.tools import YYYYDOY
md = MatchedDirs( ... canopy_data_dir=Path("/data/02_canopy/25001"), ... reference_data_dir=Path("/data/01_reference/25001"), ... yyyydoy=YYYYDOY.from_str("2025001") ... ) md.yyyydoy.to_str() '2025001'
Source code in packages/canvod-readers/src/canvod/readers/matching/models.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | |
PairMatchedDirs
dataclass
¶
Matched directories for a receiver pair on a specific date.
Supports multi-receiver configurations where multiple canopy/reference pairs may exist at the same site.
Parameters¶
yyyydoy : YYYYDOY Date for this matched pair. pair_name : str Identifier for this receiver pair (e.g., "pair_01"). canopy_receiver : str Name of canopy receiver (e.g., "canopy_01"). reference_receiver : str Name of reference receiver (e.g., "reference_01"). canopy_data_dir : Path Path to canopy receiver RINEX directory. reference_data_dir : Path Path to reference receiver RINEX directory.
Examples¶
pmd = PairMatchedDirs( ... yyyydoy=YYYYDOY.from_str("2025001"), ... pair_name="pair_01", ... canopy_receiver="canopy_01", ... reference_receiver="reference_01", ... canopy_data_dir=Path("/data/canopy_01/25001"), ... reference_data_dir=Path("/data/reference_01/25001") ... ) pmd.pair_name 'pair_01'
Source code in packages/canvod-readers/src/canvod/readers/matching/models.py
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | |
validate_dataset(ds, required_vars=None)
¶
Validate ds meets the GNSSDataReader output contract.
Collects all violations and raises a single ValueError listing
every problem, rather than stopping at the first failure.
Parameters¶
ds : xr.Dataset
Dataset to validate.
required_vars : list of str, optional
Data variables that must be present. Defaults to
:data:DEFAULT_REQUIRED_VARS (["SNR"]).
Raises¶
ValueError If any contract violation is found.
Source code in packages/canvod-readers/src/canvod/readers/base.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | |
RINEX v3.04¶
RINEX v3.04 observation file reader.
Migrated from: gnssvodpy/rinexreader/rinex_reader.py
Changes from original: - Updated imports to use canvod.readers.gnss_specs - Added structured logging for LLM-friendly diagnostics - Removed IcechunkPreprocessor calls (TODO: move to canvod-store) - Preserved all other functionality
Classes: - Rnxv3Header: Parse RINEX v3 headers - Rnxv3Obs: Main reader class, converts RINEX to xarray Dataset
Rnxv3Header
¶
Bases: BaseModel
Enhanced RINEX v3 header following the original implementation logic.
Key changes from previous version: - date field is now datetime (like original) - Uses the original parsing logic for __get_pgm_runby_date
Notes¶
This is a Pydantic BaseModel configured with ConfigDict (frozen,
validate_assignment, arbitrary_types_allowed, str_strip_whitespace). Prefer
:meth:from_file for construction.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 | |
is_mixed_systems
property
¶
Check if the RINEX file contains mixed GNSS systems.
parse_marker_number(v)
classmethod
¶
Convert empty strings to None, parse valid integers.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
193 194 195 196 197 198 199 200 201 202 203 204 | |
from_file(fpath)
classmethod
¶
Create header from a RINEX file.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | |
__repr__()
¶
Return a concise representation for debugging.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
698 699 700 701 702 703 704 | |
__str__()
¶
Return a human-readable header summary.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
706 707 708 709 710 711 712 713 714 715 716 | |
Rnxv3Obs
¶
Bases: GNSSDataReader
RINEX v3.04 observation reader.
Attributes¶
fpath : Path Path to the RINEX observation file. polarization : str, default "RHCP" Polarization label for observables. completeness_mode : {"strict", "warn", "off"}, default "strict" Behavior when epoch completeness checks fail. expected_dump_interval : str or pint.Quantity, optional Expected file dump interval for completeness validation. expected_sampling_interval : str or pint.Quantity, optional Expected sampling interval for completeness validation. apply_overlap_filter : bool, default False Whether to filter overlapping signal groups. overlap_preferences : dict[str, str], optional Preferred signals for overlap resolution. aggregate_glonass_fdma : bool, optional Whether to aggregate GLONASS FDMA channels.
Notes¶
Inherits fpath, its validator, and arbitrary_types_allowed
from :class:GNSSDataReader.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 | |
header
property
¶
file_hash
property
¶
Return cached SHA256 short hash of the file content.
Returns¶
str 16-character short hash for deduplication.
start_time
property
¶
end_time
property
¶
systems
property
¶
num_satellites
property
¶
Return total number of unique satellites observed.
Returns¶
int Count of unique satellite vehicles across all systems.
epochs
property
¶
Materialize all epochs (legacy compatibility).
Returns¶
list of Rnxv3ObsEpochRecord All epochs in memory (use iter_epochs for efficiency)
__str__()
¶
Return a human-readable summary.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
808 809 810 811 812 813 814 815 | |
__repr__()
¶
Return a concise representation for debugging.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
817 818 819 | |
get_epoch_record_batches(epoch_record_indicator=EPOCH_RECORD_INDICATOR)
¶
Get the start and end line numbers for each epoch in the file.
Parameters¶
epoch_record_indicator : str, default '>' Character marking epoch record lines.
Returns¶
list of tuple of int List of (start_line, end_line) pairs for each epoch.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 | |
parse_observation_slice(slice_text)
¶
Parse a RINEX observation slice into value, LLI, and SSI.
Enhanced to handle both standard 16-character format and variable-length records.
Parameters¶
slice_text : str Observation slice to parse.
Returns¶
tuple[float | None, int | None, int | None] Parsed (value, LLI, SSI) tuple.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 | |
process_satellite_data(s)
¶
Process satellite data line into a Satellite object with observations.
Handles variable-length observation records correctly by adaptively parsing based on the actual line length and content.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 | |
iter_epochs()
¶
Yield epochs one by one instead of materializing the whole list.
Returns¶
Generator Generator yielding Rnxv3ObsEpochRecord objects
Yields¶
Rnxv3ObsEpochRecord Each epoch with timestamp and satellite observations
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 | |
iter_epochs_in_range(start, end)
¶
Yield epochs lazily that fall into the given datetime range.
Parameters¶
start : datetime Start of time range (inclusive) end : datetime End of time range (inclusive)
Returns¶
Generator Generator yielding epochs in the specified range
Yields¶
Rnxv3ObsEpochRecord Epochs within the time range
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 | |
get_datetime_from_epoch_record_info(epoch_record_info)
¶
Convert epoch record info to datetime object.
Parameters¶
epoch_record_info : Rnxv3ObsEpochRecordLineModel Parsed epoch record line
Returns¶
datetime Timestamp from epoch record
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 | |
epochrecordinfo_dt_to_numpy_dt(epch)
staticmethod
¶
Convert Python datetime to numpy datetime64[ns].
Parameters¶
epch : Rnxv3ObsEpochRecord Epoch record containing timestamp info
Returns¶
np.datetime64 Numpy datetime64 with nanosecond precision
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 | |
infer_sampling_interval()
¶
Infer sampling interval from consecutive epoch deltas.
Returns¶
pint.Quantity or None Sampling interval in seconds, or None if cannot be inferred
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 | |
infer_dump_interval(sampling_interval=None)
¶
Infer the intended dump interval for the RINEX file.
Parameters¶
sampling_interval : pint.Quantity, optional Known sampling interval. If provided, returns (#epochs * sampling_interval)
Returns¶
pint.Quantity or None Dump interval in seconds, or None if cannot be inferred
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 | |
validate_epoch_completeness(dump_interval=None, sampling_interval=None)
¶
Validate that the number of epochs matches the expected dump interval.
Parameters¶
dump_interval : str or pint.Quantity, optional Expected file dump interval. If None, inferred from epochs. sampling_interval : str or pint.Quantity, optional Expected sampling interval. If None, inferred from epochs.
Returns¶
None
Raises¶
MissingEpochError If total sampling time doesn't match dump interval ValueError If intervals cannot be inferred
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 | |
filter_by_overlapping_groups(ds, group_preference=None)
¶
Filter overlapping bands using per-group preferences.
Parameters¶
ds : xr.Dataset
Dataset with sid dimension and signal properties.
group_preference : dict[str, str], optional
Mapping of overlap group to preferred band.
Returns¶
xr.Dataset Dataset filtered to preferred overlapping bands.
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 | |
create_rinex_netcdf_with_signal_id(start=None, end=None)
¶
Create a NetCDF dataset with signal IDs.
Always uses the fast single-pass path. Optionally restricts to epochs within a datetime range via post-filtering.
Parameters¶
start : datetime, optional Start of time range (inclusive). end : datetime, optional End of time range (inclusive).
Returns¶
xr.Dataset Dataset with dimensions (epoch, sid).
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 | |
to_ds(keep_data_vars=None, **kwargs)
¶
Convert RINEX observations to xarray.Dataset with signal ID structure.
Parameters¶
outname : Path or str, optional If provided, saves dataset to this file path keep_data_vars : list of str or None, optional Data variables to include in dataset. Defaults to config value. write_global_attrs : bool, default False If True, adds comprehensive global attributes pad_global_sid : bool, default True If True, pads to global signal ID space strip_fillval : bool, default True If True, removes fill values add_future_datavars : bool, default True If True, adds placeholder variables for future data keep_sids : list of str or None, default None If provided, filters/pads dataset to these specific SIDs. If None and pad_global_sid=True, pads to all possible SIDs.
Returns¶
xr.Dataset Dataset with dimensions (epoch, sid) and requested data variables
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 | |
validate_rinex_304_compliance(ds=None, strict=False, print_report=True)
¶
Run enhanced RINEX 3.04 specification validation.
Validates: 1. System-specific observation codes 2. GLONASS mandatory fields (slot/frequency, biases) 3. Phase shift records (RINEX 3.01+) 4. Observation value ranges
Parameters¶
ds : xr.Dataset, optional Dataset to validate. If None, creates one from current file. strict : bool If True, raise ValueError on validation failures print_report : bool If True, print validation report to console
Returns¶
dict[str, list[str]] Validation results by category
Examples¶
reader = Rnxv3Obs(fpath="station.24o") results = reader.validate_rinex_304_compliance()
Or validate a specific dataset¶
ds = reader.to_ds() results = reader.validate_rinex_304_compliance(ds=ds)
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 | |
adapt_existing_rnxv3obs_class(original_class_path=None)
¶
Provide guidance to integrate the enhanced sid functionality.
This function provides guidance on how to modify the existing class to support the new sid structure alongside the current OFT structure.
Returns¶
str Integration instructions
Source code in packages/canvod-readers/src/canvod/readers/rinex/v3_04.py
1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 | |
Base Reader¶
Abstract base class for GNSS data readers.
Defines interface that all readers (RINEX v3, RINEX v2, SBF, future formats) must implement to ensure compatibility with downstream pipeline: - VOD calculation (canvod-vod) - Storage (canvod-store / MyIcechunkStore) - Grid operations (canvod-grids)
Contract constants (REQUIRED_DIMS, REQUIRED_COORDS, etc.) are the
single source of truth for the output Dataset structure. Use
:func:validate_dataset to check any Dataset against them.
DatasetStructureValidator
¶
Bases: BaseModel
Validates that an xarray.Dataset meets the GNSSDataReader contract.
Wraps a Dataset and checks it against the contract constants above. Use this in tests and reader implementations to catch structural errors early with clear messages.
Examples¶
validator = DatasetStructureValidator(dataset=ds) validator.validate_all() # raises ValueError on any violation validator.validate_dimensions() # check just one aspect
Source code in packages/canvod-readers/src/canvod/readers/base.py
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | |
validate_all(required_vars=None)
¶
Run all validations, collecting all errors.
Delegates to :func:validate_dataset so the logic lives in one place.
Source code in packages/canvod-readers/src/canvod/readers/base.py
154 155 156 157 158 159 | |
validate_dimensions()
¶
Check that required dimensions (epoch, sid) exist.
Source code in packages/canvod-readers/src/canvod/readers/base.py
161 162 163 164 165 | |
validate_coordinates()
¶
Check that required coordinates exist with correct dtypes.
Source code in packages/canvod-readers/src/canvod/readers/base.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | |
validate_data_variables(required_vars=None)
¶
Check that required data variables exist with correct dims.
Source code in packages/canvod-readers/src/canvod/readers/base.py
184 185 186 187 188 189 190 191 192 193 194 195 196 | |
validate_attributes()
¶
Check that required global attributes are present.
Source code in packages/canvod-readers/src/canvod/readers/base.py
198 199 200 201 202 | |
SignalID
¶
Bases: BaseModel
Validated signal identifier (SV + band + code).
sid = SignalID(sv="G01", band="L1", code="C") str(sid) 'G01|L1|C' sid.system 'G'
Source code in packages/canvod-readers/src/canvod/readers/base.py
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
system
property
¶
GNSS system letter (e.g. 'G' for GPS).
sid
property
¶
Full signal ID string ('SV|band|code').
from_string(sid_str)
classmethod
¶
Parse a signal ID string ('SV|band|code') into a SignalID.
Parameters¶
sid_str : str Signal ID in 'SV|band|code' format (e.g. 'G01|L1|C').
Returns¶
SignalID Validated signal identifier.
Raises¶
ValueError If the string does not have exactly three pipe-separated parts.
Source code in packages/canvod-readers/src/canvod/readers/base.py
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
GNSSDataReader
¶
Bases: BaseModel, ABC
Abstract base class for all GNSS data format readers.
All readers must:
1. Inherit from this class
2. Implement all abstract methods
3. Return xarray.Dataset that passes :func:validate_dataset
4. Provide file hash for deduplication
This ensures compatibility with: - canvod-vod: VOD calculation - canvod-store: MyIcechunkStore storage - canvod-grids: Grid projection operations
Subclasses may override model_config to set frozen, extra,
etc. The base class provides arbitrary_types_allowed=True which is
needed by readers that use pint.Quantity or similar third-party types.
Examples¶
class Rnxv3Obs(GNSSDataReader): ... def to_ds(self, **kwargs) -> xr.Dataset: ... # Implementation ... return dataset ... reader = Rnxv3Obs(fpath="station.24o") ds = reader.to_ds() validate_dataset(ds)
Source code in packages/canvod-readers/src/canvod/readers/base.py
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 | |
source_format
property
¶
Return the format identifier for this reader (e.g. "rinex3", "sbf").
file_hash
abstractmethod
property
¶
Return SHA256 hash of file for deduplication.
Used by MyIcechunkStore to avoid duplicate ingestion. Must be deterministic and reproducible.
Returns¶
str Short hash (16 chars) or full hash of file content
start_time
abstractmethod
property
¶
end_time
abstractmethod
property
¶
systems
abstractmethod
property
¶
Return list of GNSS systems in file.
Returns¶
list of str System identifiers: 'G', 'R', 'E', 'C', 'J', 'S', 'I'
num_epochs
property
¶
Return number of epochs in file.
Default implementation iterates epochs. Subclasses may override with a faster approach.
Returns¶
int Total number of observation epochs.
num_satellites
abstractmethod
property
¶
Return total number of unique satellites observed.
Returns¶
int Count of unique satellite vehicles across all systems.
to_ds(keep_data_vars=None, **kwargs)
abstractmethod
¶
Convert data to xarray.Dataset.
Must return Dataset with structure: - Dims: (epoch, sid) - Coords: epoch, sid, sv, system, band, code, freq_* - Data vars: At minimum SNR - Attrs: Must include "File Hash"
Parameters¶
keep_data_vars : list of str, optional Data variables to include. If None, includes all available. **kwargs Implementation-specific parameters
Returns¶
xr.Dataset
Dataset that passes :func:validate_dataset.
Source code in packages/canvod-readers/src/canvod/readers/base.py
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | |
iter_epochs()
abstractmethod
¶
Iterate over epochs in the file.
Yields¶
Epoch Parsed epoch with satellites and observations.
Source code in packages/canvod-readers/src/canvod/readers/base.py
378 379 380 381 382 383 384 385 386 | |
to_ds_and_auxiliary(keep_data_vars=None, **kwargs)
¶
Produce the obs dataset and any auxiliary datasets in a single call.
Default: calls to_ds(**kwargs) and returns an empty auxiliary dict.
Readers that produce metadata (e.g. SBF) override this to collect both
in a single file scan.
Returns¶
tuple[xr.Dataset, dict[str, xr.Dataset]]
(obs_ds, {"name": aux_ds, ...}). Auxiliary dict is empty for
readers with no extra data (RINEX v2/v3).
Source code in packages/canvod-readers/src/canvod/readers/base.py
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | |
__repr__()
¶
Return the string representation.
Source code in packages/canvod-readers/src/canvod/readers/base.py
487 488 489 | |
validate_dataset(ds, required_vars=None)
¶
Validate ds meets the GNSSDataReader output contract.
Collects all violations and raises a single ValueError listing
every problem, rather than stopping at the first failure.
Parameters¶
ds : xr.Dataset
Dataset to validate.
required_vars : list of str, optional
Data variables that must be present. Defaults to
:data:DEFAULT_REQUIRED_VARS (["SNR"]).
Raises¶
ValueError If any contract violation is found.
Source code in packages/canvod-readers/src/canvod/readers/base.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | |
Dataset Builder¶
Guided builder for constructing valid GNSSDataReader output Datasets.
Handles coordinate arrays, dtype enforcement, frequency resolution, and contract validation automatically.
Examples¶
builder = DatasetBuilder(reader) for epoch in reader.iter_epochs(): ... ei = builder.add_epoch(epoch.timestamp) ... for obs in epoch.observations: ... sig = builder.add_signal(sv="G01", band="L1", code="C") ... builder.set_value(ei, sig, "SNR", 42.0) ds = builder.build() # validated Dataset
DatasetBuilder
¶
Guided builder for constructing valid GNSSDataReader output Datasets.
Handles coordinate arrays, dtype enforcement, frequency resolution, and contract validation automatically.
Parameters¶
reader : GNSSDataReader
The reader instance (used for _build_attrs() and file hash).
aggregate_glonass_fdma : bool, optional
Whether to aggregate GLONASS FDMA channels (default True).
Examples¶
builder = DatasetBuilder(reader) for epoch in reader.iter_epochs(): ... ei = builder.add_epoch(epoch.timestamp) ... for obs in epoch.observations: ... sig = builder.add_signal(sv="G01", band="L1", code="C") ... builder.set_value(ei, sig, "SNR", 42.0) ds = builder.build() # validated Dataset
Source code in packages/canvod-readers/src/canvod/readers/builder.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
add_epoch(timestamp)
¶
Register an epoch timestamp. Returns epoch index.
Source code in packages/canvod-readers/src/canvod/readers/builder.py
86 87 88 89 | |
add_signal(sv, band, code)
¶
Register a signal (idempotent). Returns validated SignalID.
Source code in packages/canvod-readers/src/canvod/readers/builder.py
91 92 93 94 95 | |
set_value(epoch_idx, signal, var, value)
¶
Set a data value for a given epoch, signal, and variable.
Parameters¶
epoch_idx : int
Index returned by :meth:add_epoch.
signal : SignalID or str
Signal identifier (SignalID or 'SV|band|code' string).
var : str
Variable name (e.g. 'SNR', 'Pseudorange', 'Phase').
value : float
The observation value.
Source code in packages/canvod-readers/src/canvod/readers/builder.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | |
build(keep_data_vars=None, extra_attrs=None)
¶
Build, validate, and return the Dataset.
- Sorts signals alphabetically
- Resolves frequencies from band names via SignalIDMapper
- Constructs coordinate arrays with correct dtypes (float32 for freq)
- Attaches CF-compliant metadata from COORDS_METADATA
- Calls validate_dataset() before returning
Parameters¶
keep_data_vars : list of str, optional
If provided, only include these data variables. If None,
includes all variables that had values set.
extra_attrs : dict, optional
Additional global attributes to merge into the Dataset.
Returns¶
xr.Dataset
Validated Dataset with dimensions (epoch, sid).
Source code in packages/canvod-readers/src/canvod/readers/builder.py
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
GNSS Specifications¶
GNSS specifications and core characteristics.
This module contains fundamental GNSS definitions including: - Constants: Unit registry, physical constants, RINEX parameters - Exceptions: GNSS-specific error types - Metadata: CF-compliant metadata for coordinates and observables - Models: Pydantic validation models for RINEX data structures - Signals: Signal ID mapping and band properties - Utils: File hashing, version extraction, data type checks
These components are used across all GNSS reader implementations.
Directory Matching¶
Directory matching for RINEX data files.
Identifies and matches RINEX data directories across dates and receivers.
DataDirMatcher
¶
Match RINEX data directories for canopy and reference receivers.
Scans a root directory structure to find dates with RINEX files present in both canopy and reference receiver directories.
Parameters¶
root : Path Root directory containing receiver subdirectories reference_pattern : Path, optional Relative path pattern for reference receiver (default: "01_reference/01_GNSS/01_raw") canopy_pattern : Path, optional Relative path pattern for canopy receiver (default: "02_canopy/01_GNSS/01_raw")
Examples¶
from pathlib import Path matcher = DataDirMatcher( ... root=Path("/data/01_Rosalia"), ... reference_pattern=Path("01_reference/01_GNSS/01_raw"), ... canopy_pattern=Path("02_canopy/01_GNSS/01_raw") ... )
Iterate over matched directories¶
for matched_dirs in matcher: ... print(matched_dirs.yyyydoy) ... rinex_files = list(matched_dirs.canopy_data_dir.glob("*.25o")) ... print(f" Found {len(rinex_files)} RINEX files")
Get list of common dates¶
dates = matcher.get_common_dates() print(f"Found {len(dates)} dates with data")
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | |
__init__(root, reference_pattern=Path('01_reference/01_GNSS/01_raw'), canopy_pattern=Path('02_canopy/01_GNSS/01_raw'))
¶
Initialize matcher with directory structure.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | |
__iter__()
¶
Iterate over matched directory pairs with RINEX files.
Yields¶
MatchedDirs Matched directories for each date.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
get_common_dates()
¶
Get dates with RINEX files in both receivers.
Uses parallel processing to check directories efficiently.
Returns¶
list[str] Sorted list of date strings (YYDDD format, e.g., "25001") that have RINEX files in both canopy and reference directories.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | |
PairDataDirMatcher
¶
Match RINEX directories for receiver pairs across dates.
Supports multi-receiver configurations where multiple canopy/reference pairs may exist at the same site. Requires a configuration dict specifying receiver locations and analysis pairs.
Parameters¶
base_dir : Path
Root directory containing all receiver data
receivers : dict
Receiver configuration mapping receiver names to their directory paths.
The directory value is the full relative path from base_dir to the
raw RINEX data directory (before the {YYDOY} date folders).
Example: {"canopy_01": {"directory": "02_canopy_01/01_GNSS/01_raw"},
"reference_01": {"directory": "01_reference_01/01_GNSS/01_raw"}}
analysis_pairs : dict
Analysis pair configuration specifying which receivers to match
Example: {"pair_01": {"canopy_receiver": "canopy_01",
"reference_receiver": "reference_01"}}
Examples¶
receivers = { ... "canopy_01": {"directory": "02_canopy/01_GNSS/01_raw"}, ... "reference_01": {"directory": "01_reference/01_GNSS/01_raw"} ... } pairs = { ... "main_pair": { ... "canopy_receiver": "canopy_01", ... "reference_receiver": "reference_01" ... } ... }
matcher = PairDataDirMatcher( ... base_dir=Path("/data/01_Rosalia"), ... receivers=receivers, ... analysis_pairs=pairs ... )
for matched in matcher: ... print(f"{matched.yyyydoy}: {matched.pair_name}") ... print(f" Canopy: {matched.canopy_data_dir}") ... print(f" Reference: {matched.reference_data_dir}")
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | |
__init__(base_dir, receivers, analysis_pairs)
¶
Initialize pair matcher with receiver configuration.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | |
__iter__()
¶
Iterate over all date/pair combinations with available data.
Yields¶
PairMatchedDirs Matched directories for a receiver pair on a specific date.
Source code in packages/canvod-readers/src/canvod/readers/matching/dir_matcher.py
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 | |
MatchedDirs
dataclass
¶
Matched directory paths for canopy and reference receivers.
Immutable container representing a pair of directories containing RINEX data for the same date.
Parameters¶
canopy_data_dir : Path Path to canopy receiver RINEX directory. reference_data_dir : Path Path to reference (open-sky) receiver RINEX directory. yyyydoy : YYYYDOY Date object for this matched pair.
Examples¶
from pathlib import Path from canvod.utils.tools import YYYYDOY
md = MatchedDirs( ... canopy_data_dir=Path("/data/02_canopy/25001"), ... reference_data_dir=Path("/data/01_reference/25001"), ... yyyydoy=YYYYDOY.from_str("2025001") ... ) md.yyyydoy.to_str() '2025001'
Source code in packages/canvod-readers/src/canvod/readers/matching/models.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 | |
PairMatchedDirs
dataclass
¶
Matched directories for a receiver pair on a specific date.
Supports multi-receiver configurations where multiple canopy/reference pairs may exist at the same site.
Parameters¶
yyyydoy : YYYYDOY Date for this matched pair. pair_name : str Identifier for this receiver pair (e.g., "pair_01"). canopy_receiver : str Name of canopy receiver (e.g., "canopy_01"). reference_receiver : str Name of reference receiver (e.g., "reference_01"). canopy_data_dir : Path Path to canopy receiver RINEX directory. reference_data_dir : Path Path to reference receiver RINEX directory.
Examples¶
pmd = PairMatchedDirs( ... yyyydoy=YYYYDOY.from_str("2025001"), ... pair_name="pair_01", ... canopy_receiver="canopy_01", ... reference_receiver="reference_01", ... canopy_data_dir=Path("/data/canopy_01/25001"), ... reference_data_dir=Path("/data/reference_01/25001") ... ) pmd.pair_name 'pair_01'
Source code in packages/canvod-readers/src/canvod/readers/matching/models.py
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | |