ATKoverlay

This tool allows for the various Overlays tools to be utilised from the command line. The first argument sets the job to perform on the overlay definition list. See tutorials for examples.

Usage 1

ATKoverlay open [-h]

Calls openOverlays(), opening the overlay definition list in the default text editor.

Optional Arguments:

-h, --help Show help message and exit

Usage 2

ATKoverlay add [-h] <survey> --ra RA_NAME --dec DEC_NAME --id ID_NAME [--mags MAG_NAMES [MAG_NAMES ...]]

Calls addOverlay(), adding an overlay definition for a given catalogue alias.

Positional Arguments:

alias                            Overlay catalogue lias

Arguments:

--ra RA_NAME                      Name of right ascension column in Vizier
--dec DEC_NAME                    Name of declination column in Vizier
--id ID_NAME                      Name of ID column in Vizier

Optional Arguments:

-h, --help                        Show help message and exit
--mags MAG_NAMES [MAG_NAMES ...]  Names of magnitude columns in Vizier. If provided,
                                  a 'scaled_detection' overlay defintion is generated.
                                  Otherwise, a 'detection' overlay is generated.

Usage 3

ATKoverlay del [-h] {scaled_detection,detection} <alias>

Calls delOverlay(), deleting an overlay definition for catalogue alias <survey>.

Positional Arguments:

{scaled_detection,detection}  Kind of overlay definition to delete
<alias>                       Overlay alias

Optional Arguments:

-h, --help                    Show help message and exit

Usage 4

ATKoverlay reset [-h]

Calls resetOverlays(), resetting the overlay definition list to its default state.

Optional Arguments:

-h, --help  Show help message and exit