Skip to content

Commit 480fc25

Browse files
committed
Update NMEA docstrings
1 parent 073c1e2 commit 480fc25

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

gnss_lib_py/parsers/nmea.py

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,20 @@ def __init__(self, input_path, msg_types=None,
4242
`True` if the checksum at the end of the NMEA sentence should
4343
be ignored. `False` if the checksum should be checked and lines
4444
with incorrect checksums will be ignored.
45-
raw_coord : bool
45+
keep_raw : bool
4646
Flag for whether coordinates should be processed into commonly
47-
used latitude and longitude formats. If 'True', returned
48-
`NavData` has the same coordinates as the input NMEA file,
49-
including the cardinal directions.
50-
If `False`, the coordinates are processed into the decimal
51-
format between -180° and 180° for longitude and between
52-
-90° and 90° for latitude.
47+
used latitude and longitude formats.
48+
The default value is 'False', in which case the coordinates
49+
are processed into the decimal format between -180° and
50+
180° for longitude and between -90° and 90°
51+
for latitude.
52+
If 'True', returned `NavData` has the same coordinates as
53+
the input NMEA file, including the cardinal directions.
54+
include_ecef : bool
55+
Flag for whether the returned `NavData` should include the
56+
ECEF coordinates equivalent to the recorded LLH coordinates.
57+
If 'True', the returned `NavData` instance has `x_rx_m`,
58+
`y_rx_m` and `z_rx_m` rows.
5359
5460
References
5561
----------

0 commit comments

Comments
 (0)