gnsstk_timeconvert.py

Go to the documentation of this file.

#!/usr/bin/env python
"""
==============================================================================
 
  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
 
  The GNSSTk is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 3.0 of the License, or
  any later version.
 
  The GNSSTk is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with GNSSTk; if not, write to the Free Software Foundation,
  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 
  This software was developed by Applied Research Laboratories at the
  University of Texas at Austin.
  Copyright 2004-2022, The Board of Regents of The University of Texas System
 
==============================================================================
 
==============================================================================
 
  This software was developed by Applied Research Laboratories at the
  University of Texas at Austin, under contract to an agency or agencies
  within the U.S. Department of Defense. The U.S. Government retains all
  rights to use, duplicate, distribute, disclose, or release this software.
 
  Pursuant to DoD Directive 523024
 
  DISTRIBUTION STATEMENT A: This software has been approved for public
                            release, distribution is unlimited.
 
==============================================================================
"""
 
import argparse
import gnsstk
import sys
 
# default args to argv are left in so the script can be run without starting
# a new python process. This is very useful for testing!
def main(args=sys.argv[1:]):
    program_description = ('Converts from a given input time specification to '
                           'other time formats. Include the quotation marks. '
                           'All year values are four digit years. '
                           'Example: $ python gnsstk_timeconvert.py -f "158 200" ')
    parser = argparse.ArgumentParser(description=program_description)
 
    group = parser.add_mutually_exclusive_group()
    group.add_argument('-A', '--ansi', help='\"ANSI-Second\"')
    group.add_argument('-c', '--civil',
                       help='\"Month(numeric) DayOfMonth Year Hour:Minute:Second\"')
    group.add_argument('-R', '--rinex',
                       help='\"Year(2-digit) Month(numeric) DayOfMonth Hour Minute Second\"')
    group.add_argument('-o', '--ews', help='\"GPSEpoch 10bitGPSweek SecondOfWeek\"')
    group.add_argument('-f', '--ws', help='\"FullGPSWeek SecondOfWeek\"')
    group.add_argument('-w', '--wz', help='\"FullGPSWeek Zcount\"')
    group.add_argument(      '--z29', help='\"29bitZcount\"')
    group.add_argument('-Z', '--z32', help='\"32bitZcount\"')
    group.add_argument('-j', '--julian', help='\"JulianDate\"')
    group.add_argument('-m', '--mjd', help='\"ModifiedJulianDate\"')
    group.add_argument('-u', '--unixtime', help='\"UnixSeconds UnixMicroseconds\"')
    group.add_argument('-y', '--doy', help='\"Year DayOfYear SecondsOfDay\"')
 
    parser.add_argument('-F', '--output_format', help='Time format to use on output')
 
    parser.add_argument('-a', '--add_offset', type=int, nargs='+',
                        help='add NUM seconds to specified time')
    parser.add_argument('-s', '--sub_offset', type=int, nargs='+',
                        help='subtract NUM seconds to specified time')
    args = parser.parse_args(args)
 
    # these format keys must match the long arg names
    formats = {
        'ansi'     : '%K',
        'civil'    : '%m %d %Y %H:%M:%f',
        'rinex'    : '%y %m %d %H %M %S',
        'ews'      : '%E %G %g',
        'ws'       : '%F %g',
        'wz'       : '%F %Z',
        'z29'      : '%E %c',
        'z32'      : '%C',
        'julian'   : '%J',
        'mjd'      : '%Q',
        'unixtime' : '%U',
        'doy'      : '%Y %j %s'
    }
 
    time_found = False
    for key in formats:
        input_time = getattr(args, key)  # args.ansi, args.civil, etc.
        if input_time is not None:
            try:
                ct = gnsstk.scanTime(input_time, formats[key])
                time_found = True
            except gnsstk.InvalidRequest:
                raise gnsstk.InvalidRequest('Input could not be parsed.'
                     '\nCheck the formatting and ensure that the input is both valid and in quotes.'
                     '\nAlso check if the time is too early/late for these formats.')
 
 
    if not time_found:
        ct = gnsstk.SystemTime().toCommonTime()
 
    ct.setTimeSystem(gnsstk.TimeSystem('GPS'))
 
    if args.add_offset is not None:
        for t in args.add_offset:
            ct.addSeconds(float(t))
    if args.sub_offset is not None:
        for t in args.sub_offset:
            ct.addSeconds(-float(t))
 
    if args.output_format is not None:
        print gnsstk.printTime(ct, args.output_format)
    else:
        def left_align(str):
            spacing = ' ' * 8
            return spacing + str.ljust(31)
 
        print ''  # newline
 
        print left_align('Month/Day/Year H:M:S'),
        print gnsstk.CivilTime(ct)
 
        print left_align('Modified Julian Date'),
        print gnsstk.MJD(ct)
 
        print left_align('GPSweek DayOfWeek SecOfWeek'),
        print gnsstk.GPSWeekSecond(ct).printf('%G %w % 13.6g')
 
        print left_align('FullGPSweek Zcount'),
        print gnsstk.GPSWeekZcount(ct).printf('%F % 6z')
 
        print left_align('Year DayOfYear SecondOfDay'),
        print gnsstk.YDSTime(ct).printf('%Y %03j % 12.6s')
 
        print left_align('Unix: Second Microsecond'),
        print gnsstk.UnixTime(ct).printf('%U % 6u')
 
        print left_align('Zcount: 29-bit (32-bit)'),
        print gnsstk.GPSWeekZcount(ct).printf('%c (%C)')
 
        print ''  # newline
 
 
if __name__ == '__main__':
    main()