Command-line Interface¶

cross-bones¶

Looking at per-beam shifts

usage: cross_bones [-h] [-o OUTPUT_PREFIX] [--passes PASSES] [--all-plots]
                   [--report-statistics-throughout]
                   [--coord_keys COORD_KEYS COORD_KEYS]
                   [--flux_keys FLUX_KEYS FLUX_KEYS] [--rms_key RMS_KEY]
                   [--snr_min SNR_MIN] [--iso_min ISO_MIN]
                   [--force_idx FORCE_IDX]
                   paths [paths ...]

Positional Arguments¶

paths: The beam wise catalogues to examine

Named Arguments¶

-o, --output-prefix

The prefix to base outputs onto

--passes

Number of passes over the data should the iterative method attempt

Default: 1

--all-plots

If provided all plots will be produced. Otherwise a minimumal set will be

Default: False

--report-statistics-throughout

Collect and report statistics each iteration

Default: False

--coord_keys

Column names/keys in tables for (ra, dec). [Default (‘ra’, ‘dec’)]

Default: ['ra', 'dec']

--flux_keys

Column names/keys in tables for integrated and peak flux density. [Default (‘int_flux’, ‘peak_flux’)]

Default: ['int_flux', 'peak_flux']

--rms_key

Local rms column name/key in tables. Default ‘local_rms’

Default: 'local_rms'

--snr_min

Minimum SNR of sources. Default 10

Default: 10.0

--iso_min

Minimum separation between close neighbours in arcsec. Default 36

Default: 36.0

--force_idx

Force a specific beam as reference. If None, beam with the most matches is chosen. Default None

unWISE¶

Looking at per-beam shifts

usage: unwise_cross_bones [-h] [-s SBID] [-f FIELD_NAME]
                          [--beam-table BEAM_TABLE]
                          [--unwise-table-location UNWISE_TABLE_LOCATION]
                          [--report-statistics] [-o OUTPUT_PREFIX]
                          [--coord-keys COORD_KEYS COORD_KEYS]
                          [--flux-keys FLUX_KEYS FLUX_KEYS]
                          [--rms-key RMS_KEY] [--snr-min SNR_MIN]
                          [--iso-min ISO_MIN] [--sources-min SOURCES_MIN]
                          [--plot_all_windows]
                          [--window_max_iterations WINDOW_MAX_ITERATIONS]
                          [--window_increment WINDOW_INCREMENT]
                          [--window_width WINDOW_WIDTH]
                          [--window_delta WINDOW_DELTA]
                          paths [paths ...]

Positional Arguments¶

paths: The beam wise catalogues to examine

Named Arguments¶

-s, --sbid

ASKAP SBID, if none provided it will be guessed from the filenames.

-f, --field-name

ASKAP field name, if none provided it will assumed a RACS observation and guessed from the filename.

--beam-table

Table of beam positions for a given ASKAP footprint. Default ‘closepack36_beams.fits

Default: 'closepack36_beams.fits'

--unwise-table-location

Directory of the unWISE tables. Default ‘./’

Default: .

--report-statistics

Report statistics of offsets with respect to neighbouring catalogues.

Default: False

-o, --output-prefix

The prefix to base outputs onto

--coord-keys

Column names/keys in tables for (ra, dec). [Default (‘ra’, ‘dec’)]

Default: ['ra', 'dec']

--flux-keys

Column names/keys in tables for integrated and peak flux density. [Default (‘int_flux’, ‘peak_flux’)]

Default: ['int_flux', 'peak_flux']

--rms-key

Local rms column name/key in tables. Default ‘local_rms’

Default: 'local_rms'

--snr-min

Minimum SNR of sources. Default 5

Default: 5.0

--iso-min

Minimum separation between close neighbours in arcsec. Default 36

Default: 36.0

--sources-min

Minimum number of sources (after filtering) per catalogue. Default 1

Default: 1

--plot_all_windows

Switch to enable plotting offsets for all windows. Default is to only plot final window.

Default: False

--window_max_iterations

Maximum number of window reduction iterations. Default 7

Default: 7

--window_increment

Value to de-increment the window by for each iteration (as 1/increment). Default 4

Default: 4.0

--window_width

Initial window width in arcsec. Reduces with window_increment for each iteration. Default 25

Default: 25.0

--window_delta

Initial window bin size in arcsec. Reduces with window_increment for each iteration. Default 5.

Default: 5.0

Statistics¶

usage: shift_stats [-h] [-r MAX_SEP_FROM_BEAM] [-o OUTPUT_PREFIX]
                   [--dra_key DRA_KEY] [--ddec_key DDEC_KEY]
                   [--coord-keys COORD_KEYS COORD_KEYS]
                   [--flux-keys FLUX_KEYS FLUX_KEYS] [--rms-key RMS_KEY]
                   [--snr-min SNR_MIN]
                   offset_file [catalogues ...]

Positional Arguments¶

offset_file: Output CSV file from cross_bones with per-catalogue offsets.
catalogues: List of catalogues to inspect.

Named Arguments¶

-r, --max_sep_from_beam

Maximum distance from an image centre to consider sources. Default None

-o, --output-prefix

The prefix to base outputs onto

--dra_key

Column name in offset file for RA offsets. Default ‘d_ra’.

Default: 'd_ra'

--ddec_key

Column name in offset file for RA offsets. Default ‘d_dec’.

Default: 'd_dec'

--coord-keys

Column names/keys in tables for (ra, dec). [Default (‘ra’, ‘dec’)]

Default: ['ra', 'dec']

--flux-keys

Column names/keys in tables for integrated and peak flux density. [Default (‘int_flux’, ‘peak_flux’)]

Default: ['int_flux', 'peak_flux']

--rms-key

Local rms column name/key in tables. Default ‘local_rms’

Default: 'local_rms'

--snr-min

Minimum SNR of sources. Default 5

Default: 5.0

Apply¶

usage: apply_cross_bones [-h] [--dra_key DRA_KEY] [--ddec_key DDEC_KEY]
                         [--suffix SUFFIX]
                         offset_file [images ...]

Positional Arguments¶

offset_file: File of offsets - must be in the same order as images.
images: List of images to shift. Must match order of offsets in offset_file.

Named Arguments¶

--dra_key

Column name in offset file for RA offsets. Default ‘d_ra’.

Default: 'd_ra'

--ddec_key

Column name in offset file for RA offsets. Default ‘d_dec’.

Default: 'd_dec'

--suffix

Suffix to append to output shifted image name. Default ‘.shift’.

Default: '.shift'