gAperture API¶
-
gAperture.
check_annulus
(args) Checks and formats the annulus values.
Parameters: args (argparse.ArgumentParser Namespace) – The command-line arguments. Returns: argparse.ArgumentParser Namespace – The updated command-line arguments.
-
gAperture.
check_args
(args, iam='gaperture') - 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.
Returns: argparse.ArgumentParser Namespace – The updated command-line arguments.
-
gAperture.
check_radius
(args) Checks the radius value.
Parameters: args (argparse.ArgumentParser Namespace) – The command-line arguments. Returns: argparse.ArgumentParser Namespace – The updated command-line arguments.
-
gAperture.
gaperture
(band, skypos, radius, csvfile=None, annulus=None, coadd=False, stepsz=False, verbose=0, overwrite=False, trange=None, tranges=None, minexp=1.0, maxgap=1500.0, iocode='w', detsize=1.1, minimal_output=False, photoncsvfile=None) - Creates a light curve and returns the data in a python dict() and as
- a CSV file, if outfile is specified. Can be called from the interpreter.
Parameters: - band (str) – The band being used, either ‘FUV’ or ‘NUV’.
- skypos (list) – The right ascension and declination, in degrees.
- radius (float) – The radius of the photometric aperture, in degrees.
- csvfile (str) – Name of the photon event CSV file to use for lightcurve.
- annulus (list) – Radii of the inner and outer of an annulus, in degrees, within which to measure the background.
- coadd (bool) – Set to True if calculating a total flux instead of flux from each time bin.
- stepsz (float) – The size of the time bins to use, in seconds.
- verbose (int) – Verbosity level, a value of 0 is minimum verbosity.
- overwrite (bool) – If True, overwite an existing output file.
- trange (list) – Minimum and maximum time range to make a light curve, in GALEX time seconds.
- tranges (list) – Set of time ranges to query within, in GALEX time seconds.
- minexp (float) – Minimum gap size, in seconds, for data to be considered contiguous.
- maxgap (float) – Maximum gap size, in seconds, for data to be considered contiguous.
- iocode (str) – The code to use when writing the output file.
- detsize (float) – Effective diameter, in degrees, of the field-of-view.
- minimal_output (bool) – If True, produce an output file with a minimum number of columns.
- photoncsvfile (str) – Name of the photon event CSV file to use for photons.
Returns: dict – The light curve, including input parameters.
-
gAperture.
reconstruct_command
(args) Rebuild the equivalent command line for this call to gAperture.
Parameters: args (argparse.ArgumentParser Namespace) – The command-line arguments. Returns: str – The equivalent command-line for this call to gAperture.
-
gAperture.
setup_file
(args) - If requested, create a header for the CSV that includes the column
- names and a reconstruction of the command line call.
Parameters: args (argparse.ArgumentParser Namespace) – The command-line arguments. Returns: argparse.ArgumentParser Namespace – The updated command-line arguments.
-
gAperture.
setup_parser
(iam='gaperture') Defines command line arguments.
Parameters: iam (str) – The name of the method being called. Returns: argparse.ArgumentParser Namespace – The command-line arguments.
-
gAperture.
stamp
(args) Creates a jpeg preview image stamp of the targeted region.
Parameters: args (argparse.ArgumentParser Namespace) – The command-line arguments.