gFind APIΒΆ

gFind.check_args(args, iam='gfind', allow_no_coords=False)
Checks validity of command line arguments and, in some cases,
modifies them a little bit.
Parameters:
  • args (argparse.ArgumentParser Namespace) – The command-line arguments.
  • iam (str) – The name of the method being called.
  • allow_no_coords (bool) – If True, do not require coordinates to be provided.
Returns:

argparse.ArgumentParser Namespace – The updated command-line arguments.
gFind.gfind(band='both', detsize=1.1, exponly=False, gaper=False, maxgap=1500.0, minexp=1.0, quiet=False, retries=100, skypos=None, trange=None, verbose=0, skyrange=None)
Primary program in the module. Prints time ranges to the screen and
returns the total exposure time as a float.
Parameters:
  • band (str) – The band being used, either ‘BOTH’, ‘FUV’, or ‘NUV’.
  • detsize (float) – Effective diameter, in degrees, of the field-of-view.
  • exponly (bool) – If True, only report the exposure times.
  • gaper (bool) – Return time ranges in a format that can be copy-pasted as a valid gAperture call.
  • maxgap (float) – Maximum gap size, in seconds, for data to be considered contiguous.
  • minexp (float) – Minimum gap size, in seconds, for data to be considered contiguous.
  • quiet (bool) – If True, don’t print anything to STDOUT. Overrides verbose.
  • retries (int) – Number of query retries to attempt before giving up.
  • skypos (list) – The right ascension and declination, in degrees.
  • trange (list) – Minimum and maximum time range to make a light curve, in GALEX time.
  • verbose (int) – Verbosity level, a value of 0 is minimum verbosity.
  • skyrange (list) – RA and Dec extents, in degrees, defining the lengths of sides of a box on the sky that circumscribes the region of interest.
Returns:

dict – The available data for the requested band(s).
gFind.setup_parser(iam='gfind', parser=None)

If a parser object is not provided, make one here.

Parameters:
  • iam (str) – The name of the method being called.
  • parser (argparse.ArgumentParser Namespace) – The command-line arguments.
Returns:

argparse.ArgumentParser Namespace – The command-line arguments.